created:12/30/2020
updated:12/30/2020
loc
156
comments
6%
SkylineColor
Color item displaying as a row, with color name, custom columns for contrast checks scss variable name and color block. Design inspired by Skyline.
| Name | Use on White | Use on Gray 200 | Scss | Example |
|---|---|---|---|---|
Green | Yes | Yes | get-hue(green) | #1a801b |
Green Light | No | No | get-hue(green, light) | #f4fce3 |
Yellow | No | No | get-hue(yellow) | #fcc419 |
Yellow Light | No | No | get-hue(yellow, light) | #fff9db |
Gray 500 | No | No | get-gray(500) | #8b8b8b |
Gray 600 | Yes | No | get-gray(600) | #757575 |
Gray 700 | Yes | Yes | get-gray(700) | #616161 |
Name | Description | Default |
|---|---|---|
| name | name of the color, If none, or same as the color value, some color blocks will not display it string | - |
| color | color value as a string. accepted hex, rgb, hsl color strings ColorValue | - |
| hover | hover prop boolean | - |
| blackTextColor | text color for the theme. this property is used for AA contrast testing. by default, this is black = #000000 string | - |
| whiteTextColor | dark mode text color for the theme. this property is used for AA contrast testing. by default, this is white = #ffffff string | - |
package | imports | peer |
|---|---|---|
CopyContainer | ||
@primer/octicons-react ^10.0.0 | XIconCheckIcon | |
react ^17.0.1 | FC | * |
theme-ui ^0.8.4 | jsx | |
tinycolor2 ^1.4.1 | tinycolor |
file | imports |
|---|---|
| "../utils" | colorToStrmostReadable |
| "../../types" | ColorBlockPropsColorValuecolorContrast |
| "../../containers" | TableContainerPropsTableContainerTableRowContainer |
<TableRowContainer>
TableRowContainer
from"../../containers"
<BaseSkylineColor/>
BaseSkylineColor
<div
sx
>div
<CheckIcon
sx
/>@primer/octicons-react
^10.0.0<XIcon
sx
/>@primer/octicons-react
^10.0.0<div
sx
/>div
<tr>
tr
<td>
td
<div
sx
/>div
<td
key
>td
<PassTag
contrast
/>PassTag
<td>
td
<CopyContainer
valuename
/><td>
td
<CopyContainer
valuename
/><TableContainer
columnssx
>TableContainer
from"../../containers"
<BaseSkylineColor
keynamecolorcontrastColors
/>BaseSkylineColor