@justeattakeaway/pie-css 0.10.0 → 0.12.0

package/README.md

@@ -13,27 +13,32 @@
 # Table of Contents
 
 1. [Introduction](#introduction)
-2. [Using pie-css for building web applications](#using-pie-css-for-building-web-applications)
+2. [Installation](#installation)
+3. [Using the `pie-css` CSS stylesheet in your web application](#using-the-pie-css-css-stylesheet-in-your-web-application)
     1. JS or Framework import (via bundler)
-    2. NuxtJS
+    2. Nuxt
     3. Sass /SCSS
     4. Native HTML
-3. [Using pie-css for building web components](#using-pie-css-for-building-web-components)
-    - [Z-index](#z-index)
-4. [Testing](#testing)
+4. [What's included in the `pie-css` base stylesheet](#whats-included-in-the-pie-css-base-stylesheet)
+4. [Using the `pie-css` SCSS helpers (mixins & functions)](#using-the-pie-css-scss-helpers-mixins--functions)
+    1. [Importing the `pie-css` SCSS helpers](#importing-the-pie-css-scss-helpers)
+    2. [`pie-css` SCSS Helper Definitions](#pie-css-scss-helper-definitions)
+        -  [`font-size()`](#font-size)
+        - [`@include media()`](#include-media)
+5. [Testing](#testing)
     - [CSS](#css)
-    - [SCSS](#scss )
+    - [SCSS](#scss)
 
 ## Introduction
 
-PIE CSS is A styling library that provides both a shared collection of ready to use CSS styles to be used across JET web front-ends, and SCSS-based style helpers for our PIE Web Component library.
+`pie-css` is a styling library that provides both a minimal set of CSS styles to help PIE Web Components display as intended on web applications, and a set of optional SCSS style helpers (mixins & functions) to help with common styling tasks.
+
+It also includes the PIE design tokens (and HSL colour variants) as CSS variables, as these variables are used across the PIE component styles and therefore need to be imported when using the PIE Web Components.
 
----
 
-## Using pie-css for building web applications
-`pie-css` provides a base stylesheet that sets up some basic styles used by our components. It is essential that this stylesheet is included in any application that uses PIE Web Components. The stylesheet provides some basic styles for things like typography and provides the design tokens that are used by our components.
+## Installation
 
-To install the PIE CSS library, run the following on your command line:
+To install `pie-css`, run the following on your command line:
 
 ```bash
 # npm
@@ -43,12 +48,19 @@ npm i @justeattakeaway/pie-css
 yarn add @justeattakeaway/pie-css
 ```
 
-Once installed, how you include PIE CSS will largely depend on the type of application you are building (and your own preference), but here are a few examples.
+
+---
+
+## Using the `pie-css` CSS stylesheet in your web application
+
+`pie-css` provides a base stylesheet that sets up some basic styles used by the PIE Web Components. It is essential that this stylesheet is included in any application that uses PIE Web Components. The stylesheet provides a minimal set of styles for ensuring typography displayed as intended, while also importing the PIE design tokens that are used by our components.
+
+[Once installed](#installation), how you include these styles will largely depend on the type of application you are building (and your own preference), but here are a few examples.
 
 
 ### JS or Framework import (via bundler)
 
-One common way of importing PIE CSS would be through a regular JS import as part of your application bundle.
+One common way of importing the styles would be through a regular JS import as part of your application bundle.
 
 ```js
 import '@justeattakeaway/pie-css';
@@ -80,12 +92,12 @@ import App from './App.vue';
 createApp(App).mount('#app');
 ```
 
-### NuxtJS
+### Nuxt
 
-If you are using NuxtJS, you can import PIE CSS in your `nuxt.config.js` file.
+If you are using Nuxt, you can import `pie-css` in your `nuxt.config.js` file.
 
 
-For NuxtJS v3, this would look like this:
+For Nuxt v3, this would look like this:
 
 ```js
 // Nuxt v3
@@ -95,7 +107,7 @@ export default defineNuxtConfig({
 });
  ```
 
-For NuxtJS v2, it is very similar, looking more like this:
+For Nuxt v2, it is very similar, looking more like this:
 
 ```js
 export default {
@@ -121,22 +133,43 @@ If you are using Sass, you could import the CSS file as part of your styles dire
 Of course, you could include the styles straight inside your HTML document – most likely you'd want to link to the `/@justeattakeaway/pie-css/dist/index.css` CSS file in the head of your HTML.
 
 
+## What's included in the `pie-css` base stylesheet
 
-## Using pie-css for building web components
-> [!NOTE]
-> The following section is only relevant if you are building web components as a part of our component library within the PIE monorepo.
+You can see the pre-compiled `pie-css` styles [in the `pie-css` repo](https://github.com/justeattakeaway/pie/blob/main/packages/tools/pie-css/css/input.css), but let's run through what's included.
+
+### PIE Design Tokens
+
+A core dependency of our PIE Web Components are the PIE design tokens. These are imported in the `pie-css` styles, as well as tokens for HSL colour variants (which are useful when needing to lighten/darken colours).
 
-PIE CSS provides an optional set of SCSS helpers that are used by the PIE Web Components.
+### box-sizing
 
-These are for carrying out common tasks in our styles, such as setting font sizes in consistent ways and sharing styles across components via SCSS mixins and functions.
+We set `box-sizing: border-box` so that the CSS box model acts consistently when using PIE components.
 
-We will be writing more in-depth docs on these SCSS helpers shortly, but for now, feel free to browse the [SCSS code in the PIE mono-repo](https://github.com/justeattakeaway/pie/tree/main/packages/tools/pie-css/scss).
+### Typography
 
-### z-index
+There are a number of typographic CSS rules that we specify to help with font rendering. These are:
 
-Some PIE Web Components use a z-index value to control how they stack on a webpage. These values are defined in the `pie-css` package as css variables and are utilized internally. In most cases, a webpage should follow the DOM's natural stacking order and the default z-index order assigned for each component. However, if you're creating custom components, refer to the following table to make sure they don't conflict with other components.
+```css
+/*  These rules with smooth fonts. It makes fonts look crisp and clean on devices
+that support it. */
+text-rendering: optimizelegibility;
+-webkit-font-smoothing: antialiased;
+-moz-font-smoothing: antialiased;
 
-| Token              | Z-Index Value  |
+/*  These are added to prevent text size adjustments in various browsers.
+    In some browsers, such as iOS Safari, will try to increase the font-size
+    when you rotate the screen. This can be jarring and break layouts.  */
+-webkit-text-size-adjust: 100%;
+text-size-adjust: 100%;
+```
+
+### z-index variables
+
+Some PIE Web Components use a z-index value to control how they stack on a webpage. These values are defined as CSS variables and are utilized internally.
+
+In most cases, a webpage should follow the DOM's natural stacking order and the default z-index order assigned for each component. However, if you're creating custom components, refer to the following table to make sure they don't conflict with other components.
+
+| Token                      | Z-Index Value  |
 | -------------------------- | ---------------|
 | --dt-z-index-dropdown      | 1000           |
 | --dt-z-index-fab           | 1000           |
@@ -148,6 +181,133 @@ Some PIE Web Components use a z-index value to control how they stack on a webpa
 | --dt-z-index-cookie-banner | 5000           |
 | --dt-z-index-toast         | 6000           |
 
+---
+
+## Using the `pie-css` SCSS helpers (mixins & functions)
+
+PIE CSS provides an optional set of SCSS helpers that are used by the PIE Web Components. These can also be used by web applications using SCSS, by importing the helpers into their project.
+
+These helpers are for carrying out common tasks when interacting with the PIE design tokens, such as setting font sizes and media-queries in a consistent way, and for sharing styles definitions via SCSS mixins and functions.
+
+One common example is to add unit suffixes (such as `px`) to the end of `font-size` declarations, as these are imported as unit-less values from our design tokens.
+
+### Importing the `pie-css` SCSS helpers
+
+Ensure you have installed `pie-css` as set out in [the installation section](Installation).
+
+Once you have done this, you can then import the helpers by writing the following in your SCSS:
+
+```scss
+@use '@justeattakeaway/pie-css/scss' as *;
+
+// or to namespace the mixins and functions, to avoid collisions
+// import the helpers while defining a namespace
+@use '@justeattakeaway/pie-css/scss' as p;
+```
+
+You should now be able to use the `pie-scss` helpers in that SCSS scope.
+
+Be aware that if you want to set this up globally across your application, you'll need to add this import to your application SCSS config, but it's recommended to `@use` the helpers only in the SCSS files that use them on your project.
+
+### `pie-css` SCSS Helper Definitions
+
+#### `font-size()`
+
+Used to reference design token font variables to add `px` unit values.
+
+`font-size` can be used as a mixin to output the full style declaration, or as a function when you would like to assign the design token to a CSS variable.
+
+```scss
+// Use the font-size() mixin
+.c-label {
+  @include font-size(--dt-font-body-s-size);
+}
+// Outputs:
+.c-label {
+  font-size: calc(var(--dt-font-body-s-size) * 1px);
+}
+```
+
+```scss
+// Use the font-size function
+--body-font-size: #{font-size(--dt-font-body-s-size)};
+
+.c-label {
+  font-size: var(--body-font-size);
+}
+
+// Outputs:
+--body-font-size: calc(var(--dt-font-body-s-size) * 1px);
+
+.c-label {
+  font-size: var(--dt-font-body-s-size);
+}
+```
+
+#### `@include media()`
+
+For media queries, we use an SCSS helper library called [include-media](https://eduardoboucas.github.io/include-media).
+
+This library allows you to setup shortcut names for common breakpoints and provides a nicer syntax for working with media queries through the use of logical operators (such as `>=` and `<=`).
+
+As part of the `pie-css` SCSS helpers, we setup the breakpoint shortcut names such that:
+
+```scss
+$breakpoints: (
+    xs: 320px,
+    sm: 600px,
+    md: 768px,
+    lg: 1024px,
+    xl: 1280px,
+    xxl: 1440px
+);
+```
+
+You can then use these in your SCSS like so:
+
+```scss
+@use '@justeattakeaway/pie-css/scss' as *;
+
+.c-formField {
+  color: red;
+
+  @include media('>=sm') {
+    color: blue;
+  }
+}
+
+// Outputs:
+.c-formField {
+  color: red;
+}
+@media (min-width: 600px) {
+  .c-formField {
+    color: blue;
+  }
+}
+```
+
+It also lets you write nice expressions like this:
+
+```scss
+.c-formField {
+  // target between sm and md breakpoints on retina2x devices
+  @include media('>=sm', '<=md', 'retina2x') {
+    color: purple;
+  }
+}
+
+```
+
+To see the full list of features `include-media` provides, [check out their website](https://eduardoboucas.github.io/include-media).
+
+
+### Other SCSS helpers
+
+We will be writing more in-depth docs on all of our SCSS helpers shortly, but for now, feel free to browse the [SCSS code in the PIE mono-repo](https://github.com/justeattakeaway/pie/tree/main/packages/tools/pie-css/scss) – or reach out to one of the DS team who can take you through what's available.
+
+---
+
 ## Testing
 
 We strive to ensure all styles are appropriately tested. How we test the styles differs for CSS and SCSS. Below, we outline both approaches.

package/dist/index.css

@@ -81,6 +81,7 @@
     --dt-color-border-strong: var(--dt-color-mozzarella-30);
     --dt-color-border-inverse: var(--dt-color-mozzarella-70);
     --dt-color-border-selected: var(--dt-color-mozzarella-50);
+    --dt-color-border-selected-brand: var(--dt-color-orange);
     --dt-color-divider-default: rgb(0,0,0,0.08);
     --dt-color-divider-inverse: rgb(255,255,255,0.20);
     --dt-color-interactive-brand: var(--dt-color-orange);
@@ -101,6 +102,8 @@
     --dt-color-support-info-02: var(--dt-color-blue-10);
     --dt-color-support-info-inverse: var(--dt-color-blue-30);
     --dt-color-support-positive-inverse: var(--dt-color-green-30);
+    --dt-color-support-neutral-persistent: var(--dt-color-mozzarella-20);
+    --dt-color-support-error-inverse: var(--dt-color-red-30);
     --dt-color-support-brand-01: var(--dt-color-orange-30);
     --dt-color-support-brand-02: var(--dt-color-orange-10);
     --dt-color-support-brand-03: var(--dt-color-blue-25);
@@ -145,6 +148,7 @@
     --dt-color-active-01-dark: 12%;
     --dt-color-active-02: 20%;
     --dt-color-active-02-light: 20%;
+    --dt-color-resting: 0%;
     --dt-color-focus-inner: var(--dt-color-white);
     --dt-color-focus-outer: var(--dt-color-blue-70);
     --dt-color-disabled-01: var(--dt-color-mozzarella-20);
@@ -167,6 +171,7 @@
     --dt-color-highcontrast-border-strong: var(--dt-color-black);
     --dt-color-highcontrast-border-inverse: var(--dt-color-white);
     --dt-color-highcontrast-border-selected: var(--dt-color-black);
+    --dt-color-highcontrast-border-selected-brand: var(--dt-color-orange-dark-hc);
     --dt-color-highcontrast-divider-default: var(--dt-color-black);
     --dt-color-highcontrast-divider-inverse: var(--dt-color-white);
     --dt-color-highcontrast-interactive-brand: var(--dt-color-orange-dark-hc);
@@ -187,6 +192,8 @@
     --dt-color-highcontrast-support-info-02: var(--dt-color-white);
     --dt-color-highcontrast-support-info-inverse: var(--dt-color-blue-light-hc);
     --dt-color-highcontrast-support-positive-inverse: var(--dt-color-green-light-hc);
+    --dt-color-highcontrast-support-neutral-persistent: var(--dt-color-white);
+    --dt-color-highcontrast-support-error-inverse: var(--dt-color-red-light-hc);
     --dt-color-highcontrast-support-brand-01: var(--dt-color-orange-30);
     --dt-color-highcontrast-support-brand-02: var(--dt-color-white);
     --dt-color-highcontrast-support-brand-03: var(--dt-color-white);
@@ -231,6 +238,7 @@
     --dt-color-highcontrast-active-01-dark: 12%;
     --dt-color-highcontrast-active-02: 20%;
     --dt-color-highcontrast-active-02-light: 20%;
+    --dt-color-highcontrast-resting: 0%;
     --dt-color-highcontrast-focus-inner: var(--dt-color-white);
     --dt-color-highcontrast-focus-outer: var(--dt-color-blue-70);
     --dt-color-highcontrast-disabled-01: var(--dt-color-mozzarella-20);
@@ -253,6 +261,7 @@
     --dt-color-dark-border-strong: var(--dt-color-mozzarella-60);
     --dt-color-dark-border-inverse: var(--dt-color-mozzarella-20);
     --dt-color-dark-border-selected: var(--dt-color-mozzarella-30);
+    --dt-color-dark-border-selected-brand: var(--dt-color-orange);
     --dt-color-dark-divider-default: rgb(255,255,255,0.20);
     --dt-color-dark-divider-inverse: rgb(0,0,0,0.08);
     --dt-color-dark-interactive-brand: var(--dt-color-orange);
@@ -262,7 +271,7 @@
     --dt-color-dark-interactive-light: var(--dt-color-white);
     --dt-color-dark-interactive-form: var(--dt-color-mozzarella-50);
     --dt-color-dark-overlay: rgb(0,0,0,0.55);
-    --dt-color-dark-support-error: var(--dt-color-red);
+    --dt-color-dark-support-error: var(--dt-color-red-30);
     --dt-color-dark-support-warning: var(--dt-color-yellow);
     --dt-color-dark-support-positive: var(--dt-color-green-30);
     --dt-color-dark-support-info: var(--dt-color-blue-30);
@@ -273,6 +282,8 @@
     --dt-color-dark-support-info-02: var(--dt-color-blue-90);
     --dt-color-dark-support-info-inverse: var(--dt-color-blue);
     --dt-color-dark-support-positive-inverse: var(--dt-color-green);
+    --dt-color-dark-support-neutral-persistent: var(--dt-color-mozzarella-20);
+    --dt-color-dark-support-error-inverse: var(--dt-color-red);
     --dt-color-dark-support-brand-01: var(--dt-color-orange-30);
     --dt-color-dark-support-brand-02: var(--dt-color-orange-90);
     --dt-color-dark-support-brand-03: var(--dt-color-blue-25);
@@ -317,6 +328,7 @@
     --dt-color-dark-active-01-dark: 12%;
     --dt-color-dark-active-02: 12%;
     --dt-color-dark-active-02-light: 20%;
+    --dt-color-dark-resting: 0%;
     --dt-color-dark-focus-inner: var(--dt-color-black);
     --dt-color-dark-focus-outer: var(--dt-color-blue-30);
     --dt-color-dark-disabled-01: var(--dt-color-mozzarella-80);
@@ -339,6 +351,7 @@
     --dt-color-highcontrast-dark-border-strong: var(--dt-color-white);
     --dt-color-highcontrast-dark-border-inverse: var(--dt-color-black);
     --dt-color-highcontrast-dark-border-selected: var(--dt-color-white);
+    --dt-color-highcontrast-dark-border-selected-brand: var(--dt-color-orange-30);
     --dt-color-highcontrast-dark-divider-default: var(--dt-color-white);
     --dt-color-highcontrast-dark-divider-inverse: var(--dt-color-black);
     --dt-color-highcontrast-dark-interactive-brand: var(--dt-color-orange-30);
@@ -359,6 +372,8 @@
     --dt-color-highcontrast-dark-support-info-02: var(--dt-color-black);
     --dt-color-highcontrast-dark-support-info-inverse: var(--dt-color-blue-dark-hc);
     --dt-color-highcontrast-dark-support-positive-inverse: var(--dt-color-green-dark-hc);
+    --dt-color-highcontrast-dark-support-neutral-persistent: var(--dt-color-black);
+    --dt-color-highcontrast-dark-support-error-inverse: var(--dt-color-red-dark-hc);
     --dt-color-highcontrast-dark-support-brand-01: var(--dt-color-orange-30);
     --dt-color-highcontrast-dark-support-brand-02: var(--dt-color-black);
     --dt-color-highcontrast-dark-support-brand-03: var(--dt-color-black);
@@ -403,6 +418,7 @@
     --dt-color-highcontrast-dark-active-01-dark: 12%;
     --dt-color-highcontrast-dark-active-02: 12%;
     --dt-color-highcontrast-dark-active-02-light: 20%;
+    --dt-color-highcontrast-dark-resting: 0%;
     --dt-color-highcontrast-dark-focus-inner: var(--dt-color-black);
     --dt-color-highcontrast-dark-focus-outer: var(--dt-color-blue-30);
     --dt-color-highcontrast-dark-disabled-01: var(--dt-color-mozzarella-80);
@@ -426,9 +442,6 @@
     /* Size-16 font theme */
     --dt-font-size-16: 16;
     --dt-font-size-16-line-height: 24;
-    /* Size-19 font theme */
-    --dt-font-size-19: 19;
-    --dt-font-size-19-line-height: 28;
     /* Size-20 font theme */
     --dt-font-size-20: 20;
     --dt-font-size-20-line-height: 28;
@@ -508,11 +521,6 @@
     --dt-font-interactive-s-family: var(--dt-font-family-primary);
     --dt-font-interactive-s-weight: var(--dt-font-weight-bold);
     --dt-font-interactive-s-line-height: var(--dt-font-size-16-line-height);
-    /* Interactive-m font theme */
-    --dt-font-interactive-m-size: var(--dt-font-size-19);
-    --dt-font-interactive-m-family: var(--dt-font-family-primary);
-    --dt-font-interactive-m-weight: var(--dt-font-weight-bold);
-    --dt-font-interactive-m-line-height: var(--dt-font-size-19-line-height);
     /* Interactive-l font theme */
     --dt-font-interactive-l-size: var(--dt-font-size-20);
     --dt-font-interactive-l-family: var(--dt-font-family-primary);
@@ -911,6 +919,9 @@
     --dt-color-border-selected-h: var(--dt-color-mozzarella-50-h);
     --dt-color-border-selected-s: var(--dt-color-mozzarella-50-s);
     --dt-color-border-selected-l: var(--dt-color-mozzarella-50-l);
+    --dt-color-border-selected-brand-h: var(--dt-color-orange-h);
+    --dt-color-border-selected-brand-s: var(--dt-color-orange-s);
+    --dt-color-border-selected-brand-l: var(--dt-color-orange-l);
     --dt-color-interactive-brand-h: var(--dt-color-orange-h);
     --dt-color-interactive-brand-s: var(--dt-color-orange-s);
     --dt-color-interactive-brand-l: var(--dt-color-orange-l);
@@ -962,6 +973,12 @@
     --dt-color-support-positive-inverse-h: var(--dt-color-green-30-h);
     --dt-color-support-positive-inverse-s: var(--dt-color-green-30-s);
     --dt-color-support-positive-inverse-l: var(--dt-color-green-30-l);
+    --dt-color-support-neutral-persistent-h: var(--dt-color-mozzarella-20-h);
+    --dt-color-support-neutral-persistent-s: var(--dt-color-mozzarella-20-s);
+    --dt-color-support-neutral-persistent-l: var(--dt-color-mozzarella-20-l);
+    --dt-color-support-error-inverse-h: var(--dt-color-red-30-h);
+    --dt-color-support-error-inverse-s: var(--dt-color-red-30-s);
+    --dt-color-support-error-inverse-l: var(--dt-color-red-30-l);
     --dt-color-support-brand-01-h: var(--dt-color-orange-30-h);
     --dt-color-support-brand-01-s: var(--dt-color-orange-30-s);
     --dt-color-support-brand-01-l: var(--dt-color-orange-30-l);

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@justeattakeaway/pie-css",
-  "version": "0.10.0",
+  "version": "0.12.0",
   "description": "A styling library that provides both a shared collection of ready to use CSS styles to be used across JET web front-ends, and SCSS-based style helpers for our PIE Web Component library.",
   "author": "Just Eat Takeaway.com - Design System Team",
   "files": [
@@ -14,7 +14,7 @@
     "lint:style": "run -T stylelint ./**/*.{css,scss}",
     "lint:style:fix": "yarn lint:style --fix",
     "prepublishOnly": "yarn lint:style && yarn lint:scripts && yarn build && yarn test",
-    "test": "run -T vitest run",
+    "test": "run -T vitest run --config ../../../vite.config.js",
     "test:ci": "yarn test",
     "test:watch": "run -T vitest"
   },
@@ -28,6 +28,7 @@
   "license": "Apache-2.0",
   "devDependencies": {
     "@types/postcss-import": "14.0.3",
+    "include-media": "2.0.0",
     "postcss": "8.4.32",
     "postcss-import": "15.1.0",
     "w3c-css-validator": "1.3.1"

package/scss/index.scss

@@ -1,3 +1,5 @@
 @forward 'mixins';
 @forward 'functions';
 @forward 'helpers';
+@forward 'resets';
+@forward 'settings';

package/scss/resets/_host.scss

@@ -0,0 +1,5 @@
+*,
+*:after,
+*:before {
+    box-sizing: inherit;
+}

package/scss/resets/index.scss

@@ -0,0 +1 @@
+@forward './host';

package/scss/settings/_breakpoints.scss

@@ -0,0 +1,19 @@
+// Interval settings to be used by @include-media Sass library
+// https://eduardoboucas.github.io/include-media/documentation/#variable-unit-intervals
+$unit-intervals: (
+    'px': 1,
+    'em': 0.001, // We need more sensitivity, some browsers are very specific with breakpoints
+    'rem': 0.1,
+    '': 0
+);
+
+// Breakpoints to be used by @include-media Sass library
+// https://eduardoboucas.github.io/include-media/documentation/#variable-breakpoints
+$breakpoints: (
+    xs: 320px,
+    sm: 600px,
+    md: 768px,
+    lg: 1024px,
+    xl: 1280px,
+    xxl: 1440px
+);

package/scss/settings/_include-media.scss

@@ -0,0 +1,596 @@
+//
+//  !IMPORTANT: This file is a copy of the original include-media SCSS library
+//  !DO NOT directly edit this file/
+//
+//     _            _           _                           _ _
+//    (_)          | |         | |                         | (_)
+//     _ _ __   ___| |_   _  __| | ___   _ __ ___   ___  __| |_  __ _
+//    | | '_ \ / __| | | | |/ _` |/ _ \ | '_ ` _ \ / _ \/ _` | |/ _` |
+//    | | | | | (__| | |_| | (_| |  __/ | | | | | |  __/ (_| | | (_| |
+//    |_|_| |_|\___|_|\__,_|\__,_|\___| |_| |_| |_|\___|\__,_|_|\__,_|
+//
+//      Simple, elegant and maintainable media queries in Sass
+//                        v2.0.0
+//
+//        https://eduardoboucas.github.io/include-media
+//
+//         Authors: Eduardo Boucas (@eduardoboucas)
+//                  Kitty Giraudel (@kittygiraudel)
+//
+//      This project is licensed under the terms of the MIT license
+@charset "UTF-8";
+
+////
+/// include-media library public configuration
+/// @author Eduardo Boucas
+/// @access public
+////
+@use 'sass:math';
+@use 'sass:map';
+@use 'sass:list';
+@use 'sass:string';
+@use 'sass:meta';
+
+///
+/// Creates a list of global breakpoints
+///
+/// @example scss - Creates a single breakpoint with the label `phone`
+///  $breakpoints: ('phone': 320px);
+///
+$breakpoints: (
+  'phone': 320px,
+  'tablet': 768px,
+  'desktop': 1024px,
+) !default;
+
+///
+/// Creates a list of static expressions or media types
+///
+/// @example scss - Creates a single media type (screen)
+///  $media-expressions: ('screen': 'screen');
+///
+/// @example scss - Creates a static expression with logical disjunction (OR operator)
+///  $media-expressions: (
+///    'retina2x': '(-webkit-min-device-pixel-ratio: 2), (min-resolution: 192dpi)'
+///  );
+///
+$media-expressions: (
+  'screen': 'screen',
+  'print': 'print',
+  'handheld': 'handheld',
+  'landscape': '(orientation: landscape)',
+  'portrait': '(orientation: portrait)',
+  'retina2x':
+    '(-webkit-min-device-pixel-ratio: 2), (min-resolution: 192dpi), (min-resolution: 2dppx)',
+  'retina3x':
+    '(-webkit-min-device-pixel-ratio: 3), (min-resolution: 350dpi), (min-resolution: 3dppx)',
+) !default;
+
+///
+/// Defines a number to be added or subtracted from each unit when declaring breakpoints with exclusive intervals
+///
+/// @example scss - Interval for pixels is defined as `1` by default
+///  @include media('>128px') {}
+///
+///  /* Generates: */
+///  @media (min-width: 129px) {}
+///
+/// @example scss - Interval for ems is defined as `0.01` by default
+///  @include media('>20em') {}
+///
+///  /* Generates: */
+///  @media (min-width: 20.01em) {}
+///
+/// @example scss - Interval for rems is defined as `0.1` by default, to be used with `font-size: 62.5%;`
+///  @include media('>2.0rem') {}
+///
+///  /* Generates: */
+///  @media (min-width: 2.1rem) {}
+///
+$unit-intervals: (
+  'px': 1,
+  'em': 0.01,
+  'rem': 0.1,
+  '': 0,
+) !default;
+
+///
+/// Defines whether support for media queries is available, useful for creating separate stylesheets
+/// for browsers that don't support media queries.
+///
+/// @example scss - Disables support for media queries
+///  $im-media-support: false;
+///  @include media('>=tablet') {
+///    .foo {
+///      color: tomato;
+///    }
+///  }
+///
+///  /* Generates: */
+///  .foo {
+///    color: tomato;
+///  }
+///
+$im-media-support: true !default;
+
+///
+/// Selects which breakpoint to emulate when support for media queries is disabled. Media queries that start at or
+/// intercept the breakpoint will be displayed, any others will be ignored.
+///
+/// @example scss - This media query will show because it intercepts the static breakpoint
+///  $im-media-support: false;
+///  $im-no-media-breakpoint: 'desktop';
+///  @include media('>=tablet') {
+///    .foo {
+///      color: tomato;
+///    }
+///  }
+///
+///  /* Generates: */
+///  .foo {
+///    color: tomato;
+///  }
+///
+/// @example scss - This media query will NOT show because it does not intercept the desktop breakpoint
+///  $im-media-support: false;
+///  $im-no-media-breakpoint: 'tablet';
+///  @include media('>=desktop') {
+///    .foo {
+///      color: tomato;
+///    }
+///  }
+///
+///  /* No output */
+///
+$im-no-media-breakpoint: 'desktop' !default;
+
+///
+/// Selects which media expressions are allowed in an expression for it to be used when media queries
+/// are not supported.
+///
+/// @example scss - This media query will show because it intercepts the static breakpoint and contains only accepted media expressions
+///  $im-media-support: false;
+///  $im-no-media-breakpoint: 'desktop';
+///  $im-no-media-expressions: ('screen');
+///  @include media('>=tablet', 'screen') {
+///    .foo {
+///      color: tomato;
+///    }
+///  }
+///
+///   /* Generates: */
+///   .foo {
+///     color: tomato;
+///   }
+///
+/// @example scss - This media query will NOT show because it intercepts the static breakpoint but contains a media expression that is not accepted
+///  $im-media-support: false;
+///  $im-no-media-breakpoint: 'desktop';
+///  $im-no-media-expressions: ('screen');
+///  @include media('>=tablet', 'retina2x') {
+///    .foo {
+///      color: tomato;
+///    }
+///  }
+///
+///  /* No output */
+///
+$im-no-media-expressions: ('screen', 'portrait', 'landscape') !default;
+
+////
+/// Cross-engine logging engine
+/// @author Kitty Giraudel
+/// @access private
+////
+
+///
+/// Log a message either with `@error` if supported
+/// else with `@warn`, using `feature-exists('at-error')`
+/// to detect support.
+///
+/// @param {String} $message - Message to log
+///
+@function im-log($message) {
+  @if meta.feature-exists('at-error') {
+    @error $message;
+  } @else {
+    @warn $message;
+
+    $_: noop();
+  }
+
+  @return $message;
+}
+
+///
+/// Wrapper mixin for the log function so it can be used with a more friendly
+/// API than `@if im-log('..') {}` or `$_: im-log('..')`. Basically, use the function
+/// within functions because it is not possible to include a mixin in a function
+/// and use the mixin everywhere else because it's much more elegant.
+///
+/// @param {String} $message - Message to log
+///
+@mixin log($message) {
+  @if im-log($message) {
+  }
+}
+
+///
+/// Function with no `@return` called next to `@warn` in Sass 3.3
+/// to trigger a compiling error and stop the process.
+///
+@function noop() {
+}
+
+///
+/// Determines whether a list of conditions is intercepted by the static breakpoint.
+///
+/// @param {Arglist}   $conditions  - Media query conditions
+///
+/// @return {Boolean} - Returns true if the conditions are intercepted by the static breakpoint
+///
+@function im-intercepts-static-breakpoint($conditions...) {
+  $no-media-breakpoint-value: map.get($breakpoints, $im-no-media-breakpoint);
+
+  @if not $no-media-breakpoint-value {
+    @if im-log('`#{$im-no-media-breakpoint}` is not a valid breakpoint.') {
+    }
+  }
+
+  @each $condition in $conditions {
+    @if not map.has-key($media-expressions, $condition) {
+      $operator: get-expression-operator($condition);
+      $prefix: get-expression-prefix($operator);
+      $value: get-expression-value($condition, $operator);
+
+      @if ($prefix == 'max' and $value <= $no-media-breakpoint-value) or
+        ($prefix == 'min' and $value > $no-media-breakpoint-value)
+      {
+        @return false;
+      }
+    } @else if not list.index($im-no-media-expressions, $condition) {
+      @return false;
+    }
+  }
+
+  @return true;
+}
+
+////
+/// Parsing engine
+/// @author Kitty Giraudel
+/// @access private
+////
+
+///
+/// Get operator of an expression
+///
+/// @param {String} $expression - Expression to extract operator from
+///
+/// @return {String} - Any of `>=`, `>`, `<=`, `<`, `≥`, `≤`
+///
+@function get-expression-operator($expression) {
+  @each $operator in ('>=', '>', '<=', '<', '≥', '≤') {
+    @if string.index($expression, $operator) {
+      @return $operator;
+    }
+  }
+
+  // It is not possible to include a mixin inside a function, so we have to
+  // rely on the `im-log(..)` function rather than the `log(..)` mixin. Because
+  // functions cannot be called anywhere in Sass, we need to hack the call in
+  // a dummy variable, such as `$_`. If anybody ever raise a scoping issue with
+  // Sass 3.3, change this line in `@if im-log(..) {}` instead.
+  $_: im-log('No operator found in `#{$expression}`.');
+}
+
+///
+/// Get dimension of an expression, based on a found operator
+///
+/// @param {String} $expression - Expression to extract dimension from
+/// @param {String} $operator - Operator from `$expression`
+///
+/// @return {String} - `width` or `height` (or potentially anything else)
+///
+@function get-expression-dimension($expression, $operator) {
+  $operator-index: string.index($expression, $operator);
+  $parsed-dimension: string.slice($expression, 0, $operator-index - 1);
+  $dimension: 'width';
+
+  @if string.length($parsed-dimension) > 0 {
+    $dimension: $parsed-dimension;
+  }
+
+  @return $dimension;
+}
+
+///
+/// Get dimension prefix based on an operator
+///
+/// @param {String} $operator - Operator
+///
+/// @return {String} - `min` or `max`
+///
+@function get-expression-prefix($operator) {
+  @return if(list.index(('<', '<=', '≤'), $operator), 'max', 'min');
+}
+
+///
+/// Get value of an expression, based on a found operator
+///
+/// @param {String} $expression - Expression to extract value from
+/// @param {String} $operator - Operator from `$expression`
+///
+/// @return {Number} - A numeric value
+///
+@function get-expression-value($expression, $operator) {
+  $operator-index: string.index($expression, $operator);
+  $value: string.slice($expression, $operator-index + string.length($operator));
+
+  @if map.has-key($breakpoints, $value) {
+    $value: map.get($breakpoints, $value);
+  } @else {
+    $value: to-number($value);
+  }
+
+  $interval: map.get($unit-intervals, math.unit($value));
+
+  @if not $interval {
+    // It is not possible to include a mixin inside a function, so we have to
+    // rely on the `im-log(..)` function rather than the `log(..)` mixin. Because
+    // functions cannot be called anywhere in Sass, we need to hack the call in
+    // a dummy variable, such as `$_`. If anybody ever raise a scoping issue with
+    // Sass 3.3, change this line in `@if im-log(..) {}` instead.
+    $_: im-log('Unknown unit `#{math.unit($value)}`.');
+  }
+
+  @if $operator == '>' {
+    $value: $value + $interval;
+  } @else if $operator == '<' {
+    $value: $value - $interval;
+  }
+
+  @return $value;
+}
+
+///
+/// Parse an expression to return a valid media-query expression
+///
+/// @param {String} $expression - Expression to parse
+///
+/// @return {String} - Valid media query
+///
+@function parse-expression($expression) {
+  // If it is part of $media-expressions, it has no operator
+  // then there is no need to go any further, just return the value
+  @if map.has-key($media-expressions, $expression) {
+    @return map.get($media-expressions, $expression);
+  }
+
+  $operator: get-expression-operator($expression);
+  $dimension: get-expression-dimension($expression, $operator);
+  $prefix: get-expression-prefix($operator);
+  $value: get-expression-value($expression, $operator);
+
+  @return '(#{$prefix}-#{$dimension}: #{$value})';
+}
+
+///
+/// Slice `$list` between `$start` and `$end` indexes
+///
+/// @access private
+///
+/// @param {List} $list - List to slice
+/// @param {Number} $start [1] - Start index
+/// @param {Number} $end [length($list)] - End index
+///
+/// @return {List} Sliced list
+///
+@function slice($list, $start: 1, $end: list.length($list)) {
+  @if list.length($list) < 1 or $start > $end {
+    @return ();
+  }
+
+  $result: ();
+
+  @for $i from $start through $end {
+    $result: list.append($result, list.nth($list, $i), comma);
+  }
+
+  @return $result;
+}
+
+////
+/// String to number converter
+/// @author Kitty Giraudel
+/// @access private
+////
+
+///
+/// Casts a string into a number
+///
+/// @param {String | Number} $value - Value to be parsed
+///
+/// @return {Number}
+///
+
+@function to-number($value) {
+  @if meta.type-of($value) == 'number' {
+    @return $value;
+  } @else if meta.type-of($value) != 'string' {
+    $_: im-log('Value for `to-number` should be a number or a string.');
+  }
+
+  $first-character: string.slice($value, 1, 1);
+  $result: 0;
+  $digits: 0;
+  $minus: ($first-character == '-');
+  $numbers: (
+    '0': 0,
+    '1': 1,
+    '2': 2,
+    '3': 3,
+    '4': 4,
+    '5': 5,
+    '6': 6,
+    '7': 7,
+    '8': 8,
+    '9': 9,
+  );
+
+  // Remove +/- sign if present at first character
+  @if $first-character == '+' or $first-character == '-' {
+    $value: string.slice($value, 2);
+  }
+
+  @for $i from 1 through string.length($value) {
+    $character: string.slice($value, $i, $i);
+
+    @if not(list.index(map.keys($numbers), $character) or $character == '.') {
+      @return to-length(if($minus, -$result, $result), string.slice($value, $i));
+    }
+
+    @if $character == '.' {
+      $digits: 1;
+    } @else if $digits == 0 {
+      $result: $result * 10 + map.get($numbers, $character);
+    } @else {
+      $digits: $digits * 10;
+      $result: $result + math.div(map.get($numbers, $character), $digits);
+    }
+  }
+
+  @return if($minus, -$result, $result);
+}
+
+///
+/// Add `$unit` to `$value`
+///
+/// @param {Number} $value - Value to add unit to
+/// @param {String} $unit - String representation of the unit
+///
+/// @return {Number} - `$value` expressed in `$unit`
+///
+@function to-length($value, $unit) {
+  $units: (
+    'px': 1px,
+    'cm': 1cm,
+    'mm': 1mm,
+    '%': 1%,
+    'ch': 1ch,
+    'pc': 1pc,
+    'in': 1in,
+    'em': 1em,
+    'rem': 1rem,
+    'pt': 1pt,
+    'ex': 1ex,
+    'vw': 1vw,
+    'vh': 1vh,
+    'vmin': 1vmin,
+    'vmax': 1vmax,
+  );
+
+  @if not list.index(map.keys($units), $unit) {
+    $_: im-log('Invalid unit `#{$unit}`.');
+  }
+
+  @return $value * map.get($units, $unit);
+}
+
+///
+/// This mixin aims at redefining the configuration just for the scope of
+/// the call. It is helpful when having a component needing an extended
+/// configuration such as custom breakpoints (referred to as tweakpoints)
+/// for instance.
+///
+/// @author Kitty Giraudel
+///
+/// @param {Map} $tweakpoints [()] - Map of tweakpoints to be merged with `$breakpoints`
+/// @param {Map} $tweak-media-expressions [()] - Map of tweaked media expressions to be merged with `$media-expression`
+///
+/// @example scss - Extend the global breakpoints with a tweakpoint
+///  @include media-context(('custom': 678px)) {
+///    .foo {
+///      @include media('>phone', '<=custom') {
+///       // ...
+///      }
+///    }
+///  }
+///
+/// @example scss - Extend the global media expressions with a custom one
+///  @include media-context($tweak-media-expressions: ('all': 'all')) {
+///    .foo {
+///      @include media('all', '>phone') {
+///       // ...
+///      }
+///    }
+///  }
+///
+/// @example scss - Extend both configuration maps
+///  @include media-context(('custom': 678px), ('all': 'all')) {
+///    .foo {
+///      @include media('all', '>phone', '<=custom') {
+///       // ...
+///      }
+///    }
+///  }
+///
+@mixin media-context($tweakpoints: (), $tweak-media-expressions: ()) {
+  // Save global configuration
+  $global-breakpoints: $breakpoints;
+  $global-media-expressions: $media-expressions;
+
+  // Update global configuration
+  $breakpoints: map.merge($breakpoints, $tweakpoints) !global;
+  $media-expressions: map.merge($media-expressions, $tweak-media-expressions) !global;
+
+  @content;
+
+  // Restore global configuration
+  $breakpoints: $global-breakpoints !global;
+  $media-expressions: $global-media-expressions !global;
+}
+
+////
+/// include-media public exposed API
+/// @author Eduardo Boucas
+/// @access public
+////
+
+///
+/// Generates a media query based on a list of conditions
+///
+/// @param {Arglist}   $conditions  - Media query conditions
+///
+/// @example scss - With a single set breakpoint
+///  @include media('>phone') { }
+///
+/// @example scss - With two set breakpoints
+///  @include media('>phone', '<=tablet') { }
+///
+/// @example scss - With custom values
+///  @include media('>=358px', '<850px') { }
+///
+/// @example scss - With set breakpoints with custom values
+///  @include media('>desktop', '<=1350px') { }
+///
+/// @example scss - With a static expression
+///  @include media('retina2x') { }
+///
+/// @example scss - Mixing everything
+///  @include media('>=350px', '<tablet', 'retina3x') { }
+///
+@mixin media($conditions...) {
+  @if ($im-media-support and list.length($conditions) == 0) or
+    (not $im-media-support and im-intercepts-static-breakpoint($conditions...))
+  {
+    @content;
+  } @else if $im-media-support and list.length($conditions) > 0 {
+    @media #{string.unquote(parse-expression(list.nth($conditions, 1)))} {
+      // Recursive call
+      @include media(slice($conditions, 2)...) {
+        @content;
+      }
+    }
+  }
+}

package/scss/settings/_mq.scss

@@ -0,0 +1,6 @@
+@use './breakpoints' as *;
+
+@forward './include-media' with (
+    $breakpoints: $breakpoints,
+    $unit-intervals: $unit-intervals
+); // Cleaner media query declarations – http://include-media.com

package/scss/settings/index.scss

@@ -0,0 +1 @@
+@forward './mq';