The MixItUp Pagination Extension is now fully open source and publicly available for all types of use. A purchase or commercial license is no longer required.
Read more: MixItUp - November 2024 Update
MixItUp Pagination is an extension for MixItUp, adding dynamic and responsive client-side pagination to filterable and sortable content.
- Paginate through filtered and sorted content
- Real-time page limit configuration – ideal for responsive grids
- Real-time dynamically generated controls and page statistics based on the current filter, sort, and page limit values
- New API methods
- New configuration options
- Increase usability and reduce excessive scrolling when dealing with large datasets
- Provide visual feedback about content to users as they filter and sort
- Client-side only - the entire target collection must exist in the DOM
NB: If you're looking to integrate server-side ajax pagination with MixItUp, consider using MixItUp 3's Dataset API.
Hosted interactive demos may be found at patrickkunka.github.io/mixitup-pagination/demos. The documented source code of each demo can be found in the /demos directory if this repository.
MixItUp extensions may be included in your project via NPM and imported as modules, or loaded globally via a script tag.
If using a script tag, you simply need to load the pagination distribution script (i.e. mixitup-pagination.min.js
) after mixitup, and the extension will automatically detect the mixitup
global variable and install itself.
...
<script src="/path/to/mixitup.min.js"></script>
<script src="/path/to/mixitup-pagination.min.js"></script>
</body>
</html>
If you are building a modular JavaScript project with Webpack, Browserify, or RequireJS, no global variables are exposed. Firstly require both the MixItUp core and the Pagination extension into your module. Then call mixitup.use()
with the extension passed in as an argument. Your extension will be installed and made available to all MixItUp instances throughout your project.
// ES2015+
import mixitup from 'mixitup';
import mixitupPagination from 'mixitup-pagination';
// Call the mixitup factory's .use() method, passing in the extension to install it
mixitup.use(mixitupPagination);
// CommonJS
var mixitup = require('mixitup');
var mixitupPagination = require('mixitup-pagination');
mixitup.use(mixitupPagination);
// AMD
require([
'mixitup',
'mixitup-pagination'
], function(
mixitup,
mixitupPagination
) {
mixitup.use(mixitupPagination);
});
You need only call the .use()
function once per project, per extension, as module loaders will cache a single reference to MixItUp inclusive of all changes made.
MixItUp Pagination extends MixItUp's API and configuration object with various new methods and properties.
By default, pagination functionality is disabled so that you can use MixItUp as normal, even with the extension installed. To enable pagination functionality for a mixer, you simply need to set a value for the pagination.limit
configuration option.
var mixer = mixitup(containerEl, {
pagination: {
limit: 8 // impose a limit of 8 targets per page
}
});
Given a "page list" element in DOM, MixItUp Pagination will automatically generate a list of "pager" controls allowing the user to move from page to page, as well as providing visual feedback about the current number of pages.
MixItUp Pagination will query the DOM for an element matching the selectors.pageList
configuration option ('.mixitup-page-list'
by default). If a matching element is found, a list of pager buttons will be automatically rendered inside this element.
<div class="container">
<div class="mix"></div>
<div class="mix"></div>
...
</div>
<div class="mixitup-page-list"></div>
Given a "page stats" element in the DOM, MixItUp Pagination will automatically render information about the page and matching dataset, for example "5-8 of 32".
MixItUp Pagination will query the DOM for an element matching the selectors.pageStats
configuration option ('.mixitup-page-stats'
by default). If a matching element is found, content will be rendered inside this element.
<div class="container">
<div class="mix"></div>
<div class="mix"></div>
...
</div>
<div class="mixitup-page-list"></div>
<div class="mixitup-page-stats"></div>
As with the MixItUp core, the default "pager" controls are optional. If you wish to change the curent page or page limit via the API, MixItUp Pagination adds several new mixer API methods allowing API-based full control.
var mixer = mixitup(containerEl, {
pagination: {
limit: 12
}
});
mixer.paginate(2); // go to page 2
Further reading: Mixer API Methods
MixItUp Pagination adds various new properties to the configuration object. If no configuration object is passed, the default settings will be used. However, pagination.limit
must always be set to a value greater than 0
if you wish to enable pagination on instantiation.
var mixer = mixitup(containerEl, {
pagination: {
limit: 4,
maintainActivePage: false,
loop: true,
hidePageListIfSinglePage: true
},
load: {
page: 3 // load page 3 on instantiation
}
});
Further reading: Configuration Object