Description
Adds Lenis library for smooth scrolling with a full settings page — no coding required. Unlike headless wrappers, it includes:
Features:
* GSAP/ScrollTrigger integration
* Smooth anchor links with configurable offset
* Automatic nested scroll detection
* Exclude specific elements by ID or class
* Support for both vertical and horizontal scrolling
* Touch device support with adjustable sensitivity
* Easy-to-use settings page
Development
Build assets (JS, CSS) are copied from the lenis npm package.
Source code and full development repository available at:
– Lenis library: https://github.com/darkroomengineering/lenis
Installation
- Upload the
gredich-smooth-scrollfolder to the/wp-content/plugins/directory - Activate the plugin through the ‘Plugins’ menu in WordPress
- Go to Settings > Gredich Smooth Scroll to configure the plugin
FAQ
-
How do I exclude an element from smooth scrolling?
-
There are two ways:
- Using data attributes (recommended): Add
data-lenis-preventattribute to any HTML element you want to exclude. For finer control, use:
Attribute
Descriptiondata-lenis-prevent
Prevent all smooth scroll eventsdata-lenis-prevent-wheel
Prevent wheel events onlydata-lenis-prevent-touch
Prevent touch events onlydata-lenis-prevent-vertical
Prevent vertical scroll events onlydata-lenis-prevent-horizontal
Prevent horizontal scroll events only- Using the settings page: Go to Settings > Gredich Smooth Scroll and add the element’s ID or class to the exclusion list.
- Using data attributes (recommended): Add
-
What is the difference between ID and class selectors?
-
- ID selectors start with
#(e.g.,#my-element) - Class selectors start with
.(e.g.,.my-class)
- ID selectors start with
-
Can I use both methods together?
-
Yes! You can combine data attributes with ID/class exclusions.
-
How does the plugin handle nested scroll elements?
-
By default, the plugin automatically detects nested scrollable elements and lets them scroll natively. You can control this behavior from Settings > Gredich Smooth Scroll using the “Allow Nested Scroll” option.
- Enabled (default): Lenis detects nested scroll containers automatically. Best for most sites.
- Disabled: Disable only if you experience performance issues and prefer to manually exclude elements using the data attributes or exclusion list above.
Reviews
There are no reviews for this plugin.
Contributors & Developers
“Gredich Smooth Scroll” is open source software. The following people have contributed to this plugin.
ContributorsTranslate “Gredich Smooth Scroll” into your language.
Interested in development?
Browse the code, check out the SVN repository, or subscribe to the development log by RSS.
Changelog
1.0.0
- Initial release