A next-generation tool to create blazing-fast documentation sites
API
created:4/29/2021
updated:4/29/2021
loc
71
comments
24%
passed
26
coverage
79%

Shield

avatar of atanasster

A container component to display label/value pairs, where the value is colord. Similar design to github shields.

Theme Color

color
#227fc0

Test data

select
#
color
1
palette3
2
status_todo
3
palette3
4
accentPalette2
5
accentPalette0
5 data rows
Name
Description
Default
Controls
color
background color for the value. The color utility parses a component's
color
and
bg
props and converts them into CSS declarations. By default the raw value of the prop is returned.

Color palettes can be configured with the ThemeProvider to use keys as prop values, with support for dot notation. Array values are converted into responsive values.

string
#227fc0

Tests results

Status
Full name
Title
Time(ms)
Shield.test.ts(26 tests)
passed
Shield > overview > 1
snapshot
71
passed
Shield > overview > 1
accessibility
145
passed
Shield > overview > 2
snapshot
55
passed
Shield > overview > 2
accessibility
123
passed
Shield > overview > 3
snapshot
146
passed
Shield > overview > 3
accessibility
333
passed
Shield > overview > 4
snapshot
75
passed
Shield > overview > 4
accessibility
107
passed
Shield > overview > 5
snapshot
59
total 26 tests

Tests coverage

Kind
Total
Covered
Skipped
%
Shield.tsx
lines
23
21
0
91.3%
functions
1
1
0
100%
statements
24
22
0
91.66%
branches
24
19
0
79.16%

A11y tests

color
#227fc0

Viewport

color
#227fc0
320px
color
#227fc0
375px
color
#227fc0
768px
color
#227fc0
1024px