Nicescrollr Logo

Nicescrollr

A WordPress plugin that acts as a wrapper for Inuyaksa's Nicescroll.js library.

WordPress Plugin Repository Page Download

Report A Bug Request Feature

--- ## Table Of Contents - [Features](#features) - [Requirements](#requirements) - [Installation](#installation) - [Quick Start](#quick-start) - [Documentation](#documentation) - [Frequently Asked Questions](#documentation) - [Plugin Support](#plugin-support) - [Bugs And Feature Requests](#bugs-and-feature-requests) - [Contributing](#contributing) - [Versioning](#versioning) - [Creator](#creator) - [Copyright And License](#copyright-and-license) --- ## Features - Nicescroll - ScrollTop Button - Frontend and Backend --- ## Requirements PHP 8.2 --- ## Installation 1. Upload the `nicescrollr` folder to your `/wp-content/plugins/` directory. 2. Activate the "Nicescrollr" plugin through the "Plugins" menu in WordPress. 3. You will find its settings page listed in the "settings" section. 4. Go to the plugin settings page and fit it to your needs :-) Have fun! --- ## Quick Start Head over to the settings page and set scroll bar for the frontpage and the backend. --- ## Documentation Once you've installed the plugin, you'll find help tabs inside the WordPress contextual help system. --- ## Frequently Asked Questions #### Where do I interact with this plugin and how does it work? Please visit the plugin's help tab for further information. #### Why doesn't it work with my theme? Most likely, this is because your theme (or another plugin?) already has the Nicescroll library on board. If that's the case, I advise you to uninstall this plugin again to prevent compatibility issues. Of course, you can always ask your theme developer to implement a function to disable the built-in solution if you like to use this plugin and its Options. The capability required for being able to customize settings is the following: * `nicescrollr_edit` - The user can change settings regarding this plugin. #### Are there any known limitations? There may be issues with scrolling on the backend, if you are using a pen and a graphics tablet. There may also be issues scrolling over iFrames. #### Are there any known issues? Besides the known limitations, no. --- ## Plugin Support If you need support or have a question, I check the WordPress plugin support section on [WordPress Plugin Repository](https://wordpress.org/support/plugin/nicescrollr/) once or twice a month. --- ## Bugs And Feature Requests Have a bug or a feature request? Please first read the [issue guidelines](https://github.com/demispatti/nicescrollr/blob/master/.github/CONTRIBUTING.md#using-the-issue-tracker) and search for existing and closed issues. If your problem or idea is not addressed yet, [please open a new issue](https://github.com/demispatti/nicescrollr/issues/new). --- ## Contributing Please read through our [contributing guidelines](https://github.com/demispatti/nicescrollr/blob/master/.github/CONTRIBUTING.md). Included are directions for opening issues, coding standards, and notes on development. Moreover, if your pull request contains JavaScript patches or features, you must include [relevant unit tests](https://github.com/demispatti/nicescrollr/tree/master/js/tests). All HTML and CSS should conform to the [Code Guide](https://github.com/demispatti/code-guide), maintained by [Demis Patti](https://github.com/demispatti). Editor preferences are available in the [editor config](https://github.com/demispatti/nicescrollr/blob/master/.editorconfig) for easy use in common text editors. Read more and download plugins at . --- ## Versioning For transparency into our release cycle and in striving to maintain backward compatibility, Nicescrollr is maintained under [the Semantic Versioning guidelines](https://semver.org/). Sometimes we screw up, but we adhere to those rules whenever possible. See [the Releases section of our GitHub project](https://github.com/demispatti/nicescrollr/releases) for changelogs for each release version of Nicescroll. --- ## Creator **Demis Patti** --- ## Copyright and license Code and documentation copyright 2019 [Demis Patti](https://github.com/demispatti/nicescrollr/graphs/contributors). Code released under the [GPL V2 License](https://github.com/demispatti/nicescrollr/blob/master/LICENSE).