It can also be used as a jQuery plugin.
You can install Filterizr by downloading the minified version on its website/repo or through npm/yarn:
npm install filterizr
yarn add filterizr
Three files can be found in the
vanilla.filterizr.min.jsis a distribution of Filterizr which can be used directly in a
<script>tag, as it exposes the Filterizr library as a global.
jquery.filterizr.min.jsis a distribution of Filterizr as a jQuery plugin. It detects and extends the global jQuery object and also exposes the vanilla Filterizr library as a global.
Documentation & Tutorials
If you are building a simple static website and would like to use Filterizr via
<script> tag make sure to download
/dist/vanilla.filterizr.min.js and load it.
If you would like to use the jQuery variation then include
/dist/jquery.filterizr.min.js in a
<script> tag. Make sure to import it after jQuery itself.
If you are importing Filterizr from
import Filterizr from 'filterizr'
If you are using jQuery in that same project, also installed via npm and you would like to use Filterizr as a jQuery plugin then you can call the static method
Filterizr.installAsJQueryPlugin, passing in the jQuery object as follows:
import $ from 'jquery'; import Filterizr from 'filterizr'; // This will extend the $.fn prototype with Filterizr Filterizr.installAsJQueryPlugin($); $('.filter-container').filterizr('filter', 5); // or any other Filterizr API call
Tutorials & Docs
You can find Filterizr's documentation as well as a series of tutorials on how to install and operate Filterizr on the Filterizr website. Here is a list of contents:
- FAQ & Caveats
- Thoroughly documented and easy to use.
- Performs great on mobile.
- Written in TypeScript.
- Has zero dependencies.
If you would like to contribute to Filterizr, please make sure to follow the steps described:
- Create a fork from
- Add your feature or bug fix
- If you're implementing a method, add tests
- Run the tests and ESLint to make sure everything is ok
- Make your PR and set the base branch to
IE11 and all modern browsers.
Did you enjoy Filterizr? Filterizr is and will always be 100% free, if you would like to show your support feel free to donate:
- BTC: 1JdpKt3aeNQuKF9CrUKeq3XkPswcqgAFpt
- ETH: 0xdb259cf059faf286e5834e95c8f3a973438276e8
- Paypal: https://www.paypal.me/yiotiskl
Filterizr is licensed under the MIT License. Enjoy!