Selector(s) -
Use this field when you need to instruct the plugin to handle specific links. The value(s) should be anchor tags (a
, i.e. links) in the form of strings that represent ways of choosing elements in the DOM (i.e. CSS selectors). Each selector is separated by comma, so multiple selectors can be defined as: selector1, selector2, selector3
etc.
Enable on WordPress Menu links enables the plugin automatically on custom links created in WordPress Menus (Appearance → Menus).
To exclude specific links from being handled by the plugin (e.g. special tabs, accordions, toggles etc.), use the selectors are excluded field by adding the element selector(s) you want (separated by comma).
Scroll duration -
Scroll animation duration (i.e. scrolling speed) in milliseconds (1000 milliseconds equal 1 second). Lower values equal faster scrolling.
Auto-adjust scrolling duration instructs the plugin to fine-tune scrolling duration/speed according to target and page scroll position.
Scroll type/easing -
Scroll animation easing type (i.e. the way the animation progresses at different points within its duration). Click here to see a visual representation & demo of all easing types.
Enable Force scroll type/easing if the selected animation easing does not seem to take effect (this can happen when there's conflict with outdated easing libraries added by themes or other plugins.
Scroll behavior -
Always scroll smoothly when reaching the end of the page/document option adjusts scroll-to position so it does not exceed document length.
Enable Stop page scrolling on mouse-wheel or touch-swipe if you want to stop page scrolling when the user tries to scroll the page manually (e.g. via mouse-wheel or touch-swipe).
Enabling Verify target position and readjust scrolling (if necessary), after scrolling animation is complete option, will auto-correct scrolling if the target’s position was changed while the page was scrolling.
If you need to extend the above option for issues with lazy-load images, iframes, changes in document's length etc., enable Extend target position verification and scrolling adjustment for lazy-load scripts (images, iframes etc.) and changes in document's length.
Page layout - Set page scrolling direction (i.e. restrict scrolling) to top-bottom (vertical) or left-right (horizontal) accordingly.
Offset -
Offset scroll-to position by x amount of pixels or by selector. The offset value can a be a positive or negative number (indicating pixels), or a matching set of elements in your html (selector).
Enable the Auto-generate #ps2id-dummy-offset
element option if you want the plugin to create a hidden element with id ps2id-dummy-offset
and use it as the Offset option value and in your CSS by giving it a height equal to the amount of offset you want.
Highlight selector(s) -
The matching set of elements (i.e. selectors) handled by the plugin, that will be eligible for highlighting. The value(s) should be anchor tags (a
, i.e. links).
Classes & highlight options -
The plugin adds special classes to the links and the target elements it handles according to user action and page scrolling position. You can change the clicked link class, as well as the highlight classes for links and targets.
Enable Allow only one highlighted element at a time to prevent multiple elements from being highlighted at the same time.
Enable Keep the current element highlighted until the next one comes into view when you need to keep at least one element (e.g. a menu link) always highlighted.
Enable Highlight by next target to highlight elements according to the next adjucent element from the actual target (useful when target elements have zero dimensions).
Links behavior -
If you want the link’s URL hash value (e.g. #some-id
) to appear in browser's address bar when it's clicked, enable Append the clicked link's hash value to browser's URL/address bar option.
Scroll from/to different pages option enables the plugin to smoothly scroll a newly loaded page to a target (i.e. the hash value in browser's address bar).
To use link-specific offsets (instead of the general offset) when scrolling from/to different pages, enable Use element’s custom offset (if it exists) when scrolling from/to different pages option.
If you want to remove the hash value from browser's address bar when scrolling from/to different pages, enable Remove URL hash when scrolling from/to different pages.
Disable plugin below -
Set the viewport/screen-size in pixels, below which the plugin will be disabled. The value can be width
(e.g. 1024
) or width,height
(e.g. 1024,600
).
Administration -
Check Display widgets id attribute to have the id attribute value of each widget (in Appearance → Widgets) displayed within its panel.
Enable insert link/target buttons in post visual editor activates plugin’s buttons in WordPress visual editor toolbar.
Advanced options -
If another plugin or a theme script handles page scrolling and conflicts with "Page scroll to id", try enabling Prevent other scripts from handling plugin’s links option.
You may add a specific selector for the option above using the Prevent other scripts from handling plugin’s links selector(s) field below.
Enable Normalize anchor-point targets to normalize/reset the CSS properties (height, line-height, border etc.) of anchor-point targets.
Enable Encode unicode characters on links URL when having links with encoded unicode characters (e.g. on internationalized domain names) in their href/URL.