General

functions

config-get

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

Description

Gets a value to/from a configuration path

Parameters

parameterNameparameterDescriptionparameterTypeparameterDefault value
$key

The configuration path

Stringnone
$default

Whether the configuration is default

Boolnone

Returns

Any type —

The value of the configuration path

Requires

Used by

config-has

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

Description

Returns whether a configuration path exists

Parameters

parameterNameparameterDescriptionparameterTypeparameterDefault value
$key

The configuration path

Stringnone

Returns

Bool

True if the configuration path has a value, otherwise false

Requires

config-reset

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

Description

Remove settings

Parameters

parameterNameparameterDescriptionparameterTypeparameterDefault value
$settings

Configuration path

Stringnone
$default

Whether the configuration is default

Boolnone

Returns

Bool

True if the configuration path is removed.

Requires

Used by

config-set

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

Description

Sets a value to/from a configuration path

Parameters

parameterNameparameterDescriptionparameterTypeparameterDefault value
$key

The configuration key

Stringnone
$value

The value to set

Anynone
$default

Whether the configuration is default

Boolnone

Returns

Any type —

The value of the configuration path

Requires

Used by

list-map-check

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

Description

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

Parameters

parameterNameparameterDescriptionparameterTypeparameterDefault value
$listnoneListnone

Returns

List

Used by

[private] list-slice

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

Description

Extracts a slice of a list

Parameters

parameterNameparameterDescriptionparameterTypeparameterDefault value
$list

The list to extract

Listnone
$start

The start index to extract

Numbernone
$end

The end index to extract

Numbernone

Returns

List

The extracted list

Used by

[private] config-map-set

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

Description

Sets a value to a Map by the map path

Parameters

parameterNameparameterDescriptionparameterTypeparameterDefault value
$map

The Map

Mapnone
$path

The map path

Stringnone
$value

The value to set

* or Nullnone

Returns

Map

A new Map

Requires

Used by

[private] config-map-get

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

Description

Gets a value from a Map by the map path

Parameters

parameterNameparameterDescriptionparameterTypeparameterDefault value
$map

The Map

Mapnone
$path

The map path

Stringnone

Returns

Any type —

The value of the map path

Requires

Used by

[private] config-map-has

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

Description

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

Parameters

parameterNameparameterDescriptionparameterTypeparameterDefault value
$map

The Map

Mapnone
$key

The map path

Stringnone

Returns

Bool

True if the map path has a value, otherwise false

Requires

Used by

[private] config-map-merge

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

Description

Recursively merges one or more maps

Parameters

parameterNameparameterDescriptionparameterTypeparameterDefault value
$maps...

The map(s) to merge

Mapnone

Returns

Map

The merged map

Used by

[private] str-join

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

Description

Joins list elements with a string

Parameters

parameterNameparameterDescriptionparameterTypeparameterDefault value
$list

The list to join

Listnone
$glue

The glue string to join list elements

Stringnone

Returns

String

The joined string

Used by

[private] str-split

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

Description

Splits a string by a delimiter

Parameters

parameterNameparameterDescriptionparameterTypeparameterDefault value
$string

The string to split

Stringnone
$delimiter

The boundary string to split the string

Stringnone

Returns

List

The splitted list

Used by

mixins

config-set

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

Description

Sets a value to a configuration path

Parameters

parameterNameparameterDescriptionparameterTypeparameterDefault value
$key

The configuration key

Stringnone
$value

The value to set

* or Nullnone
$default

Whether the configuration is default

Boolnone

Requires

config-get

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

Description

Gets a value to/from a configuration path

Parameters

parameterNameparameterDescriptionparameterTypeparameterDefault value
$key

The configuration path

Stringnone
$default

Whether the configuration is default

Boolnone

Requires

config-reset

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

Description

Remove settings

Parameters

parameterNameparameterDescriptionparameterTypeparameterDefault value
$settings

Configuration path

Stringnone
$default

Whether the configuration is default

Boolnone

Requires

variables

[private] config-delimiter

$config-delimiter: "." !default;

Description

The delimiter of configuration path

Used by

[private] config-attr

$config-attr: () !default;

Description

The configuration storage

Used by

[private] config-default

$config-default: () !default;

Description

The default configuration storage

Used by

config-namespace

$config-namespace: "" !default;

Description

Namespace for settings

Used by