Component

Display components and their properties.

Component checklist

When published, the component checklist block looks like this:

Button

All color themes

Works properly across all four color themes (lightest, light, dark, darkest).

Is documented

The component is fully documented by our standards.

Accessible use of color

Color is not used as the only visual means of conveying information (WCAG 2.0 1.4.1).

In UI library

Is included in our Figma library UI library.

Figma component

Includes a link to a Figma component that has been imported to Supernova

Status

The component has a health status indicated

All ok over here!

Documentation link

There is a connected documentation page in Supernova

-

Repository

Includes a link to an external code repository

The component checklist block displays a table showing a selected component, and highlighting selected properties of the component.

Add a component checklist block

  1. Click + or type / and add a component checklist block.
  2. Select the component you want to display.
  3. Select the property (or properties) you would like to display.
  4. You can toggle the True/False button to display or hide component descriptions.
  5. You can also add a title for your component checklist.
The component checklist block as it appears in the documentation editor

The component checklist block as it appears in the documentation editor