@sparkpost/matchbox
Version:
A React UI component library
136 lines (104 loc) • 3.7 kB
Markdown
# Config
### `@include visually-hidden`
Hides the element that is accessible by screen readers.
### `@include clearfix`
A standard clearfix.
### `border-radius($size: base)`
Returns border radius in pixels.
| size | value |
| :- |:- |
| `base` | 2px **(default)** |
| `large` | 3px|
### `breakpoint($size)`
Returns breakpoint size in pixels.
| size | value |
| :- |:- |
| `smaller` | 450px |
| `small` | 720px |
| `medium` | 960px |
| `large` | 1200px |
| `larger` | 1470px |
### `color($hue, $variant: base)`
Returns color value.
| hue, variant | value |
| :- |:- |
| `orange, base` |  |
| `orange, dark` |  |
| `blue, light` |  |
| `blue, base` |  |
| `blue, dark` |  |
| `gray, base` |  |
| `gray, 0` |  |
| `gray, 1` |  |
| `gray, 2` |  |
| `gray, 3` |  |
| `gray, 4` |  |
| `gray, 5` |  |
| `gray, 6` |  |
| `gray, 7` |  |
| `gray, 8` |  |
| `gray, 9` |  |
| `gray, 10` |  |
| `green, light` |  |
| `green, base` |  |
| `green, dark` |  |
| `red, light` |  |
| `red, base` |  |
| `red, dark` |  |
| `mustard, light` |  |
| `mustard, base` |  |
| `magenta, base` |  |
| `teal, base` |  |
### `shadow($depth: base)`
Returns box shadow values.
| depth | value |
| :- |:- |
| `base` | 0px 1px 2px rgba(#414146, 0.1) **(default)** |
| `deep` | 0px 5px 9px rgba(#414146, 0.14)|
| `deeper` | 0px 10px 30px rgba(#414146, 0.16) |
### `spacing($variant: base)`
Returns spacing in rems.
| variant | value |
| :- |:- |
| `none` | 0 |
| `smaller` | rem(3) |
| `small` | rem(6) |
| `base` | rem(18) **(default)** |
| `large` | rem(24) |
| `larger` | rem(27) |
### `font-family($font: base)`
Returns a font family stack.
| font | value |
| :- |:- |
| `base` | 'Gotham Narrow SSm A', 'Gotham Narrow SSm B', sans-serif **(default)** |
| `monospace` | 'Source Code Pro', monospace |
### `rem($value)`
Returns rem value from a pixel value. We use rem values as much as possible in order to scale our components from a root value. Example:
```css
margin-bottom: rem(18);
/* Compiles into */
margin-bottom: 1rem;
```
### `em($value)`
Returns em value from a pixel value. Example:
```css
font-size: em(18);
/* Compiles into */
font-size: 1em;
```
### `z-index($context: content)`
Returns z-index values.
| context | value |
| :- |:- |
| `content` | 100 **(default)** |
| `overlay` | 400 |