List

An ordered or unordered list, or checklist.

Ordered & Unordered

<List ordered items={[
 'Coconut Milk',
 'Coffee',
 'Chocolate'
 ]}/>

Props

PropsDescriptionRequiredValue

items

items in list

required

array of strings

ordered

show an ordered list

optional

boolean

Check List

To create a checklist with check and/or cross icons:

<CheckList items={[
  { name: 'Coconut Milk', completed: true },
  { name: 'Coffee', completed: true },
  { name: 'Chocolate', completed: false }
]}/>

Props

PropDescriptionRequiredValue

className

custom styles

optional

SCSS or Tailwind style

color

check icon color

optional

green or white (default)

hideCross

hide the cross icons

optional

boolean

interactive

show a pointer icon on hover

optional

boolean

items

the item to display

required

array

onClick

add to individual items as a callback

optional

function

Last updated