UNPKG

@squirrel-forge/sass-util

Version:

sass abstracts, mixins, globals and utilities

2,641 lines 246 kB
/** * @squirrel-forge/build-scss@0.8.3 * Root render template * Set $env: development * Set $production: false * Import: ./util.scss; */ /** * Global reset * A set of basic global reset styles. */ /** * Generate reset styles * @public * @output Outputs reset styles */ /** * Requires */ /** * Merge config options * @public * @param {map} $options - Input options map * @param {map} $defaults - Default options map * @param {boolean} $extend - Allow config extension * @param {boolean} $strict - Throws an error with unknown option names * @param {string} $error - Error message prefix * @return {map} - Map with defaults with merged options */ /** * Media queries * Helper mixin and configuration. */ /** * Requires */ /** * Query defaults * @private * @type {map} */ /** * Update/extend media queries * @public * @param {map} $queries - Map of media queries * @output {void} - Only sets or updates media query references */ /** * Media query wrapper * @public * @param {string} query - Media name reference * @output Wraps given content styles in a media query */ /** * Requires */ /** * Get missing default arguments * @param {*} $data - Arguments, value or list * @param {*} $optional - Any number of optional argument defaults * @return {list} - A list with arguments and defaults */ /** * Requires */ /** * Split string * Thanks to dayenite and Tofandel, please refer to: * https://stackoverflow.com/questions/32376461/how-to-split-a-string-into-two-lists-of-numbers-in-sass#42295154 * @param {string} $string - String to split * @param {string} $separator - Separator to split by * @param {boolean} $no-empty - Set false to return empty parts, default: true * @return {list} - Separated list of strings */ /** * Requires */ /** * Get name and query from string * @param {string} $name - String to parse * @param {string} $query-marker - String that marks the split point, default: '_at_' * @param {string} $error - Error message prefix * @return {list} - Empty if no query was found */ /** * Requires */ /** * Checks if given string is a query reference * @param {string} $name - String to parse * @param {string} $query-marker - String marking the beginning of a query, default: '_at_' * @return {string|null} - Query reference or null if not a query */ /** * Requires */ /** * Optionally merges two maps * @param {map} $base - Base map to merge into * @param {null|false|map} $extend - Optional extension map * @return {map} - Merged or base map */ /** * Requires */ /** * Convert px to rem * @param {number} $px - Pixel value to convert * @param {number} $base - Pixel to rem ratio * @return {CSSValue} - Size as rem value */ /** * Requires */ /** * Generate spacing values with a base * @param {string|number} $base - Base size including unit or variable * @param {number} $spaces - 1-4 values, unitless used for multiplication * @return {list} - Spacing values list */ /** * Requires */ /** * Returns joined initials of a separated string * @param {string} $name - String to parse * @param {string} $separator - Separator string * @return {string} - First char of each element separated as a joined string */ /** * Requires */ /** * Strip unit from value * @param {*} $value - Unit value * @return {*} - Unitless value */ /** * Abstracts * functions forwarding index */ /** * Requires */ /** * Select current scope only if given attribute is not set or optionally empty * @param {string} $attribute - Attribute name * @param {boolean} $empty - Include empty attribute * @param {string} $error - Error message prefix * @output Wraps given content styles to apply only if the current scope element does not have the given attribute or its empty */ /** * Requires */ /** * Select current scope only if a given attribute is set * @param {string} $attribute - Attribute name, default: 'class' * @param {boolean} $empty - Allow empty attribute * @param {string} $error - Error message prefix * @output Wraps given content styles to apply only if the current scope element has the given attribute */ /** * Requires */ /** * Attributes setter * @param {Map} $source - Map of attributes * @param {string} $error - Error message prefix * @output Adds the given attributes in current scope */ /** * Requires */ /** * Attributes from map setter * @param {string} $name - Name of attribute group * @param {Map} $source - Map of attribute groups to use * @param {string} $error - Error message prefix * @output Adds the given attributes in current scope */ /** * Requires */ /** * Fluid style basic setter * Creates a fluid font style between a min and max * @param {size[unit]} $min-vw - Min query width value * @param {size[unit]} $max-vw - Max query width value * @param {size[unit]} $min-font-size - Min font size * @param {size[unit]} $max-font-size - Max font size * @param {null|string} $base-query - Optional name for an @mixin mx-media(name), default: null * @param {boolean} $no-max - Do not define max query, default: null * @param {string} $error - Error message prefix * @output Adds the given font media queries in current scope, with an optional base query */ /** * Requires */ /** * Fluid font style setter * Adds the given font style attributes and fluid style in current scope * @param {string} $style - Name of font style * @param {Map} $styles - Map of font styles to use, default: $font-styles * @param {string} $base-query - Optional name for an @mixin media.query(name), default: null * @param {string} $fluid-attribute - Name of attribute to read fluid properties from, default: 'fluid' * @param {string} $no-max-attribute - Name of attribute to for no-max argument, default: 'no-max' * @output Adds the given font attributes and media queries in current scope */ /** * Requires */ /** * Simple BEM creator * @param {map} $nested - BEM map * @param {string} $query-marker - String that marks the split point, default: '_at_' * @param {string} $error - Error message prefix * @output Creates BEM style structures from a map definition */ /** * Insert a line break before content * @output Inserts a pseudo before with a break */ /** * Insert a line break after content * @output Inserts a pseudo after with a break */ /** * Clear both before * @output Inserts a pseudo before with a clear both */ /** * Clear both after * @output Inserts a pseudo after with a clear both */ /** * Hide an element * but leave it accessible to screen readers * Reliable across most browsers * @output Inserts attributes to hide the current scope visually only */ /** * Prevent text selection * Works across most browsers * @output Inserts attributes to prevent text selection */ /** * Requires */ /** * Generate custom properties with optional query wrapping * @public * @param {map} $props - Map of properties * @param {string} $prefix - Property prefix * @param {string} $query-marker - String marking the beginning of a query, default: '_at_' * @param {string} $error - Error message prefix * @output Adds given custom properties in current scope */ /** * Allow for language base automatic word breaking * Works across most browsers * @output Inserts attributes to allow word breaking */ /** * Mixins * mixins forwarding index */ /** * ui-colors * Custom properties and styles with configuration. */ /** * Requires */ /** * Component css class * @protected * @type {string} css class */ /** * Component property prefix * @protected * @type {string} property name */ /** * Component property suffix * @protected * @type {string} variant suffix */ /** * Color defaults * @private * @type {map} */ /** * Color style attributes * @private * @type {map} */ /** * Color variants * @private * @type {map} */ /** * Internal generated names * @private * @type {list} */ /** * Update colors and variants index * @public * @param {map} $colors - Map of colors * @param {map} $variants - Map of variants * @param {map} $attributes - Map of attributes * @output {void} - Sets available color references */ /** * Generate required custom properties * @public * @output Outputs all custom properties in given context */ /** * Generate component styles * @public * @output Outputs configured component styles */ /** * Columns style generation * Custom properties and styles with configuration. */ /** * Requires */ /** * Component css class * @protected * @type {string} css class */ /** * Component property prefix * @protected * @type {string} property name */ /** * Config defaults * @private * @type {map} */ /** * Update component config options * @public * @param {map} $options - Map of config options * @output {void} - Only sets config options */ /** * Generate required custom properties * @public * @param {null|map} $extend - Extend properties for output only * @output Adds components custom properties in current scope */ /** * Generate columns styles * @public * @output Outputs configured spacing styles in given context */ /** * ui-fluid images component * Custom properties and styles with configuration */ /** * Requires */ /** * Component css class * @protected * @type {string} css class */ /** * Text block css class * @protected * @type {string} css class */ /** * Component property prefix * @protected * @type {string} property name */ /** * Config defaults * @private * @type {map} */ /** * Update component config options * @public * @param {map} $options - Map of config options * @output {void} - Only sets config options */ /** * Generate required custom properties * @public * @param {null|map} $extend - Extend properties for output only * @output Adds components custom properties in current scope */ /** * Generate button core styles * @public * @output Outputs configured button base styles in given context */ /** * ui-assets * Function with configuration. */ /** * Asset base path * @protected * @type {string} url path */ /** * Asset cache breaker * @protected * @type {string} url suffix */ /** * Get asset url * @param {string} $asset - Relative asset path * @param {string} $check4 - Match first 4 chars to return as url * @param {string} $check3 - Match first 3 chars to return as url * @return {url} - Asset url */ /** * ui-decals * Custom properties and styles with configuration. */ /** * Requires */ /** * Component css class * @protected * @type {string} css class */ /** * Component static css suffix * @protected * @type {string} css class suffix */ /** * Component property prefix * @protected * @type {string} property name */ /** * Decals default width * @protected * @type {number} width value */ /** * Use sizing via width and height property * @protected * @type {boolean} size via custom properties */ /** * @typedef {map} Decal - Defines a decal, one before or after key must be set true * @key {undefined|boolean} before - Render before pseudo * @key {undefined|boolean} after - Render after pseudo * @key {number} width - Number unitless * @key {number} height - Number unitless * @key {string} url - Asset name */ /** * Decals definitions * @private * @type {map<string, Decal>} */ /** * Update component config options * @public * @param {map} $decals - Map of decal definitions * @output {void} - Sets available decals declarations */ /** * Generate required custom properties * @public * @output Outputs all custom properties in given context */ /** * Generate base styles * @public * @output Outputs configured decal styles as helper classes */ /** * Images * Submodule forwarding index */ /** * Icons core * Custom properties and styles with configuration */ /** * Requires */ /** * Component css class * @protected * @type {string} css class */ /** * Component parent interactive css class * @protected * @type {string} css class */ /** * Component class variant suffix * @protected * @type {string} class suffix */ /** * Component class variant suffix * @protected * @type {string} class suffix */ /** * Component class variant suffix * @protected * @type {string} class suffix */ /** * Component class variant suffix * @protected * @type {string} class suffix */ /** * Component property prefix * @protected * @type {string} property name */ /** * Angles/rotation helper variants * @protected * @type {list<deg>} list of unitless degrees */ /** * Config defaults * @private * @type {map} */ /** * Update component config options * @public * @param {map} $options - Map of config options * @output {void} - Only sets config options */ /** * Generate required custom properties * @public * @param {null|map} $extend - Extend properties for output only * @output Adds components custom properties in current scope */ /** * Generate icon core styles * @public * @output Outputs configured icon base styles in given context */ /** * Icon acorn * Custom properties and styles with configuration */ /** * Requires */ /** * Component css class * @protected * @type {string} css class */ /** * Component property prefix * @protected * @type {string} property name */ /** * Config defaults * @private * @type {map} */ /** * Update component config options * @public * @param {map} $options - Map of config options * @output {void} - Only sets config options */ /** * Generate required custom properties * @public * @output Adds components custom properties in current scope */ /** * Generate icon styles * @public * @output Outputs configured icon styles in given context */ /** * Icon action * Custom properties and styles with configuration */ /** * Requires */ /** * Component css class * @protected * @type {string} css class */ /** * Component property prefix * @protected * @type {string} property name */ /** * Config defaults * @private * @type {map} */ /** * Update component config options * @public * @param {map} $options - Map of config options * @output {void} - Only sets config options */ /** * Generate required custom properties * @public * @output Adds components custom properties in current scope */ /** * Generate icon styles * @public * @output Outputs configured icon styles in given context */ /** * Icon add * Custom properties and styles with configuration */ /** * Requires */ /** * Component css class * @protected * @type {string} css class */ /** * Component property prefix * @protected * @type {string} property name */ /** * Config defaults * @private * @type {map} */ /** * Update component config options * @public * @param {map} $options - Map of config options * @output {void} - Only sets config options */ /** * Generate required custom properties * @public * @output Adds components custom properties in current scope */ /** * Generate icon styles * @public * @output Outputs configured icon styles in given context */ /** * Icon * * Custom properties and styles with configuration */ /** * Requires */ /** * Component css class * @protected * @type {string} css class */ /** * Component property prefix * @protected * @type {string} property name */ /** * Config defaults * @private * @type {map} */ /** * Update component config options * @public * @param {map} $options - Map of config options * @output {void} - Only sets config options */ /** * Generate required custom properties * @public * @output Adds components custom properties in current scope */ /** * Generate icon styles * @public * @output Outputs configured icon styles in given context */ /** * Icon arrow-capped * Custom properties and styles with configuration */ /** * Requires */ /** * Component css class * @protected * @type {string} css class */ /** * Component property prefix * @protected * @type {string} property name */ /** * Config defaults * @private * @type {map} */ /** * Update component config options * @public * @param {map} $options - Map of config options * @output {void} - Only sets config options */ /** * Generate required custom properties * @public * @output Adds components custom properties in current scope */ /** * Generate icon styles * @public * @output Outputs configured icon styles in given context */ /** * Icon arrow-double * Custom properties and styles with configuration */ /** * Requires */ /** * Component css class * @protected * @type {string} css class */ /** * Component property prefix * @protected * @type {string} property name */ /** * Config defaults * @private * @type {map} */ /** * Update component config options * @public * @param {map} $options - Map of config options * @output {void} - Only sets config options */ /** * Generate required custom properties * @public * @output Adds components custom properties in current scope */ /** * Generate icon styles * @public * @output Outputs configured icon styles in given context */ /** * Icon arrow-simple * Custom properties and styles with configuration */ /** * Requires */ /** * Component css class * @protected * @type {string} css class */ /** * Component property prefix * @protected * @type {string} property name */ /** * Config defaults * @private * @type {map} */ /** * Update component config options * @public * @param {map} $options - Map of config options * @output {void} - Only sets config options */ /** * Generate required custom properties * @public * @output Adds components custom properties in current scope */ /** * Generate icon styles * @public * @output Outputs configured icon styles in given context */ /** * Icon arrow-small * Custom properties and styles with configuration */ /** * Requires */ /** * Component css class * @protected * @type {string} css class */ /** * Component property prefix * @protected * @type {string} property name */ /** * Config defaults * @private * @type {map} */ /** * Update component config options * @public * @param {map} $options - Map of config options * @output {void} - Only sets config options */ /** * Generate required custom properties * @public * @output Adds components custom properties in current scope */ /** * Generate icon styles * @public * @output Outputs configured icon styles in given context */ /** * Icon check * Custom properties and styles with configuration */ /** * Requires */ /** * Component css class * @protected * @type {string} css class */ /** * Component property prefix * @protected * @type {string} property name */ /** * Config defaults * @private * @type {map} */ /** * Update component config options * @public * @param {map} $options - Map of config options * @output {void} - Only sets config options */ /** * Generate required custom properties * @public * @output Adds components custom properties in current scope */ /** * Generate icon styles * @public * @output Outputs configured icon styles in given context */ /** * Icon close * Custom properties and styles with configuration */ /** * Requires */ /** * Component css class * @protected * @type {string} css class */ /** * Component property prefix * @protected * @type {string} property name */ /** * Config defaults * @private * @type {map} */ /** * Update component config options * @public * @param {map} $options - Map of config options * @output {void} - Only sets config options */ /** * Generate required custom properties * @public * @output Adds components custom properties in current scope */ /** * Generate icon styles * @public * @output Outputs configured icon styles in given context */ /** * Icon close-small * Custom properties and styles with configuration */ /** * Requires */ /** * Component css class * @protected * @type {string} css class */ /** * Component property prefix * @protected * @type {string} property name */ /** * Config defaults * @private * @type {map} */ /** * Update component config options * @public * @param {map} $options - Map of config options * @output {void} - Only sets config options */ /** * Generate required custom properties * @public * @output Adds components custom properties in current scope */ /** * Generate icon styles * @public * @output Outputs configured icon styles in given context */ /** * Icon download * Custom properties and styles with configuration */ /** * Requires */ /** * Component css class * @protected * @type {string} css class */ /** * Component property prefix * @protected * @type {string} property name */ /** * Config defaults * @private * @type {map} */ /** * Update component config options * @public * @param {map} $options - Map of config options * @output {void} - Only sets config options */ /** * Generate required custom properties * @public * @output Adds components custom properties in current scope */ /** * Generate icon styles * @public * @output Outputs configured icon styles in given context */ /** * Icon fastforward * Custom properties and styles with configuration */ /** * Requires */ /** * Component css class * @protected * @type {string} css class */ /** * Component property prefix * @protected * @type {string} property name */ /** * Config defaults * @private * @type {map} */ /** * Update component config options * @public * @param {map} $options - Map of config options * @output {void} - Only sets config options */ /** * Generate required custom properties * @public * @output Adds components custom properties in current scope */ /** * Generate icon styles * @public * @output Outputs configured icon styles in given context */ /** * Icon font * Custom properties and styles with configuration */ /** * Requires */ /** * Component css class * @protected * @type {string} css class */ /** * Component parent interactive css class * @protected * @type {string} css class */ /** * Component property prefix * @protected * @type {string} property name */ /** * Config defaults * @private * @type {map} */ /** * Update component config options * @public * @param {map} $options - Map of config options * @output {void} - Only sets config options */ /** * Generate required custom properties * @public * @output Adds components custom properties in current scope */ /** * Generate icon styles * @public * @output Outputs configured icon styles in given context */ /** * Icon fullscreen * Custom properties and styles with configuration */ /** * Requires */ /** * Component css class * @protected * @type {string} css class */ /** * Component parent interactive css class * @protected * @type {string} css class */ /** * Component property prefix * @protected * @type {string} property name */ /** * Config defaults * @private * @type {map} */ /** * Update component config options * @public * @param {map} $options - Map of config options * @output {void} - Only sets config options */ /** * Generate required custom properties * @public * @output Adds components custom properties in current scope */ /** * Generate icon styles * @public * @output Outputs configured icon styles in given context */ /** * Icon github * Custom properties and styles with configuration */ /** * Requires */ /** * Component css class * @protected * @type {string} css class */ /** * Component property prefix * @protected * @type {string} property name */ /** * Config defaults * @private * @type {map} */ /** * Generate required custom properties * @public * @output Adds components custom properties in current scope */ /** * Generate icon styles * @public * @output Outputs configured icon styles in given context */ /** * Icon important * Custom properties and styles with configuration */ /** * Requires */ /** * Component css class * @protected * @type {string} css class */ /** * Component property prefix * @protected * @type {string} property name */ /** * Config defaults * @private * @type {map} */ /** * Update component config options * @public * @param {map} $options - Map of config options * @output {void} - Only sets config options */ /** * Generate required custom properties * @public * @output Adds components custom properties in current scope */ /** * Generate icon styles * @public * @output Outputs configured icon styles in given context */ /** * Icon info * Custom properties and styles with configuration */ /** * Requires */ /** * Component css class * @protected * @type {string} css class */ /** * Component property prefix * @protected * @type {string} property name */ /** * Config defaults * @private * @type {map} */ /** * Update component config options * @public * @param {map} $options - Map of config options * @output {void} - Only sets config options */ /** * Generate required custom properties * @public * @output Adds components custom properties in current scope */ /** * Generate icon styles * @public * @output Outputs configured icon styles in given context */ /** * Icon menu * Custom properties and styles with configuration */ /** * Requires */ /** * Component css class * @protected * @type {string} css class */ /** * Component property prefix * @protected * @type {string} property name */ /** * Config defaults * @private * @type {map} */ /** * Update component config options * @public * @param {map} $options - Map of config options * @output {void} - Only sets config options */ /** * Generate required custom properties * @public * @output Adds components custom properties in current scope */ /** * Generate icon styles * @public * @output Outputs configured icon styles in given context */ /** * Icon minimize * Custom properties and styles with configuration */ /** * Requires */ /** * Component css class * @protected * @type {string} css class */ /** * Component parent interactive css class * @protected * @type {string} css class */ /** * Component property prefix * @protected * @type {string} property name */ /** * Config defaults * @private * @type {map} */ /** * Update component config options * @public * @param {map} $options - Map of config options * @output {void} - Only sets config options */ /** * Generate required custom properties * @public * @output Adds components custom properties in current scope */ /** * Generate icon styles * @public * @output Outputs configured icon styles in given context */ /** * Icon npm * Custom properties and styles with configuration */ /** * Requires */ /** * Component css class * @protected * @type {string} css class */ /** * Component property prefix * @protected * @type {string} property name */ /** * Config defaults * @private * @type {map} */ /** * Generate required custom properties * @public * @output Adds components custom properties in current scope */ /** * Generate icon styles * @public * @output Outputs configured icon styles in given context */ /** * Icon pause * Custom properties and styles with configuration */ /** * Requires */ /** * Component css class * @protected * @type {string} css class */ /** * Component property prefix * @protected * @type {string} property name */ /** * Config defaults * @private * @type {map} */ /** * Update component config options * @public * @param {map} $options - Map of config options * @output {void} - Only sets config options */ /** * Generate required custom properties * @public * @output Adds components custom properties in current scope */ /** * Generate icon styles * @public * @output Outputs configured icon styles in given context */ /** * Icon play * Custom properties and styles with configuration */ /** * Requires */ /** * Component css class * @protected * @type {string} css class */ /** * Component property prefix * @protected * @type {string} property name */ /** * Config defaults * @private * @type {map} */ /** * Update component config options * @public * @param {map} $options - Map of config options * @output {void} - Only sets config options */ /** * Generate required custom properties * @public * @output Adds components custom properties in current scope */ /** * Generate icon styles * @public * @output Outputs configured icon styles in given context */ /** * Icon redo * Custom properties and styles with configuration */ /** * Requires */ /** * Component css class * @protected * @type {string} css class */ /** * Component property prefix * @protected * @type {string} property name */ /** * Config defaults * @private * @type {map} */ /** * Update component config options * @public * @param {map} $options - Map of config options * @output {void} - Only sets config options */ /** * Generate required custom properties * @public * @output Adds components custom properties in current scope */ /** * Generate icon styles * @public * @output Outputs configured icon styles in given context */ /** * Icon remove * Custom properties and styles with configuration */ /** * Requires */ /** * Component css class * @protected * @type {string} css class */ /** * Component property prefix * @protected * @type {string} property name */ /** * Config defaults * @private * @type {map} */ /** * Update component config options * @public * @param {map} $options - Map of config options * @output {void} - Only sets config options */ /** * Generate required custom properties * @public * @output Adds components custom properties in current scope */ /** * Generate icon styles * @public * @output Outputs configured icon styles in given context */ /** * Icon replay * Custom properties and styles with configuration */ /** * Requires */ /** * Component css class * @protected * @type {string} css class */ /** * Component property prefix * @protected * @type {string} property name */ /** * Config defaults * @private * @type {map} */ /** * Update component config options * @public * @param {map} $options - Map of config options * @output {void} - Only sets config options */ /** * Generate required custom properties * @public * @output Adds components custom properties in current scope */ /** * Generate icon styles * @public * @output Outputs configured icon styles in given context */ /** * Icon save * Custom properties and styles with configuration */ /** * Requires */ /** * Component css class * @protected * @type {string} css class */ /** * Component property prefix * @protected * @type {string} property name */ /** * Config defaults * @private * @type {map} */ /** * Update component config options * @public * @param {map} $options - Map of config options * @output {void} - Only sets config options */ /** * Generate required custom properties * @public * @output Adds components custom properties in current scope */ /** * Generate icon styles * @public * @output Outputs configured icon styles in given context */ /** * Icon settings * Custom properties and styles with configuration */ /** * Requires */ /** * Component css class * @protected * @type {string} css class */ /** * Component property prefix * @protected * @type {string} property name */ /** * Config defaults * @private * @type {map} */ /** * Update component config options * @public * @param {map} $options - Map of config options * @output {void} - Only sets config options */ /** * Generate required custom properties * @public * @output Adds components custom properties in current scope */ /** * Generate icon styles * @public * @output Outputs configured icon styles in given context */ /** * Icon siux * Custom properties and styles with configuration */ /** * Requires */ /** * Component css class * @protected * @type {string} css class */ /** * Component property prefix * @protected * @type {string} property name */ /** * Config defaults * @private * @type {map} */ /** * Generate required custom properties * @public * @output Adds components custom properties in current scope */ /** * Generate icon styles * @public * @output Outputs configured icon styles in given context */ /** * Icon sound * Custom properties and styles with configuration */ /** * Requires */ /** * Component css class * @protected * @type {string} css class */ /** * Component property prefix * @protected * @type {string} property name */ /** * Config defaults * @private * @type {map} */ /** * Update component config options * @public * @param {map} $options - Map of config options * @output {void} - Only sets config options */ /** * Generate required custom properties * @public * @output Adds components custom properties in current scope */ /** * Generate icon styles * @public * @output Outputs configured icon styles in given context */ /** * Stats info * Custom properties and styles with configuration */ /** * Requires */ /** * Component css class * @protected * @type {string} css class */ /** * Component property prefix * @protected * @type {string} property name */ /** * Config defaults * @private * @type {map} */ /** * Update component config options * @public * @param {map} $options - Map of config options * @output {void} - Only sets config options */ /** * Generate required custom properties * @public * @output Adds components custom properties in current scope */ /** * Generate icon styles * @public * @output Outputs configured icon styles in given context */ /** * Icon stop * Custom properties and styles with configuration */ /** * Requires */ /** * Component css class * @protected * @type {string} css class */ /** * Component property prefix * @protected * @type {string} property name */ /** * Config defaults * @private * @type {map} */ /** * Update component config options * @public * @param {map} $options - Map of config options * @output {void} - Only sets config options */ /** * Generate required custom properties * @public * @output Adds components custom properties in current scope */ /** * Generate icon styles * @public * @output Outputs configured icon styles in given context */ /** * Icon trash * Custom properties and styles with configuration */ /** * Requires */ /** * Component css class * @protected * @type {string} css class */ /** * Component property prefix * @protected * @type {string} property name */ /** * Config defaults * @private * @type {map} */ /** * Update component config options * @public * @param {map} $options - Map of config options * @output {void} - Only sets config options */ /** * Generate required custom properties * @public * @output Adds components custom properties in current scope */ /** * Generate icon styles * @public * @output Outputs configured icon styles in given context */ /** * Icon undo * Custom properties and styles with configuration */ /** * Requires */ /** * Component css class * @protected * @type {string} css class */ /** * Component property prefix * @protected * @type {string} property name */ /** * Config defaults * @private * @type {map} */ /** * Update component config options * @public * @param {map} $options - Map of config options * @output {void} - Only sets config options */ /** * Generate required custom properties * @public * @output Adds components custom properties in current scope */ /** * Generate icon styles * @public * @output Outputs configured icon styles in given context */ /** * Icon unknown * Custom properties and styles with configuration */ /** * Requires */ /** * Component css class * @protected * @type {string} css class */ /** * Component property prefix * @protected * @type {string} property name */ /** * Config defaults * @private * @type {map} */ /** * Update component config options * @public * @param {map} $options - Map of config options * @output {void} - Only sets config options */ /** * Generate required custom properties * @public * @output Adds components custom properties in current scope */ /** * Generate icon styles * @public * @output Outputs configured icon styles in given context */ /** * Icon update * Custom properties and styles with configuration */ /** * Requires */ /** * Component css class * @protected * @type {string} css class */ /** * Component property prefix * @protected * @type {string} property name */ /** * Config defaults * @private * @type {map} */ /** * Update component config options * @public * @param {map} $options - Map of config options * @output {void} - Only sets config options */ /** * Generate required custom properties * @public * @output Adds components custom properties in current scope */ /** * Generate icon styles * @public * @output Outputs configured icon styles in given context */ /** * Icon upload * Custom properties and styles with configuration */ /** * Requires */ /** * Component css class * @protected * @type {string} css class */ /** * Component property prefix * @protected * @type {string} property name */ /** * Config defaults * @private * @type {map} */ /** * Update component config options * @public * @param {map} $options - Map of config options * @output {void} - Only sets config options */ /** * Generate required custom properties * @public * @output Adds components custom properties in current scope */ /** * Generate icon styles * @public * @output Outputs configured icon styles in given context */ /** * Icon user * Custom properties and styles with configuration */ /** * Requires */ /** * Component css class * @protected * @type {string} css class */ /** * Component property prefix * @protected * @type {string} property name */ /** * Config defaults * @private * @type {map} */ /** * Update component config options * @public * @param {map} $options - Map of config options * @output {void} - Only sets config options */ /** * Generate required custom properties * @public * @output Adds components custom properties in current scope */ /** * Generate icon styles * @public * @output Outputs configured icon styles in given context */ /** * Icons styled * Submodule index */ /** * Generate required custom properties * @public * @output Outputs all custom properties in given context */ /** * Generate icon styles * @public * @output Outputs configured icon styles in given context */ /** * Icons images * Custom properties and styles with configuration */ /** * Requires */ /** * Component css class * @protected * @type {string} css class */ /** * Component class variant suffix * @protected * @type {string} class suffix */ /** * Component property prefix * @protected * @type {string} property name */ /** * Config defaults * @private * @type {map} */ /** * Update component config options * @public * @param {map} $options - Map of config options * @output {void} - Sets available image icons */ /** * Generate required custom properties * @public * @output Outputs all custom properties in given context */ /** * Generate icon styles * @public * @output Outputs configured icon styles in given context */ /** * Icons * Submodule forwarding index */ /** * ui-button core component * Custom properties and styles with configuration */ /** * Requires */ /** * Component css class * @protected * @type {string} css class */ /** * Component property prefix * @protected * @type {string} property name */ /** * Config defaults * @private * @type {map} */ /** * Update component config options * @public * @param {map} $options - Map of config options * @output {void} - Only sets config options */ /** * Generate required custom properties * @public * @param {null|map} $extend - Extend properties for output only * @output Adds components custom properties in current scope */ /** * Generate button core styles * @public * @output Outputs configured button base styles in given context */ /** * ui-button styled component * Custom properties and styles with configuration */ /** * Requires */ /** * Component css class * @protected * @type {string} css class */ /** * Component property prefix * @protected * @type {string} property name */ /** * Use styled button as default button * @protected * @type {boolean} css class state switch */ /** * Default style name when using as-default: false * @protected * @type {string} style class suffix */ /** * Config defaults * @private * @type {map} */ /** * Update component config options * @public * @param {map} $options - Map of config options * @output {void} - Only sets config options */ /** * Generate required custom properties * @public * @param {null|map} $extend - Extend properties for output only * @output Adds components custom properties in current scope */ /** * Generate button styled styles * @public * @output Outputs configured button styled styles in given context */ /** * Add button style * @param {string} $name - Style name * @param {map} $values - Property values map * @output Adds a button style with given attributes to current context */ /** * Buttons * Submodule forwarding index */ /** * Font style generation * Custom properties and styles with configuration. */ /** * Requires */ /** * Component css class * @protected * @type {string} css class */ /** * Component style prefix * @protected * @type {string} css class sub style separator */ /** * Component fluid style attribute name * @protected * @type {string} map key */ /** * Component fluid style attribute name * @protected * @type {string} map key */ /** * Config defaults * @private * @type {map} */ /** * Update font styles index * @public * @param {map} $styles - Map of font styles * @output {void} - Sets available style declarations */ /** * Render font style in current context * @public * @param {string} $style - Style name * @output Outputs selected font style in given context */ /** * Return all defined font styles * @public * @return {map} - Maps of font styles */ /** * Generate font styles * @public * @output Outputs configured font styles as helper classes */ /** * ui-list normalize * Custom properties and styles with configuration. */ /** * Requires */ /** * Component property prefix * @protected * @type {string} property name */ /** * Config defaults * @private * @type {map} */ /** * Update component config options * @public * @param {map} $options - Map of config options * @output {void} - Only sets config options */ /** * Generate required custom properties * @public * @param {null|map} $extend - Extend properties for output only * @output Adds components custom properties in current scope */ /** * Generate component styles * @public * @output Outputs configured component styles */ /** * ui-list customize * Custom properties and styles with configuration. */ /** * Requires */ /** * Component data property * @protected * @type {string} property name */ /** * Component data property * @protected * @type {string} property name */ /** * Default counter style * @protected * @type {string} counter style name */ /** * Counter suffix * @protected * @type {string} display suffix */ /** * Counter space * @protected * @type {string} spacing after */ /** * List styles * @protected * @type {list} list-style */ /** * List custom styles * @protected * @type {map<string, list>} custom style */ /** * Generate component styles * @public * @output Outputs configured component styles */ /** * ui-list spaced * Custom properties and styles with configuration. */ /** * Requires */ /** * Component css class * @protected * @type {string} css class */ /** * Component property prefix * @protected * @type {string} property name */ /** * Config defaults * @private * @type {map} */ /** * Update component config options * @public * @param {map} $options - Map of config options * @output {void} - Only sets config options */ /** * Generate required custom properties * @public * @param {null|map} $extend - Extend properties for output only * @output Adds components custom properties in current scope */ /** * Generate component styles * @public * @output Outputs configured component styles */ /** * List * Submodule forwarding index */ /** * ui-text accessibility helpers * Helper class definitions. */ /** * Requires */ /** * Component css class * @protected * @type {string} css class */ /** * Component class variant suffix * @protected * @type {string} class suffix */ /** * Component class variant suffix * @protected * @type {string} class suffix */ /** * Generate component styles * @public * @output Outputs configured accessibility helpers */ /** * ui-text align * Styles with configuration. */ /** * Requires */ /** * Component css class * @protected * @type {string} css class */ /** * Component class variant suffix * @protected * @type {string} class suffix */ /** * Default text center media queries * @protected * @type {string} list of query references */ /** * Component class variant suffix * @protected * @type {string} class suffix */ /** * Default text center media queries * @protected * @type {string} list of query references */ /** * Component class variant suffix * @protected * @type {string} class suffix */ /** * Default text center media queries * @protected * @type {string} list of query references */ /** * Generate component styles * @public * @output Outputs configured alignment helper styles */ /** * ui-text breaks * Styles with configuration. */ /** * Requires */ /** * Component css class * @protected * @type {string} css class */ /** * Component class variant suffix * @protected * @type {string} class suffix */ /** * Component class variant suffix * @protected * @type {string} class suffix */ /** * Component class variant suffix * @protected * @type {string} class suffix */ /** * Component class variant suffix * @protected * @type {string} class suffix */ /** * Component class variant suffix * @protected * @type {string} class suffix */ /** * Component class variant suffix * @protected * @type {string} class suffix */ /** * Component responsive break mode * @protected * @type {boolean} */ /** * Component break css class * @protected * @type {string} css class */ /** * Component break wrap css class * @protected * @type {string} css class */ /** * Component break wrap css class * @protected * @type {string} css class */ /** * Generate component styles * @public * @output Outputs configured break helper styles */ /** * Text navigation style generation * Custom properties and styles with configuration. */ /** * Requires */ /** * Component css class * @protected * @type {string} css class */ /** * Component property prefix * @protected * @type {string} property name */ /** * Default text center media queries * @protected * @type {string} list of query references */ /** * Config defaults * @private * @type {map} */ /** * Update component config options * @public * @param {map} $options - Map of config options * @output {void} - Only sets config options */ /** * Generate required custom properties * @public * @param {null|map} $extend - Extend properties for output only * @output Adds components custom properties in current scope */ /** * Generate text navigation styles * @public * @output Outputs configured spacing styles in given context */ /** * Text normalize * Custom properties and styles with configuration. */ /** * Requires */ /** * Component property prefix * @protected * @type {string} property name */ /** * Config defaults * @private * @type {map} */ /** * Update component config options * @public * @param {map} $options - Map of config options * @output {void} - Only sets config options */ /** * Generate required custom properties * @public * @param {null|map} $extend - Extend properties for output only * @output Adds components custom properties in current scope */ /** * Generate component styles * @public * @output Outputs configured component styles */ /** * Text * Submodule forwarding index */ /** * ui-wrap * Custom properties and styles with configuration. */ /** * Requires */ /** * Component css class * @protected * @type {string} css class */ /** * Component no flex suffix * @protected * @type {string} class variant */ /** * Component property prefix * @protected * @type {string} property name */ /** * Config defaults * @private * @type {map} */ /** * Props defaults * @private * @type {map} */ /** * Update component config options * @public * @param {map} $options - Map of config options * @output {void} - Only sets config options */ /** * Generate required custom properties * @public * @param {null|map} $extend - Extend properties for output only * @output Adds components custom properties in current scope */ /** * Generate component styles * @public * @output Outputs configured component styles */ /** * Space style generation * Custom properties and styles with configuration. */ /** * Requires */ /** * Component css class * @protected * @type {string} css class */ /** * Component property prefix * @protected * @type {string} property name */ /** * Config defaults * @private * @type {map} */ /** * Update component config options * @public * @param {map} $sizes - Map of size options * @