WordPress.org

Plugin Directory

Page scroll to id

Page scroll to id is an easy-to-use jQuery plugin that enables animated page scrolling to specific id within the document.

The plugin replaces the default browser behaviour of "jumping" to page sections when links with href value containing # are clicked, by smoothly animating the page to those sections. You can use it for simple back-to-top links or complex single-page website navigation. Features include:

  • Auto-adjustable animation speed
  • Advanced animation easings
  • Vertical and/or horizontal scrolling
  • Links and targets highlighting via ready-to-use CSS classes
  • Auto-adjustable scroll-to position
  • Advanced scroll-to position offset (by pixels, by element selector, link specific offsets etc.)
  • Page scrolling from/to different pages (scrolling to location hash)

Demo

Requirements

Page scroll to id requires WordPress version 3.3 or higher and jQuery version 1.6.0 or higher. For older installations implement it in your theme manually. Your theme must (and should) have wp_head() and wp_footer() functions. In some MS Windows based web servers the plugin might produce an error 500 (depends on server/PHP configuration). To pinpoint the issue enable debugging in wp-config.php and check wp-content/debug.log file for relevant errors.

Quick usage and tips

  1. Install the plugin.
  2. Check "Enable on WordPress Menu links" in plugin's settings to automatically enable the plugin on your WordPress menus custom links.
  3. Create your links and targets using plugin's shortcodes (see "Help" in plugin settings page) directly in WordPress post editor or via plugin's buttons in visual editor toolbar.
  4. Create targets in widgets areas using "Page scroll to id target" widget.
  5. Add the class ps2id on any link you want to be handled by the plugin.
  6. If you prefer not to automatically enable the plugin on WordPress menus, use either m_PageScroll2id or ps2id values in 'Link Relationship (XFN)' and 'CSS Classes' fields accordingly. To enable the rel attribute field in WordPress Menus, click 'Screen Options' and check 'Link Relationship (XFN)'. To enable the plugin on a menu item, click the arrow on the right of the item and insert m_PageScroll2id in the 'Link Relationship (XFN)' field.

Tutorials

For more information see Help in plugin settings and resources below.

Plugin Resources

Requires: 3.3 or higher
Compatible up to: 4.5.1
Last Updated: 2 weeks ago
Active Installs: 30,000+

Ratings

4.8 out of 5 stars

Support

5 of 17 support threads in the last two months have been marked resolved.

Got something to say? Need help?

Compatibility

+
=
Not enough data

0 people say it works.
0 people say it's broken.

0,1,0 100,1,1
100,3,3
100,1,1
100,1,1
100,1,1
100,1,1
50,2,1
100,1,1 100,3,3
100,1,1 100,2,2 100,1,1
100,1,1
100,1,1
100,5,5
100,1,1
67,3,2
100,1,1 100,1,1
100,1,1
100,1,1 100,1,1
100,1,1