Changeset 3050050

Timestamp:

03/12/2024 08:41:43 PM (21 months ago)

Author:

webdevstudios

Message:

release version 0.3.0

Location:

hash-link-scroll-offset

Files:

• tags/0.3.0 (added)
• tags/0.3.0/assets (added)
• tags/0.3.0/assets/js (added)
• tags/0.3.0/assets/js/hash-link-scroll-offset.js (added)
• tags/0.3.0/assets/js/hash-link-scroll-offset.min.asset.php (added)
• tags/0.3.0/assets/js/hash-link-scroll-offset.min.js (added)
• tags/0.3.0/assets/js/src (added)
• tags/0.3.0/assets/js/src/hash-link-scroll-offset.js (added)
• tags/0.3.0/hash-link-scroll-offset.php (added)
• tags/0.3.0/languages (added)
• tags/0.3.0/languages/hash_link_scroll_offset.pot (added)
• tags/0.3.0/readme.txt (added)
• tags/0.3.0/src (added)
• tags/0.3.0/src/hash-link-scroll-offset.js (added)
• trunk/assets/js/hash-link-scroll-offset.js (modified) (5 diffs)
• trunk/assets/js/hash-link-scroll-offset.min.asset.php (added)
• trunk/assets/js/hash-link-scroll-offset.min.js (modified) (1 diff)
• trunk/hash-link-scroll-offset.php (modified) (9 diffs)
• trunk/readme.txt (modified) (2 diffs)
• trunk/src (added)
• trunk/src/hash-link-scroll-offset.js (added)

hash-link-scroll-offset/trunk/assets/js/hash-link-scroll-offset.js

@@ -1 @@
-/*! Hash Link Scroll Offset - v0.1.8 - 2022-01-28
+/**
+ * Hash Link Scroll Offset
  * http://webdevstudios.com
- * Copyright (c) 2022; * Licensed GPLv2+ */
+ *
+ * Copyright (c) 2014 WebDevStudios
+ * Licensed under the GPLv2+ license.
+ */
+
 /*jslint browser: true */
-/*global jQuery:false */
 
 window.Hash_Link_Scroll_Offset = window.Hash_Link_Scroll_Offset || {};
 
-( function( window, document, $, app ){
+( function ( window, document, app ) {
     'use strict';
 
@@ -20 +24 @@
     }
 
-    app.init = function() {
-
+    app.init = function () {
         app.offset = app.getOffset();
 
         // cache jQuery selector results
-        app.$html_and_body = $('html, body');
+        app.htmlAndBody = document.querySelectorAll( 'html, body' );
 
-        $( 'a[href*="#"]:not(.no-scroll)' ).on( 'click', function( evt ) {
-            app.hash = this.hash;
+        const checkScroll = document.querySelectorAll( 'a:not(.no-scroll)' );
+        checkScroll.forEach( function ( a ) {
+            a.addEventListener( 'click', function ( evt ) {
+                app.hash = this.hash;
+                if ( ! app.hash ) {
+                    return;
+                }
+                app.scrollToHash( app.hash, evt );
+            } );
+        } );
 
-            if ( ! $( app.hash ) ) {
+        if ( app.initialScroll ) {
+            app.hash = window.location.hash;
+            const elementToScrollTo = app.getHashElement( app.hash );
+
+            if ( ! elementToScrollTo ) {
                 return;
             }
 
-            app.scrollToHash( app.hash, evt );
-        });
-
-        if ( app.initialScroll ) {
-            app.hash = window.location.hash;
-            var $element_to_scroll_to = app.getHashElement( app.hash );
-
-            if ( ! $element_to_scroll_to ) {
-                return;
-            }
-
-            setTimeout( function() {
+            setTimeout( function () {
                 app.isScrolling = true;
                 window.scrollTo( 0, 0 );
-                app.scrollToHash( $element_to_scroll_to );
+                app.scrollToHash( elementToScrollTo );
             }, 10 );
         }
-
     };
 
-    app.getOffset = function() {
-        var offset = window.hlso_offset ? window.hlso_offset.offset : 0;
+    app.getOffset = function () {
+        let offset = typeof hlsOffset !== 'undefined' ? hlsOffset.offset : 0; // eslint-disable-line no-undef
 
-        if ( $( '#wpadminbar' ).length ) {
+        if ( document.getElementById( 'wpadminbar' ) ) {
             offset = ( parseInt( offset, 10 ) + 32 ).toString();
         }
@@ -64 +67 @@
     };
 
-    app.getHashElement = function( hash ) {
-        var isEl = ( hash instanceof jQuery );
+    app.getHashElement = function ( hash ) {
+        const isEl = typeof hash === 'object';
 
         // Check if linking to ID
-        var $element_to_scroll_to = isEl ? hash : $( hash );
+        let elementToScrollTo = isEl
+            ? hash
+            : document.getElementById( hash.substr( 1 ) );
 
         // If not..
-        if ( ! $element_to_scroll_to.length && ! isEl ) {
+        if ( ! elementToScrollTo && ! isEl ) {
             // Check if linking to a named anchor
-            $element_to_scroll_to = $( '[name="' + hash.substr(1) + '"]' );
+            elementToScrollTo = document.querySelector(
+                '[name="' + hash.substr( 1 ) + '"]'
+            );
         }
 
-        if ( ! $element_to_scroll_to.length ) {
+        if ( ! elementToScrollTo ) {
             return false;
         }
 
-        if ( $element_to_scroll_to.hasClass( '.no-scroll' ) || $element_to_scroll_to.parents( '.no-scroll-wrap' ).length ) {
+        if (
+            elementToScrollTo.classList.contains( 'no-scroll' ) ||
+            elementToScrollTo.closest( '.no-scroll-wrap' )
+        ) {
             return false;
         }
 
-        return $element_to_scroll_to;
+        return elementToScrollTo;
     };
 
-    app.scrollToHash = function( hash, evt ) {
-        var $element_to_scroll_to = hash instanceof jQuery ? hash : app.getHashElement( hash );
+    app.scrollToHash = function ( hash, evt ) {
+        const elementToScrollTo =
+            typeof hash === 'object' ? hash : app.getHashElement( hash );
 
-        if ( ! $element_to_scroll_to || ! $element_to_scroll_to.length ) {
+        if ( ! elementToScrollTo ) {
             return;
         }
@@ -96 +107 @@
         app.isScrolling = true;
 
-        app.scrollTo = $element_to_scroll_to.offset().top - app.offset;
+        app.scrollTo =
+            elementToScrollTo.getBoundingClientRect().top - app.offset;
 
-        app.$html_and_body.trigger( 'hash_link_scroll_offset.scroll_to', app.scrollTo );
+        const event = new Event( 'hash_link_scroll_offset.scroll_to' );
+        app.htmlAndBody.forEach( function ( el ) {
+            el.dispatchEvent( event );
+        } );
 
         app.scroll( app.scrollTo );
@@ -106 +121 @@
             window.location.hash = app.hash;
         }
-
     };
 
-    app.scroll = function( scrollTo ) {
-        app.$html_and_body.stop().animate({
-            'scrollTop': scrollTo
-        }, 900, 'swing', function( evt ) {
-            app.initialScroll = app.isScrolling = false;
-            app.$html_and_body.trigger( 'hash_link_scroll_offset.complete', evt );
+    app.scroll = function ( scrollTo ) {
+        window.scrollTo( {
+            top: scrollTo,
+            behavior: 'smooth',
+        } );
+        app.initialScroll = app.isScrolling = false;
+        const event = new Event( 'hash_link_scroll_offset.complete' );
+
+        app.htmlAndBody.forEach( function ( el ) {
+            el.dispatchEvent( event );
         } );
     };
 
-    $( app.init );
+    app.init();
 
     return app;
-
-} )( window, document, jQuery, window.Hash_Link_Scroll_Offset );
+} )( window, document, window.Hash_Link_Scroll_Offset );

hash-link-scroll-offset/trunk/assets/js/hash-link-scroll-offset.min.js

@@ -1 @@
-/*! Hash Link Scroll Offset - v0.1.8 - 2022-01-28
- * http://webdevstudios.com
- * Copyright (c) 2022; * Licensed GPLv2+ */
-window.Hash_Link_Scroll_Offset=window.Hash_Link_Scroll_Offset||{},function(a,b,c,d){"use strict";d.scrollTo=0,d.initialScroll=!1,d.isScrolling=!1,d.hash=null,a.location.hash&&(d.initialScroll=!0),d.init=function(){if(d.offset=d.getOffset(),d.$html_and_body=c("html, body"),c('a[href*="#"]:not(.no-scroll)').on("click",function(a){d.hash=this.hash,c(d.hash)&&d.scrollToHash(d.hash,a)}),d.initialScroll){d.hash=a.location.hash;var b=d.getHashElement(d.hash);if(!b)return;setTimeout(function(){d.isScrolling=!0,a.scrollTo(0,0),d.scrollToHash(b)},10)}},d.getOffset=function(){var b=a.hlso_offset?a.hlso_offset.offset:0;return c("#wpadminbar").length&&(b=(parseInt(b,10)+32).toString()),b},d.getHashElement=function(a){var b=a instanceof jQuery,d=b?a:c(a);return d.length||b||(d=c('[name="'+a.substr(1)+'"]')),!!d.length&&(!d.hasClass(".no-scroll")&&!d.parents(".no-scroll-wrap").length&&d)},d.scrollToHash=function(b,c){var e=b instanceof jQuery?b:d.getHashElement(b);e&&e.length&&(d.isScrolling=!0,d.scrollTo=e.offset().top-d.offset,d.$html_and_body.trigger("hash_link_scroll_offset.scroll_to",d.scrollTo),d.scroll(d.scrollTo),c&&c.preventDefault&&(c.preventDefault(),a.location.hash=d.hash))},d.scroll=function(a){d.$html_and_body.stop().animate({scrollTop:a},900,"swing",function(a){d.initialScroll=d.isScrolling=!1,d.$html_and_body.trigger("hash_link_scroll_offset.complete",a)})},c(d.init)}(window,document,jQuery,window.Hash_Link_Scroll_Offset);
+window.Hash_Link_Scroll_Offset=window.Hash_Link_Scroll_Offset||{},function(t,o,l){"use strict";l.scrollTo=0,l.initialScroll=!1,l.isScrolling=!1,l.hash=null,t.location.hash&&(l.initialScroll=!0),l.init=function(){if(l.offset=l.getOffset(),l.htmlAndBody=o.querySelectorAll("html, body"),o.querySelectorAll("a:not(.no-scroll)").forEach((function(t){t.addEventListener("click",(function(t){l.hash=this.hash,l.hash&&l.scrollToHash(l.hash,t)}))})),l.initialScroll){l.hash=t.location.hash;const o=l.getHashElement(l.hash);if(!o)return;setTimeout((function(){l.isScrolling=!0,t.scrollTo(0,0),l.scrollToHash(o)}),10)}},l.getOffset=function(){let t="undefined"!=typeof hlsOffset?hlsOffset.offset:0;return o.getElementById("wpadminbar")&&(t=(parseInt(t,10)+32).toString()),t},l.getHashElement=function(t){const l="object"==typeof t;let n=l?t:o.getElementById(t.substr(1));return n||l||(n=o.querySelector('[name="'+t.substr(1)+'"]')),!!n&&!n.classList.contains("no-scroll")&&!n.closest(".no-scroll-wrap")&&n},l.scrollToHash=function(o,n){const s="object"==typeof o?o:l.getHashElement(o);if(!s)return;l.isScrolling=!0,l.scrollTo=s.getBoundingClientRect().top-l.offset;const e=new Event("hash_link_scroll_offset.scroll_to");l.htmlAndBody.forEach((function(t){t.dispatchEvent(e)})),l.scroll(l.scrollTo),n&&n.preventDefault&&(n.preventDefault(),t.location.hash=l.hash)},l.scroll=function(o){t.scrollTo({top:o,behavior:"smooth"}),l.initialScroll=l.isScrolling=!1;const n=new Event("hash_link_scroll_offset.complete");l.htmlAndBody.forEach((function(t){t.dispatchEvent(n)}))},l.init()}(window,document,window.Hash_Link_Scroll_Offset);

hash-link-scroll-offset/trunk/hash-link-scroll-offset.php

@@ -1 @@
-<?php
+<?php // phpcs:ignore WordPress.Files.FileName.InvalidClassFileName
 /**
  * Plugin Name: Hash Link Scroll Offset
  * Plugin URI:  http://webdevstudios.com
  * Description: Offset the scroll position of anchored links. Handy if you have a sticky header that covers linked material.
- * Version:     0.2.2
+ * Version:     0.3.0
  * Author:      WebDevStudios
  * Author URI:  http://webdevstudios.com
@@ -38 +38 @@
 class Hash_Link_Scroll_Offset {
 
-    const VERSION = '0.2.1';
+    const VERSION = '0.3.0';
 
     /**
@@ -46 +46 @@
      * @var string
      */
-    public static $url  = '';
+    public static $url = '';
 
     /**
@@ -72 +72 @@
         // Useful variables.
         self::$url  = trailingslashit( plugin_dir_url( __FILE__ ) );
-        self::$path = trailingslashit( dirname( __FILE__ ) );
+        self::$path = trailingslashit( __DIR__ );
         self::$name = __( 'Hash Link Scroll Offset', 'hash_link_scroll_offset' );
     }
@@ -109 +109 @@
             update_option( 'hash_link_scroll_offset', 0 );
         }
-        add_option( 'hash_link_scroll_offset_msg', 1, null, 'no' );
+        add_option( 'hash_link_scroll_offset_msg', 1, '', 'no' );
     }
 
@@ -122 +122 @@
         }
         delete_option( 'hash_link_scroll_offset_msg' );
+        // translators: %s is the name of the plugin.
         $settings_link = sprintf( '<a href="%s">%s</a>', $this->settings_url(), sprintf( __( 'update the "%s" setting', 'hash_link_scroll_offset' ), self::$name ) );
-        echo '
-        <div id="message" class="updated">
-            <p>' . sprintf( __( 'The "%s" plugin has been activated. Please %s.', 'hash_link_scroll_offset' ), self::$name, $settings_link ) . '</p>
-        </div>
-        ';
+
+        echo wp_kses_post(
+            '<div id="message" class="updated">
+                <p>' . /* translators: %1$s is the name of the plugin, %2$s is a link to the settings page. */ sprintf( __( 'The "%1$s" plugin has been activated. Please %2$s.', 'hash_link_scroll_offset' ), self::$name, $settings_link ) . '</p>
+            </div>'
+        );
     }
 
@@ -189 +191 @@
         </style>
         <?php endif; ?>
-        <div class="hash_link_scroll_offset_setting_wrap<?php echo $class; ?>">
-            <input class="small-text" placeholder="50" type="number" step="1" min="1" id="hash_link_scroll_offset" name="hash_link_scroll_offset" value="<?php echo get_option( 'hash_link_scroll_offset', 0 ); ?>"> <?php esc_html_e( 'pixels', 'hash_link_scroll_offset' ); ?>
+        <div class="hash_link_scroll_offset_setting_wrap<?php echo esc_attr( $class ); ?>">
+            <input class="small-text" placeholder="50" type="number" step="1" min="1" id="hash_link_scroll_offset" name="hash_link_scroll_offset" value="<?php echo esc_attr( get_option( 'hash_link_scroll_offset', 0 ) ); ?>"> <?php esc_html_e( 'pixels', 'hash_link_scroll_offset' ); ?>
         </div>
         <p class="description"><?php esc_html_e( 'When the Admin Bar is displayed in your theme, this value is automatically increased by 32px.', 'hash_link_scroll_offset' ); ?></p>
@@ -203 +205 @@
     public function enqueue_js() {
         $min = defined( 'SCRIPT_DEBUG' ) && SCRIPT_DEBUG ? '' : '.min';
-        wp_enqueue_script( 'hash_link_scroll_offset', self::$url . "assets/js/hash-link-scroll-offset$min.js", [ 'jquery' ], self::VERSION, true );
-        wp_localize_script( 'hash_link_scroll_offset', 'hlso_offset', [ 'offset' => get_option( 'hash_link_scroll_offset', 0 ) ] );
+
+        // Automatically load imported dependencies and assets version.
+        $asset_file = require plugin_dir_path( __FILE__ ) . 'assets/js/hash-link-scroll-offset.min.asset.php';
+
+        wp_register_script(
+            'hash_link_scroll_offset',
+            plugins_url( "assets/js/hash-link-scroll-offset$min.js", __FILE__ ),
+            $asset_file['dependencies'],
+            $asset_file['version'],
+            true
+        );
+        wp_enqueue_script( 'hash_link_scroll_offset' );
+        wp_add_inline_script( 'hash_link_scroll_offset', 'const hlsOffset = ' . wp_json_encode( [ 'offset' => get_option( 'hash_link_scroll_offset', 0 ) ] ) . ';', 'before' );
     }
 
@@ -217 +230 @@
         return admin_url( 'options-general.php?hash_link_scroll_offset' );
     }
-
 }
 
 // Init our class.
-$Hash_Link_Scroll_Offset = new Hash_Link_Scroll_Offset();
-$Hash_Link_Scroll_Offset->hooks();
-
+$hash_link_scroll_offset = new Hash_Link_Scroll_Offset();
+$hash_link_scroll_offset->hooks();

hash-link-scroll-offset/trunk/readme.txt

@@ -4 +4 @@
 Tags:
 Requires at least: 5.5
-Tested up to:      6.4.3
-Stable tag:        0.2.2
+Tested up to:      6.5.0
+Stable tag:        0.3.0
 License:           GPLv2 or later
 License URI:       http://www.gnu.org/licenses/gpl-2.0.html
@@ -34 +34 @@
 
 == Changelog ==
+
+= 0.3.0 =
+* Updated: Removed jQuery dependency in our javascript
+* Updated: Escaping and sanitizing of output.
 
 = 0.2.2 =