Quantity Queries mixins

 

Simple quantity queries mixins for Sass. Use quantity as a condition to style your items. Learn more about quantity queries in this A List Apart article. See the mixins in action in this CodePen Demo

Mixin item quantity matching examples:

| | 1 item | 2 items | 3 items | 4 items | 5 items | 6 items |
| --------------- | :----: | :-----: | :-----: | :-----: | :-----: | :-----: |
| at-least(4) | | | | ✓ | ✓ | ✓ |
| at-most(4) | ✓ | ✓ | ✓ | ✓ | | |
| between(3, 6) | | | ✓ | ✓ | ✓ | ✓ |
| exactly(5) | | | | | ✓ | |
| even() | | ✓ | | ✓ | | ✓ |
| odd() | ✓ | | ✓ | | ✓ | |
| multiple-of(3)| | | ✓ | | | ✓ |

Install

Using npm:

``sh
npm install --save-dev quantity-queries
`

Using Yarn:

`sh
yarn add --dev quantity-queries
`

Usage

Import the library:

`scss
// Dart Sass
@use 'quantity-queries';
`

`scss
// LibSass
@import 'quantity-queries/legacy';
`

Note: depending on your setup you might need to use the node_modules path for the import.

`scss
// Dart Sass
@use '{node_modules_path}/quantity-queries/src/';

// Legacy implementations (e.g., node-sass)
@import '{node_modules_path}/quantity-queries/src/legacy';
`

$3

Target the items inside elements that contain $count items or more:

`scss
@include at-least($count, $selector) { ... }
`

$3

Target the items inside elements that contain $count items or less:

`scss
@include at-most($count, $selector) { ... }
`

$3

Target the items inside elements that contain a range between $first and $last items:

`scss
@include between($first, $last, $selector) { ... }
`

$3

Target the items inside elements that contain exactly $count items:

`scss
@include exactly($count, $selector) { ... }
`

$3

Target the items inside elements that contain an even number of items:

`scss
@include even($selector) { ... }
`

$3

Target the items inside elements that contain an odd number of items:

`scss
@include odd($selector) { ... }
`

$3

Target the items inside elements that contain a multiple of $count number of items:

`scss
@include multiple-of($selector) { ... }
`

$3

Sass input:

`scss
ul > li {

// Color the li items red when there are 6 items or more
@include at-least(6) {
color: red;
}

// Color the li items blue when there are 4 items or less
@include at-most(4) {
color: blue;
}

// Add a green background to li items when there are between 5 and 8 items
@include between(5, 8) {
background-color: green;
}

// Add a shadow to li items when there are exactly 8 items
@include exactly(8) {
box-shadow: 0 1px 3px #000;
}

// Add a red outline to li items when there is an even number of them
@include even() {
outline: solid 2px red;
}

// Add a blue outline to li items when there is an odd number of them
@include odd() {
outline: solid 2px blue;
}

// Span every sixth element of a grid when it and its siblings are a multiple of 6
@include multiple-of(6, '*') {
&:nth-child(6n + 1) {
grid-row: span 2;
grid-column: span 2;
}
}
}
`

$3

The quantity queries mixins default to the current last simple selector for all the items (li in the above example). If you need a different selector or want the quantity query to be selector-agnostic, pass the desired selector to the mixin.

`scss

nav div {
@include at-least(4, '*') { ... }; // selector agnostic (universal selector)
@include between(4, 8, 'span') { ... }; // use span instead of div
}
``

Demo on CodePen

Other implementations

- LESS Quantity Queries by Anders D. Johnson
- PostCSS Quantity Queries by Pascal Duez