cmyk

@function cmyk($cyan, $magenta, $yellow, $key: 0) { ... }

Description

Parameters

Returns

Example

cmyk(0, 1, 1, 0)
// #f00

Throws

• All parameters must be a unitless number

Requires

• [function] each
• [function] contains

hsv

@function hsv($hue, $saturation, $value) { ... }

Description

Parameters

Returns

Example

hsv(240, 100%, 100%)
// #00f

Requires

• [function] strip-unit

random-color

@function random-color() { ... }

Description

Parameters

None.

Returns

shade

@function shade($color, $percent) { ... }

Description

Parameters

Returns

Example

shade(#fff, 40%)
// #999

tint

@function tint($color, $percent) { ... }

Description

Parameters

Returns

Example

tint(#000, 40%)
// #666

contains

@function contains($list, $value) { ... }

Description

Parameters

Returns

Example

contains(('a', 'b', 'c'), 'b')
// true

Used by

• [function] cmyk

TODO's

• Add optional recursive search

each

@function each($list, $function, $args...) { ... }

Description

Parameters

Returns

Example

$list: ('a', 'b', 'c');
each($list, 'str-insert', 'x', 1)
// ('xa', 'xb', 'xc')

Throws

• #{$list} is not a list

• Function #{$function}() does not exist!

Used by

• [function] cmyk

str-join

@function str-join($list, $separator: ',') { ... }

Description

Parameters

Returns

Example

$list: ('a', 'b', 'c', 'd');
str-join($list, '+')
// a+b+c+d

Used by

• [function] str-concat

without

@function without($list, $values...) { ... }

Description

Parameters

Returns

Example

$list: ('a', 'b', 'c', 'd');
without($list, 'b', 'a')
// ('c', 'd')

Used by

• [function] compact

compact

@function compact($list) { ... }

Description

Parameters

Returns

Example

$list: ('a', 'b', '', 'c', false, 'd');
compact($list)
// ('a', 'b', 'c', 'd')

Requires

• [function] without

add-unit

@function add-unit($number, $unit) { ... }

Description

Parameters

Returns

Example

add-unit(1, 'px')
// 1px

Throws

• $number must be unitless

Used by

• [function] polar-to-cartesian
• [function] replace-unit

polar-to-cartesian

@function polar-to-cartesian($distance, $angle) { ... }

Description

Parameters

Returns

Example

polar-to-cartesian(5px, 90deg)
// 0 5px

Throws

• Could not find sin()! Please make sure all dependencies are met. See https://github.com/devatrox/Sunglass/ for more info.

• Could not find cos()! Please make sure all dependencies are met. See https://github.com/devatrox/Sunglass/ for more info.

• $angle NaN

• $distance NaN

• Could not find deg-to-rad()! Please make sure all dependencies are met. See https://github.com/devatrox/Sunglass/ for more info.

• $angle unit must be

Requires

• [function] strip-unit
• [function] add-unit
• [external] Math::deg-to-rad
• [external] Math::cos
• [external] Math::sin

Used by

• [function] coordinates

Links

• mathsass
• Sassy-math

coordinates

@function coordinates($distance, $angle) { ... }

Description

Parameters

Returns

Example

coordinates(5px, 90deg)
// 0 -5px

Requires

• [function] polar-to-cartesian
• [function] inverse

inverse

@function inverse($number) { ... }

Description

Parameters

Returns

Example

inverse(3px)
// -3px

Throws

• #{$numbers} NaN

Used by

• [function] coordinates

replace-unit

@function replace-unit($number, $unit) { ... }

Description

Parameters

Returns

Example

replace-unit(1px, 'em')
// 1em

Requires

• [function] add-unit
• [function] strip-unit

strip-unit

@function strip-unit($number) { ... }

Description

Parameters

Returns

Example

strip-unit(1px)
// 1

Used by

• [function] hsv
• [function] polar-to-cartesian
• [function] replace-unit

Author

• Jason Nickel

[private] sg-version

$sg-version: '4.0.0';

Description

Type

String

sunglass

$sunglass: () !default;

Description

Type

Map

[private] sg-settings

$sg-settings: ();

Description

Type

Map

valid-units

$valid-units: (
  'em': 0em,
  'ex': 0ex,
  'ch': 0ch,
  'rem': 0rem,
  'vh': 0vh,
  'vw': 0vw,
  'vmin': 0vmin,
  'vmax': 0vmax,
  'px': 0px,
  'mm': 0mm,
  'cm': 0cm,
  'in': 0in,
  'pt': 0pt,
  'pc': 0pc,
  '%': 0%,
  'deg': 0deg,
  'grad': 0grad,
  'rad': 0rad,
  'turn': 0turn,
  'Hz': 0Hz,
  'kHz': 0kHz,
  'dpi': 0dpi,
  'dpcm': 0dpcm,
  'dppx': 0dppx,
  's': 0s,
  'ms': 0ms
);

Description

Type

Map

str-concat

@function str-concat($strings...) { ... }

Description

Parameters

Returns

Example

str-concat('a', 'b', 'c')
// abc

Requires

• [function] str-join

str-contains

@function str-contains($string, $substr, $start: 0) { ... }

Description

Parameters

Returns

Example

str-contains('abc', 'b')
// true

TODO's

• Add optional recursive search

str-count

@function str-count($string, $substr) { ... }

Description

Parameters

Returns

Example

str-count('abcabc', 'b')
// 2