Data

Tools

Indexes

Applications

Experiments

Awesome

An open API service indexing awesome lists of open source software.

https://github.com/patrickkunka/mixitup

A high-performance, dependency-free library for animated filtering, sorting, insertion, removal and more
https://github.com/patrickkunka/mixitup

animation dom-manipulation filter sort vanilla-js

Last synced: about 1 month ago
JSON representation

A high-performance, dependency-free library for animated filtering, sorting, insertion, removal and more

Awesome Lists containing this project

README 

        
# 📣 November 2024 Update 📣



### Changes to License Model



As MixItUp turns 10 years old (and having remained unchanged since ~2018) it will be moving to a **fully open source** and publicly available model. This means that from 1st November 2024, you no longer need to purchase a license for commercial use.



Additionally, the MixItUp project and its extensions will become **fully archived** meaning that no future changes will be made. MixItUp has been stable for many years and remains in use across tens of thousands of web sites and applications worldwide. If you wish to use it on a brand-new project and it meets your needs, then you should feel confident in doing so provided you do not require support.



### Pagination and MultiFilter Extensions



The Pagination and MultiFilter extensions, which were previously closed source and only available via purchase, have also been been made publicly available on GitHub, and may now be used without purchase or a commercial license.



- [www.github.com/patrickkunka/mixitup-pagination](https://www.github.com/patrickkunka/mixitup-pagination)

- [www.github.com/patrickkunka/mixitup-multifilter](https://www.github.com/patrickkunka/mixitup-multifilter)



### Documentation Website



The documentation website has been retired in favor of GitHub. All documentation and tutorials are available via this GitHub repository, or the repository of the relevant extension (see above).



### Demos



Hosted interactive demos may be found at [patrickkunka.github.io/mixitup/demos](https://patrickkunka.github.io/mixitup/demos). The documented source code of each demo can be found in the [/demos](./demos/) directory if this repository.



Demos for the Pagination and MultiFilter extensions can be found linked to in their respective repositories.



---



# MixItUp 3



[![Latest Release](https://img.shields.io/npm/v/mixitup.svg?style=flat-square)](https://www.npmjs.com/package/mixitup)

[![jsDelivr Hits](https://data.jsdelivr.com/v1/package/gh/patrickkunka/mixitup/badge?style=rounded)](https://www.jsdelivr.com/package/gh/patrickkunka/mixitup)



MixItUp is a high-performance, dependency-free library for animated DOM manipulation, giving you the power to filter, sort, add and remove DOM elements with beautiful animations.



MixItUp plays nice with your existing HTML and CSS, making it a great choice for responsive layouts and compatible with inline-flow, percentages, media queries, flexbox and more.



Migrating from MixItUp 2? Check out the [MixItUp 3 Migration Guide](./docs/mixitup-3-migration-guide.md).



#### Licensing



MixItUp is open source and free to use for all use cases, under the Apache 2.0 license.



#### Documentation



- [Factory Function](./docs/mixitup.md)

- [Configuration Object](./docs/mixitup.Config.md)

- [Mixer API Methods](./docs/mixitup.Mixer.md)

- [State Object](./docs/mixitup.State.md)

- [Mixer Events](./docs/mixitup.Events.md)



#### Tutorials



##### [Integrating MixItUp into Your Project](./tutorials/integrating-mixitup-into-your-project.md)



MixItUp can be used with static sites, CMSs, web apps and more. This tutorial will help you choose the right integration for your project.



##### [Filtering with MixItUp](./tutorials/filtering-with-mixitup.md)



A summary of the various filtering techniques available in MixItUp – filter/toggle controls, multidimensional filtering, and the filter API.



##### [Sorting with MixItUp](./tutorials/sorting-with-mixitup.md)



A summary of the various sorting techniques available in MixItUp – default sort, attribute sort, multi-attribute sort, and the sort API.



##### [MixItUp Grid Layouts](./tutorials/mixitup-grid-layouts.md)



A summary of the three most common approaches to responsive grids – inline-block, flex-box, and floats – in the context of MixItUp.



##### [Marking Up MixItUp Containers](./tutorials/marking-up-mixitup-containers.md)



This tutorial explores various container markup structures, and explains what is and isn't possible with MixItUp.



##### [Filtering and Sorting on Load](./tutorials/filtering-and-sorting-on-load.md)



A look at how we can use the configuration object to load MixItUp in a state other than its default filtering and sorting behavior.



##### [Using the Dataset API](./tutorials/using-the-dataset-api.md)



New to MixItUp 3, the Dataset API allows interaction with MixItUp purely via changes to a data model, avoiding the use of DOM selectors.



#### Browser Support



MixItUp 3 has been tested for compatibility with the following browsers.



- Chrome 16+

- Firefox 16+

- Safari 6.2+

- Yandex 14+

- Edge 13+

- IE 10+ (with animations), IE 8-9 (no animations)



## Getting Started



#### Contents



- [Building the Container](#building-the-container)

- [Building Controls](#building-controls)

- [Styling the Container](#styling-the-container)

- [Loading MixItUp](#loading-mixitup)

- [Creating a Mixer](#creating-a-mixer)

- [Configuration](#configuration)



Most commonly, MixItUp is applied to a **"container"** of **"target"** elements, which could be a portfolio of projects, a list of blog posts, a selection of products, or any kind of UI where filtering and/or sorting would be advantageous.



To get started, follow these simple steps:



### Building the Container



By default, MixItUp will query the container for targets matching the selector `'.mix'`.



```html



    


    


    


    




```



Targets can be filtered using any valid selector e.g. `'.category-a'`, and are sorted via optional custom data attributes e.g. `'data-order'`.



Further reading: [Marking-up MixItUp Containers](./tutorials/marking-up-mixitup-containers.md)



### Building Controls



One way that filtering and sorting happens is when controls are clicked. You may use any clickable element as a control, but `` is recommended for accessibility.



#### Filter Controls



Filter controls are queried based on the presence of a `data-filter` attribute, whose value must be `'all'`, `'none'`, or a valid selector string e.g. `'.category-a'`.



```html

All

Category A

Category B

Category C

```



Further reading: [Filtering with MixItUp](./tutorials/filtering-with-mixitup.md)



#### Sort Controls



Sort controls are queried based on the presence of a `data-sort` attribute, whose value takes the form of a "sort string" made up of the name of the attribute to sort by, followed by an optional colon-separated sorting order e.g. `'order'`, `'order:asc'`, `'order:desc'`.



```html

Ascending

Descending

Random

```



The values `'default'` and `'random'` are also valid, with `'default'` referring to the original order of target elements in the DOM at the time of mixer instantiation.



Further reading: [Sorting with MixItUp](./tutorials/sorting-with-mixitup.md)



### Styling the Container



While MixItUp can be added on top of any existing CSS layout, we strongly recommend inline-block or flexbox-based styling over floats and legacy grid frameworks when dealing with grid-based designs for a number of reasons.



Further reading: [MixItUp Grid Layouts](./tutorials/mixitup-grid-layouts.md)



### Loading MixItUp



Firstly, load the MixItUp JavaScript library using the preferred method for your project.



#### Script Tag



The most simple way to load MixItUp in your project is to include it via a `` tag before the closing `</body>` tag on your page.



```html

        ...



        <script src="/path/to/mixitup.min.js">