General
functions
get-keys
@function get-keys($keys, $counter) { ... }Description
Returns a list of keys to to pass into the map-set-deep() function
Parameters
| parameter Name | parameter Description | parameter Type | parameter Default value |
|---|---|---|---|
$keys | — none | | — none |
$counter | — none | | — none |
Used by
- [function]
map-set-deep - [function]
map-set-deep
Links
Author
Sam Richard
is-grayscale
@function is-grayscale($color, $string: '', $namespace: 'grey) { ... }Description
Determine if a passed color is grayscale
Parameters
| parameter Name | parameter Description | parameter Type | parameter Default value |
|---|---|---|---|
$color | the color to test for grayscaleness | Color | — none |
$string | string to provide additional/alternative scoping | String | '' |
$namespace | the namespace to search $string for | String | 'grey |
Returns
Bool —whether or not the passed color is grayscale
Author
list-remove-duplicates
@function list-remove-duplicates($list, $recursive: false) { ... }Description
Remove duplicate values from a list
Parameters
| parameter Name | parameter Description | parameter Type | parameter Default value |
|---|---|---|---|
$list | the list which you want to remove duplicates from | List | — none |
$recursive | used if the target list is nested | Bool | false |
Returns
List —updated list
Links
Author
Hugo Giraudel
list-remove
@function list-remove($list, $value, $recursive: false) { ... }Description
Remove a value from a list
Parameters
| parameter Name | parameter Description | parameter Type | parameter Default value |
|---|---|---|---|
$list | the list which contains the value you wish to remove | List | — none |
$value | the value you wish to remove | Any | — none |
$recursive | used if the target list is nested | Bool | false |
Returns
List —updated list
Links
Author
Hugo Giraudel
list-replace
@function list-replace($list, $old-value, $new-value, $recursive: false) { ... }Description
Replace a value in a list
Parameters
| parameter Name | parameter Description | parameter Type | parameter Default value |
|---|---|---|---|
$list | the list which contains the value you wish to replace | List | — none |
$old-value | the value you wish to replace | Any | — none |
$new-value | what you wish to replace the old value with | Any | — none |
$recursive | used if the target list is nested | Bool | false |
Returns
List —updated list
Links
Author
Hugo Giraudel
list-reverse
@function list-reverse($list, $recursive: false) { ... }Description
Reverse a list
Parameters
| parameter Name | parameter Description | parameter Type | parameter Default value |
|---|---|---|---|
$list | the list which you wish to reverse | List | — none |
$recursive | enable if target list has nested values | Bool | false |
Returns
List —reversed list
Links
Author
Hugo Giraudel
map-get-deep
@function map-get-deep($map, $keys...) { ... }Description
Get a value from a nested map
Parameters
| parameter Name | parameter Description | parameter Type | parameter Default value |
|---|---|---|---|
$map | map | Map | — none |
$keys | key chain | Arglist | — none |
Returns
desired value
Used by
- [function]
map-set-deep - [function]
map-set-deep
Links
Author
Hugo Giraudel
map-merge-deep
@function map-merge-deep($map-old, $map-new) { ... }Description
Used to recursively merge (deep merge) two maps
Parameters
| parameter Name | parameter Description | parameter Type | parameter Default value |
|---|---|---|---|
$map-old | The original map | Map | — none |
$map-new | The new map you wish to merge into the original | Map | — none |
Returns
Map —merged map
Links
Author
Zsolt Pentz
map-reverse
@function map-reverse($map) { ... }Description
Reverse a map
Parameters
| parameter Name | parameter Description | parameter Type | parameter Default value |
|---|---|---|---|
$map | the map to be reversed | Map | — none |
Returns
Map —reversed map
Links
Author
Sean McEmerson
map-search
@function map-search($map, $target-key, $target-value) { ... }Description
Get the value of a unique key from a nested map
Parameters
| parameter Name | parameter Description | parameter Type | parameter Default value |
|---|---|---|---|
$map | the map which contains the target key | Map | — none |
$target-key | the key of interest | String | — none |
$target-value | optional fallback value if key not found | Any | — none |
Returns
desired value
Author
map-set-deep
@function map-set-deep($map, $keys, $value) { ... }Description
Set a nested key in an existing map
Parameters
| parameter Name | parameter Description | parameter Type | parameter Default value |
|---|---|---|---|
$map | the map which contains the key you wish to set | Map | — none |
$keys | the keychain trail to your desired key | String or List | — none |
$value | the value you wish to set for the key | Any | — none |
Returns
Map —updated map
Requires
- [function]
get-keys - [function]
map-get-deep - [function]
get-keys - [function]
map-get-deep
Links
Author
Sam Richard
map-set
@function map-set($map, $key, $value) { ... }Description
Set a key in an existing map
Parameters
| parameter Name | parameter Description | parameter Type | parameter Default value |
|---|---|---|---|
$map | the map which contains the key you wish to set | Map | — none |
$key | the key you wish to set | String | — none |
$value | the value you wish to set for the key | Any | — none |
Returns
Map —updated map
Links
Author
Sam Richard
pow
@function pow($number, $exponent) { ... }Description
Multiply one number by the power of another
Parameters
| parameter Name | parameter Description | parameter Type | parameter Default value |
|---|---|---|---|
$number | the number you wish to multiply | Number | — none |
$exponent | the power by which to multiply | Number | — none |
Returns
Number —result of $number ^ $exponent
Links
Author
Hugo Giraudel
str-replace
@function str-replace($string, $search, $replace) { ... }Description
Replace $search with $replace in $string
Parameters
| parameter Name | parameter Description | parameter Type | parameter Default value |
|---|---|---|---|
$string | initial string | String | — none |
$search | substring to replace | String | — none |
$replace | new value | String | — none |
Returns
String —updated string
Links
Author
Hugo Giraudel
strip-unit
@function strip-unit($value) { ... }Description
Remove the units from a value
Parameters
| parameter Name | parameter Description | parameter Type | parameter Default value |
|---|---|---|---|
$value | number to remove unit from | Number | — none |
Returns
Number —Unitless number
Links
Author
Hugo Giraudel