mixitup

by patrickkunka

patrickkunka /mixitup

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

4.3K Stars 727 Forks Last release: almost 2 years ago (v3.3.1) 547 Commits 49 Releases

Available items

No Items, yet!

The developer of this repository has not created any items for sale yet. Need a bug fixed? Help with integration? A different license? Create a request here:

MixItUp 3

Build Status Coverage Status jsDelivr Hits

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.

For a live sandbox, full documentation, tutorials and more, please visit kunkalabs.com/mixitup.

Migrating from MixItUp 2? Check out the MixItUp 3 Migration Guide.

Licensing

MixItUp is open source and free to use for non-commercial, educational and non-profit use. For use in commercial projects, a commercial license is required. For licensing information and FAQs please see the MixItUp Licenses page.

Documentation

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

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'
.

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

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'
.
All
Category A
Category B
Category C

Further reading: Filtering with MixItUp

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'
.
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

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

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 

We use cookies. If you continue to browse the site, you agree to the use of cookies. For more information on our use of cookies please see our Privacy Policy.