Iterators and generators implementation in Sass.
Generators
functions
generator-next
@function generator-next($name) { ... }Description
Return next value for generator
Parameters
| parameter Name | parameter Description | parameter Type | parameter Default value |
|---|---|---|---|
$name |
— none | String | — none |
Throws
Unknown $generator
#{$generator}.
Requires
generator-valid
@function generator-valid($name) { ... }Description
Check whether an generator is still valid
Parameters
| parameter Name | parameter Description | parameter Type | parameter Default value |
|---|---|---|---|
$name |
— none | String | — none |
Throws
Unknown $generator
#{$generator}.
Requires
mixins
generator
@mixin generator($name) { ... }Description
Initialize a new generator
Parameters
| parameter Name | parameter Description | parameter Type | parameter Default value |
|---|---|---|---|
$name |
generator's name |
String | — none |
Requires
yield
@mixin yield($value) { ... }Description
Yield a new value for the generator
Parameters
| parameter Name | parameter Description | parameter Type | parameter Default value |
|---|---|---|---|
$value |
— none | Any | — none |
Throws
You cannot yield outside of a generator.
Requires
generator-rewind
@mixin generator-rewind($name) { ... }Description
Reset an generator
Parameters
| parameter Name | parameter Description | parameter Type | parameter Default value |
|---|---|---|---|
$name |
— none | String | — none |
Throws
Unknown $generator
#{$generator}.
Requires
variables
[private] __generators__
$__generators__: () !global;Description
Map of existing generators
Used by
[private] __current__
$__current__: null !global;Description
Current generator stored in generator
Used by
Iterators
functions
iterator
@function iterator($collection, $mapping, $mapping-args...) { ... }Description
Iterator initialization
Parameters
| parameter Name | parameter Description | parameter Type | parameter Default value |
|---|---|---|---|
$collection |
— none | List, Map, String | — none |
$mapping |
— none | String, Null | — none |
$mapping-args |
Extra arguments for |
Arglist | — none |
Returns
Iterator
Used by
iterator-rewind
@function iterator-rewind($iterator) { ... }Description
Iterator reset
Parameters
| parameter Name | parameter Description | parameter Type | parameter Default value |
|---|---|---|---|
$iterator |
— none | Iterator | — none |
Returns
Iterator
Requires
iterator-valid
@function iterator-valid($iterator) { ... }Description
Iterator validity checker
Parameters
| parameter Name | parameter Description | parameter Type | parameter Default value |
|---|---|---|---|
$iterator |
— none | Iterator | — none |
Returns
Boolean
iterator-next
@function iterator-next($iterator) { ... }Description
Iterator next
Parameters
| parameter Name | parameter Description | parameter Type | parameter Default value |
|---|---|---|---|
$iterator |
— none | Iterator | — none |
Returns
Iterator
iterator-api
@function iterator-api($iterator) { ... }Description
Iterator API cleaner
Parameters
| parameter Name | parameter Description | parameter Type | parameter Default value |
|---|---|---|---|
$iterator |
— none | Iterator | — none |
Returns
Simple iterator