Collection of sass abstracts, mixins, globals and utilities. Built for the dart-sass @use module syntax, allowing for full and individual feature usage.
Please Note that from version 0.9.0 the package is fully based on the @use module syntax, if you are looking for the old version using the @import syntax install version 0.8.x, but consider migrating to the 0.9.x standard to avoid missing out on updates.
npm i @squirrel-forge/sass-util
Make use of your IDE's autocompletion, for reference you can find a full list of namespaces below,
or checkout the example implementation and the generated output.
Note that the @use syntax works differently than the classic @import, check the use syntax notes for relevant details and or refer to the official sass docs.
/**
* Using the full library
*/
@use '~@squirrel-forge/sass-util' as util;
/**
* You may use only the modules or submodules you require,
* note that you need to add the 'src' folder to the use path
*/
@use '~@squirrel-forge/sass-util/src/media';
// etc.When using the full package, make use of the namespacing to select from the individual submodules.
@use '~@squirrel-forge/sass-util' as util;
@include util.media-config((
custom-breakpoint: 'screen and (max-width: 10rem)',
));
@include util.media-query('custom-breakpoint') {
// @content
}When using submodules directly, namespacing is shorter, without the parent prefixes, this way you have granular control over which modules to use, but you need to add the src folder path to your @use url.
@use '~@squirrel-forge/sass-util/src/media';
@include media.config((
custom-breakpoint: 'screen and (max-width: 10rem)',
));
@include media.query('custom-breakpoint') {
// @content
}Not recommended, but possible: If you wish to use modules more than once and require configuration changes, then you need to modify the namespaces variables directly, but keep in mind that the values change permanently even for other contexts and need to be reset manually, since modules are only loaded once.
An alphabetical overview of available namespaces, variables, functions and mixins, those marked with a "+" can be loaded individually.
Note when loading individual modules, functions or mixins directly, you must include the src path folder in your use url, also note initial loading order matters when using the with keyword for configuration, see the notes for more details.
Any namespace can be loaded individually, if it contains multiple submodules there is a corresponding index available.
Complete library, the namespace defined when loading the full package with @use.
@use '~@squirrel-forge/sass-util' as util with (
$config-value: 'string',
);Only abstract functions and helpers, none of these contain configuration.
- +config(
$options: null, $defaults: null, $extend: false, $strict: true, $error: 'config::') - Map with defaults with merged options. - +default-args(
$data, $optional...) - A list with arguments and defaults. - +has-query(
$name, $query-marker: '_at_', $error: 'has-query::') - Empty if no query was found. - +is-query(
$name, $query-marker: '_at_') - Query reference or null if not a query - +merge-optional(
$base, $extend: null, $error: 'merge-optional::') - Merged or base map - +spacing(
$params...) - Spacing values list. - +str-initials(
$name, $separator: '-') - First char of each element separated as a joined string. - +str-split(
$string, $separator, $no-empty: true) - Separated list of strings - +strip-unit(
$value) - Unitless value
Supplies button helpers, css definitions, custom styles and properties for usage.
- $class:
'ui-button' - $props:
'ui-button-' - config(
$options) - Only sets config options. - properties(
$extend: null) - Outputs all custom properties in given context. - styles() - Outputs configured button base styles in given context.
- $class:
'ui-button' - $props:
'ui-button-' - config(
$options) - Only sets config options. - properties(
$extend: null) - Outputs all custom properties in given context. - styles() - Outputs configured styled button styles in given context.
- add(
$name, $values) - Adds a button style with given attributes to current context
Generates colors as custom properties including variants, with corresponding helper classes for usage.
- $class:
'ui-color' - $props:
'ui-color-' - $variant-complement:
'comp' - $variant-grayscale:
'gray' - $variant-alpha:
'op' - $variant-invert:
'inv' - $variant-adjust-hue:
'hue' - $variant-darken:
'dk' - $variant-lighten:
'lt' - $variant-saturate:
'sat' - $variant-desaturate:
'dsat' - config(
$colors, $variants, $attributes) - Sets available color references./* Any number of colors using a named map with corresponding css/sass compatible color values */ /* Note that color names/keys must be quoted to avoid logical matching issues with string comparisons */ $colors: ( 'red': #f00, 'green': rgb(0, 255, 0), 'blue': blue, ); /* Variants to generate for colors */ $variants: ( alpha: (.5,.9), invert: (50%,100%), adjust-hue: (30deg,60deg,90deg,120deg,150deg,180deg,210deg,240deg,270deg,300deg,330deg), darken: (20%,50%), lighten: (20%,50%), saturate: (20%,50%), desaturate: (20%,50%,90%), ); /* Class names and corresponding attributes to create */ $attributes: ( text: (color, (base-only)), bg: background-color, bdr: (border-color, (red,blue)), )
- properties() - Outputs all custom properties in given context.
- styles() - Outputs all attribute color classes in given context.
Supplies font styles for injection and styles with corresponding helper classes for usage.
- $class:
'ui-font' - $style-prefix:
'--' - $fluid-attribute:
'fluid' - $no-max-attribute:
'no-max' - config(
$styles) - Sets available style declarations.$styles: ( /** * Simple font declaration */ default: ( font-family: (Oxygen, sans-serif), font-size: 14px, line-height: 1.33, ), /** * Generated helper: * .ui-font--default { * font-family: Oxygen, sans-serif; * font-size: 14px; * line-height: 1.33; * } */ /** * Simple media query based declaration */ default_at_tablet: ( font-size: 16px, ), /** * Generated helper: * @media screen and (min-width: 768px) and (max-width: 1024px) { * .ui-font--default { font-size: 16px; } * } */ /** * Fluid font size declaration without a max */ headline-fluid_at_mobile: ( font-weight: bold, fluid: ( min-vw : 320px, max-vw : 767px, min-size : 20px, max-size : 30px, ), no-max: true, ), /** * Generated helper: * .font--headline-fluid { font-weight: bold; } * @media screen and (max-width: 767px) { * .font--headline-fluid { font-size: 20px; } * } * @media screen and (min-width: 320px) { * .font--headline-fluid { font-size: calc(20px + 10 * ((100vw - 320px) / 447)); } * } */ /** * Fluid font size declaration with a max */ headline-fluid_at_desktop: ( fluid: ( min-vw : 1025px, max-vw : 1366px, min-size : 30px, max-size : 50px, ), ), /** * Generated helper: * @media screen and (min-width: 1025px) { * .font--headline-fluid { font-size: 30px; } * } * @media screen and (min-width: 1025px) { * .font--headline-fluid { font-size: calc(30px + 20 * ((100vw - 1025px) / 341)); } * } * @media screen and (min-width: 1366px) { * .font--headline-fluid { font-size: 50px; } * } */ );
- get(
$style) - Outputs selected font style in given context. - all() - Returns all font styles as map.
- styles() - Outputs configured font styles as helper classes.
Supplies icon helpers, css definitions, images and styles classes and properties for usage.
- $class:
'ui-icon' - $class-interactive:
'ui-interactive' - $class-images:
'--img' - $inline:
'--inline' - $flip:
'--flip-' - $props:
'ui-icon-' - $angles:
(45,90,135,180,225,270,315) - config(
$options) - Only sets config options. - properties(
$extend: null) - Outputs all custom properties in given context. - styles() - Outputs configured icon base styles in given context.
- $class:
'ui-icon' - $class-interactive:
'ui-interactive' - $props:
'ui-icon-' - arrow-config(
$options) - Only sets config options. - arrow-capped-config(
$options) - Only sets config options. - arrow-double-config(
$options) - Only sets config options. - arrow-small-config(
$options) - Only sets config options. - close-config(
$options) - Only sets config options. - fullscreen-config(
$options) - Only sets config options. - important-config(
$options) - Only sets config options. - info-config(
$options) - Only sets config options. - minimize-config(
$options) - Only sets config options. - pause-config(
$options) - Only sets config options. - play-config(
$options) - Only sets config options. - replay-config(
$options) - Only sets config options. - sound-config(
$options) - Only sets config options. - sound-muted-config(
$options) - Only sets config options. - sound-none-config(
$options) - Only sets config options. - sound-on-config(
$options) - Only sets config options. - stop-config(
$options) - Only sets config options. - unknown-config(
$options) - Only sets config options. - user-config(
$options) - Only sets config options. - properties() - Outputs all custom properties in given context.
- styles() - Outputs configured css icon styles as helper classes.
- $class:
'ui-icon' - $class-images:
'--img' - $props:
'ui-icon-image-' - config(
$options) - Sets available image icons. - properties() - Outputs all custom properties in given context.
- styles() - Outputs configured image icon styles as helper classes.
Supplies asset helpers and decal styles and helper classes and properties for usage.
- $base:
'../img/' - $cache:
'' - get(
$asset) - Asset url.
- $class:
'ui-decals' - $static:
'--static' - $props:
'ui-decals-' - $width:
0 - $sizing-as-props:
false - config(
$decals) - Sets available decals declarations.$decals: ( example: ( /* One of, before or after, must be set true */ before: true, after: true, /* Dimensions must be defined and larger than zero */ width: 1, height: 1, /* Gets passed through assets.get() */ url: 'example.jpg' ), );
- properties() - Outputs all custom properties in given context.
- styles() - Outputs configured decal styles as helper classes.
Supplies list normalization and customizable styles with corresponding helper classes for usage.
- $prop:
'data-counter' - $counter:
'ui-ol-counter' - $style:
decimal - $suffix:
'.' - $space:
'\00a0' - $styles:
(decimal, decimal-leading-zero, lower-roman, lower-alpha, upper-alpha, lower-latin) - $custom:
() - styles() - Outputs configured component styles.
- $class:
'ui-list' - $props:
'ui-list-' - config(
$options) - Only sets config options$options: ( /** * List wrapper margin * @type {margin} 1-4 margin values */ margin: 1rem 0, /** * List wrapper padding * @type {padding} 1-3 padding values */ padding: 0 0 0, /** * List wrapper left indent/padding * @type {number} number with unit */ indent-width: 2rem, /** * List item margin * @type {margin} 1-4 margin values */ item-margin: 0, /** * List item after item margin * @type {margin} 1-4 margin values */ item-after-margin: 1rem 0 0, );
- properties(
$extend: null) - Adds components custom properties in current scope - styles() - Outputs configured component styles
Supplies a media query helper mixin and configuration.
- config(
$queries) - Only sets or updates media query references.$queries: ( custom-breakpoint: 'screen and (max-width: 10rem)', );
- query(
$query) - Wraps given content styles in a media query.
Only mixins and helpers that produce output, none of these contain configuration.
- +attr-isset(
$attribute: 'class', $empty: false, $error: 'attr-isset::') - Wraps given content styles to apply only if the current scope element has the given attribute. - +attr-none(
$attribute: 'class', $empty: true, $error: 'attr-none::') - Wraps given content styles to apply only if the current scope element does not have the given attribute or its empty. - +attr-set(
$attributes, $error: 'attr-set::') - Adds the given attributes in current scope. - +attr-set-map(
$name, $source, $error: 'attr-set-map::') - Adds the given attributes in current scope. - +bem-style(
$nested, $font-styles: null, $query-marker: '_at_', $error: 'bem-style::') - Creates BEM style structures from a map definition. - +break-pseudo
- break-before() - Inserts a pseudo before with a break.
- break-after() - Inserts a pseudo after with a break.
- +clear-pseudo
- clear-before() - Inserts a pseudo before with a clear both.
- clear-after() - Inserts a pseudo after with a clear both.
- +font-fluid(
$style, $styles: null, $base-query: null, $fluid-attribute: 'fluid', $no-max-attribute: 'no-max', $error: 'font-fluid::') - Adds the given font attributes and media queries in current scope. - +font-fluid-base(
$min-vw, $max-vw, $min-font-size, $max-font-size, $base-query: null, $no-max: false, $error: 'font-fluid-base::') - Adds the given font media queries in current scope, with an optional base query. - +hide-accessible() - Inserts attributes to hide the current scope visually only.
- +no-select() - Inserts attributes to prevent text selection.
- +properties(
$props, $prefix: '', $query-marker: '_at_', $error: 'properties::') - Adds given custom properties in current scope. - +wordbreak() - Adds word break properties in current scope.
Supplies a basic reset stylesheet, has no configuration options.
- styles() - Outputs reset styles.
Supplies text accessibility, alignment, break helpers and some normalization.
- $class:
'ui-text' - $hide-a11y:
'--hide-a11y' - $no-select:
'--no-select' - styles() - Outputs configured accessibility helpers.
- $class:
'ui-text' - $center:
'--center' - $center-queries:
(mobile, mobile-tablet-portrait, tablet-portrait, tablet-landscape, tablet, tablet-desktop, tablet-landscape-desktop, desktop, desktop-medium) - $right:
'--right' - $right-queries:
(mobile, mobile-tablet-portrait, tablet-portrait, tablet-landscape, tablet, tablet-desktop, tablet-landscape-desktop, desktop, desktop-medium) - $left:
'--left' - $left-queries:
(mobile, mobile-tablet-portrait, tablet-portrait, tablet-landscape, tablet, tablet-desktop, tablet-landscape-desktop, desktop, desktop-medium) - styles() - Outputs configured alignment helper styles.
- $class:
'ui-text' - $break:
'--break' - $clear:
'--clear' - $always:
'--break-always' - $none:
'--no-wrap' - $word:
'--wbreak' - $word-queries:
(mobile, mobile-tablet-portrait, tablet-portrait, tablet-landscape, tablet, tablet-desktop, tablet-landscape-desktop, desktop, desktop-medium) - $global:
false - $element-class:
'ui-break--' - $element-wrap-class:
'ui-break-wrap' - $queries:
(mobile, mobile-tablet-portrait, tablet-portrait, tablet-landscape, tablet, tablet-desktop, tablet-landscape-desktop, desktop, desktop-medium) - styles() - Outputs configured break helper styles.
- $props:
'ui-text-normalize-' - config(
$options) - Only sets config options.$options: ( /** * Headline margin * @type {margin} full margin value */ headline-margin: 1rem 0, /** * Paragraph margin * @type {margin} full margin value */ paragraph-margin: 1rem 0, /** * Mobile text size adjust * @type {number} percent number */ size-adjust: 100%, );
- properties(
$extend: null) - Adds components custom properties in current scope. - styles() - Outputs configured component styles.
Provides a simple wrapping helper system.
- $class:
'ui-wrap' - $no-flex:
'--no-flex' - config(
$options) - Only sets config options.$options: ( /* BEM mixin style declarations */ );
- styles() - Outputs configured component styles.
Following some notes on sass behaviours directly relevant to using the library and modules.
With any modules that allow extending, config mixins can be reset the maps index to an empty list by passing an explicit null value, as following:
/* Clear all previously defined decals */
@include util.images-decals-config(null);
/* Add a new data set */
@include util.images-decals-config((
example: (
before: true,
after: true,
width: 1,
height: 1,
url: 'example.jpg'
),
));When loading via the @use syntax versus the classic @import, there are a few things to keep in mind. Using the with keyword to set any configuration variables can only be done the first time a module is loaded with @use, any attempt to do it differently will produce an error.
If you wish to change configuration variables in specific situations, note that anything that module will do afterwards will use the new value even when loaded in a different context within the same compile tree.
You can set values from the given use context as following:
@use '~@squirrel-forge/sass-util' as util with (
$images-decals-props: 'decal-',
);
/* This renders the initial configration */
:root { @include util.images-decals-properties; }
/* Then we change a config value and the output changes */
util.$images-decals-props: 'foo-';
.context { @include util.images-decals-properties; }
/* If we use this module again later or in another file loaded after the above code, */
/* then we need to reset the value if we want the initial setting */
util.$images-decals-props: 'decal-';Inside map declarations to use comma or space separated, list values, wrap them in braces to make them an explicit list value, for example for font-family declarations:
$map: (
key: (
font-family: ("Oxygen", sans-serif),
),
);Or you can escape the value as following:
$map: (
key: (
font-family: #{"Oxygen", sans-serif},
),
);Check the sourcecode on github for extensive comments.