Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

[Function Units] Flush the proposal to the spec #3437

Merged
merged 1 commit into from
Oct 29, 2022
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Jump to
Jump to file
Failed to load files.
Diff view
Diff view
67 changes: 62 additions & 5 deletions spec/built-in-modules/color.md
Original file line number Diff line number Diff line change
Expand Up @@ -86,7 +86,13 @@ This function is also available as a global function named `adjust-color()`.

* If `$alpha` isn't null:

* If `$alpha` isn't a number between -1 and 1 (inclusive), throw an error.
* If `$alpha` isn't a number, throw an error.

* If `$alpha` has units other than `%`, throw an error.

* If `$alpha` has unit `%`, set it to `math.div($alpha, 100%)`.

* If `$alpha < -1` or `$alpha > 1`, throw an error.

* Set `alpha` to `alpha + $alpha` clamped between 0 and 1.

Expand Down Expand Up @@ -239,11 +245,17 @@ This function is also available as a global function named `change-color()`.

* If `$color` isn't a color, throw an error.

* If `$alpha` isn't either null or a number between 0 and 1 (inclusive), throw
an error.
* If `$alpha` is null, let `alpha` be `$color`'s alpha channel. Otherwise:

* If `$alpha` isn't a number, throw an error.

* If `$alpha` has units other than `%`, throw an error.

* If `$alpha` has unit `%`, set it to `math.div($alpha, 100%)`.

* If `$alpha < 0` or `$alpha > 1`, throw an error.

* Let `alpha` be `$color`'s alpha channel if `$alpha` is null or `$alpha`
without units otherwise.
* Let `alpha` be `$alpha` clamped between 0 and 1.

* If `$hue` isn't a number or null, throw an error.

Expand Down Expand Up @@ -509,6 +521,51 @@ This function is also available as a global function named `lightness()`.
mix($color1, $color2, $weight: 50%)
```

* If either `$color1` or `$color2` is not a color, throw an error.

* If `$weight` isn't a number with unit `%`, throw an error.

* Let `normal-weight` be `$weight / 50% - 1`.

* Let `alpha1` and `alpha2` be the alpha values of `$color1` and `$color2`
respectively.

* Let `alpha-distance` be `alpha1 - alpha2`.

* Let `weight-by-distance` be `normal-weight * alpha-distance`.

* If `weight-by-distance == -1`, let `combined-weight1` be `normal-weight`.

* Otherwise:

* Let `weight-distance-sum` be `normal-weight + alpha-distance`.

* Let `combined-weight1` be `weight-distance-sum / (1 + weight-by-distance)`.

* Let `weight1` be `(combined-weight1 + 1) / 2`.

* Let `weight2` be `1 - weight1`.

* Let `red1` and `red2` be the red channels of `$color1` and `$color2`
respectively.

* Let `red` be `red1 * weight1 + red2 * weight2`.

* Let `green1` and `green2` be the green channels of `$color1` and `$color2`
respectively.

* Let `green` be `green1 * weight1 + green2 * weight2`.

* Let `blue1` and `blue2` be the blue channels of `$color1` and `$color2`
respectively.

* Let `blue` be `blue1 * weight1 + blue2 * weight2`.

* Let `alpha` be `alpha1 * weight-scale + alpha2 * (1 - weight-scale)`.

* Return a color with the given `red`, `green`, and `blue` channels, and `alpha`
value.

### `opacify()`

```
Expand Down
21 changes: 21 additions & 0 deletions spec/built-in-modules/list.md
Original file line number Diff line number Diff line change
Expand Up @@ -83,6 +83,17 @@ nth($list, $n)

This function is also available as a global function named `nth()`.

* If `$n` isn't a unitless [integer], throw an error.

* If `$n` is an [invalid index] for `$list`'s [list value], throw an error.

* Return the value [indexed by] `$n` in `$list`'s list value.

[integer]: ../types/number.md#integer
[invalid index]: ../types/list.md#index
[indexed by]: ../types/list.md#index
[list value]: ../types/list.md#list-value

### `set-nth()`

```
Expand All @@ -91,6 +102,16 @@ set-nth($list, $n, $value)

This function is also available as a global function named `set-nth()`.

* If `$n` isn't a unitless [integer], throw an error.

* Let `list` be a copy of `$list`'s [list value].

* If `$n` is an [invalid index] for `list`, throw an error.

* Replace the value indexed by `$n` in `list` with `$value`.

* Return `list`.

### `zip()`

```
Expand Down
31 changes: 31 additions & 0 deletions spec/types/list.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,6 +4,8 @@

* [Definitions](#definitions)
* [List](#list)
* [List Value](#list-value)
* [Index](#index)

## Definitions

Expand All @@ -13,3 +15,32 @@ A *SassScript list* (usually referred to as just a *list*) is an ordered
sequence of SassScript values. A list may or may not be *bracketed*, and a list
has a *separator* which is one of "space", "comma", "slash", or "undecided".
Only lists with zero or one elements may have an "undecided" separator.

### List Value

A SassScript value's *list value* is the interpretation of that value as a
SassScript list. This differs from type to type:

* The list value of a list is the list itself.
* The list value of a map is an unbracketed comma-separated list whose elements
are the key/value pairs in the map as two-element unbracketed space-separated
lists.
* The list value of any other value is an unbracketed undecided-separator list
containing only that value.

### Index

An *index* is a unitless [integer] that refers to a specific location in a list.
Positive integers count from the beginning of the list, and negative integers
count from the end of the list. The referenced value is said to be *indexed by*
the index. An integer is an *invalid index* for a given list if it's 0 or if its
absolute value is larger than the length of that list.

> For example, in the values in the list `["a", "b", "c"]` are referred to by
> the following indices:
>
> * `"a"`: 1, -3
> * `"b"`: 2, -2
> * `"c"`: 3, -1

[integer]: number.md#integer