General

functions

config-get

@function config-get($key, $default) { ... }

Description

Gets a value to/from a configuration path

Parameters

parameterName	parameterDescription	parameterType	parameterDefault value
`$key`	The configuration path	`String`	—none
`$default`	Whether the configuration is default	`Bool`	—none

Returns

Any type —

The value of the configuration path

Requires

[function] config-map-has
[function] config-map-get
[variable] sass-config-default
[variable] sass-config-attr

Used by

[mixin] config-get

config-has

@function config-has($key) { ... }

Description

Returns whether a configuration path exists

Parameters

parameterName	parameterDescription	parameterType	parameterDefault value
`$key`	The configuration path	`String`	—none

Returns

Bool —

True if the configuration path has a value, otherwise false

Requires

[function] config-map-has
[variable] sass-config-namespace
[variable] sass-config-attr
[variable] sass-config-default

config-reset

@function config-reset($settings, $default) { ... }

Description

Remove settings

Parameters

parameterName	parameterDescription	parameterType	parameterDefault value
`$settings`	Configuration path	`String`	—none
`$default`	Whether the configuration is default	`Bool`	—none

Returns

Bool —

True if the configuration path is removed.

Requires

[variable] sass-config-namespace
[variable] config-manger-variables
[variable] sass-config-default
[variable] sass-config-attr

Used by

[mixin] config-reset

config-set

@function config-set($key, $value, $default) { ... }

Description

Sets a value to/from a configuration path

Parameters

parameterName	parameterDescription	parameterType	parameterDefault value
`$key`	The configuration key	`String`	—none
`$value`	The value to set	`Any`	—none
`$default`	Whether the configuration is default	`Bool`	—none

Returns

Any type —

The value of the configuration path

Requires

[function] config-map-has
[function] config-map-get
[function] config-map-set
[variable] sass-config-namespace
[variable] sass-config-default
[variable] config-manger-variables
[variable] sass-config-attr

Used by

[mixin] config-set

list-map-check

@function list-map-check($list) { ... }

Description

Return list-map from $list and ensure input list-map is list-of-lists

Parameters

parameterName	parameterDescription	parameterType	parameterDefault value
`$list`	—none	`List`	—none

Returns

List

Used by

[function] config-map-set
[function] config-map-get
[function] config-map-has

[private] list-slice

@function list-slice($list, $start, $end) { ... }

Description

Extracts a slice of a list

Parameters

parameterName	parameterDescription	parameterType	parameterDefault value
`$list`	The list to extract	`List`	—none
`$start`	The start index to extract	`Number`	—none
`$end`	The end index to extract	`Number`	—none

Returns

List —

The extracted list

Used by

[function] config-map-set

[private] config-map-set

@function config-map-set($map, $path, $value) { ... }

Description

Sets a value to a Map by the map path

Parameters

parameterName	parameterDescription	parameterType	parameterDefault value
`$map`	The Map	`Map`	—none
`$path`	The map path	`String`	—none
`$value`	The value to set	`*` or `Null`	—none

Returns

Map —

A new Map

Requires

[function] list-map-check
[function] str-split
[function] str-join
[function] list-slice
[function] config-map-has
[function] config-map-get
[function] config-map-merge
[variable] sass-config-delimiter

Used by

[function] config-set

[private] config-map-get

@function config-map-get($map, $path) { ... }

Description

Gets a value from a Map by the map path

Parameters

parameterName	parameterDescription	parameterType	parameterDefault value
`$map`	The Map	`Map`	—none
`$path`	The map path	`String`	—none

Returns

Any type —

The value of the map path

Requires

[function] str-split
[function] list-map-check
[variable] sass-config-delimiter

Used by

[function] config-get
[function] config-set
[function] config-map-set

[private] config-map-has

@function config-map-has($map, $key) { ... }

Description

Returns whether the key of a map path exists in a Map

Parameters

parameterName	parameterDescription	parameterType	parameterDefault value
`$map`	The Map	`Map`	—none
`$key`	The map path	`String`	—none

Returns

Bool —

True if the map path has a value, otherwise false

Requires

[function] str-split
[function] list-map-check
[variable] sass-config-delimiter

Used by

[function] config-get
[function] config-has
[function] config-set
[function] config-map-set

[private] config-map-merge

@function config-map-merge($maps...) { ... }

Description

Recursively merges one or more maps

Parameters

parameterName	parameterDescription	parameterType	parameterDefault value
`$maps...`	The map(s) to merge	`Map`	—none

Returns

Map —

The merged map

Used by

[function] config-map-set

[private] str-join

@function str-join($list, $glue) { ... }

Description

Joins list elements with a string

Parameters

parameterName	parameterDescription	parameterType	parameterDefault value
`$list`	The list to join	`List`	—none
`$glue`	The glue string to join list elements	`String`	—none

Returns

String —

The joined string

Used by

[function] config-map-set

[private] str-split

@function str-split($string, $delimiter) { ... }

Description

Splits a string by a delimiter

Parameters

parameterName	parameterDescription	parameterType	parameterDefault value
`$string`	The string to split	`String`	—none
`$delimiter`	The boundary string to split the string	`String`	—none

Returns

List —

The splitted list

Used by

[function] config-map-set
[function] config-map-get
[function] config-map-has

mixins

config-set

@mixin config-set($key, $value, $default) { ... }

Description

Sets a value to a configuration path

Parameters

parameterName	parameterDescription	parameterType	parameterDefault value
`$key`	The configuration key	`String`	—none
`$value`	The value to set	`*` or `Null`	—none
`$default`	Whether the configuration is default	`Bool`	—none

Requires

[function] config-set

config-get

@mixin config-get($key, $default) { ... }

Description

Gets a value to/from a configuration path

Parameters

parameterName	parameterDescription	parameterType	parameterDefault value
`$key`	The configuration path	`String`	—none
`$default`	Whether the configuration is default	`Bool`	—none

Requires

[function] config-get

config-reset

@mixin config-reset($settings, $default) { ... }

Description

Remove settings

Parameters

parameterName	parameterDescription	parameterType	parameterDefault value
`$settings`	Configuration path	`String`	—none
`$default`	Whether the configuration is default	`Bool`	—none

Requires

[function] config-reset

variables

config-manger-variables

$config-manger-variables: "" !default !global;

Description

Setting to use global vars

Used by

[function] config-reset
[function] config-set

sass-config-delimiter

$sass-config-delimiter: "." !default !global;

Description

The delimiter of configuration path

@access private

Used by

[function] config-map-set
[function] config-map-get
[function] config-map-has

sass-config-attr

$sass-config-attr: () !default !global;

Description

The configuration storage

@access private

Used by

[function] config-get
[function] config-has
[function] config-reset
[function] config-set

sass-config-default

$sass-config-default: () !default !global;

Description

The default configuration storage

@access private

Used by

[function] config-get
[function] config-has
[function] config-reset
[function] config-set

sass-config-namespace

$sass-config-namespace: "" !default !global;

Description

Namespace for settings

@access public

Used by

[function] config-has
[function] config-reset
[function] config-set

sass-config-delimiter

$sass-config-delimiter: "." !default;

Description

The delimiter of configuration path

@access private

sass-config-attr

$sass-config-attr: () !default;

Description

The configuration storage

@access private

sass-config-default

$sass-config-default: () !default;

Description

The default configuration storage

@access private

sass-config-namespace

$sass-config-namespace: "" !default;

Description

Namespace for settings

@access public