Code

List component usage and API reference.

circle-info

This component require devs to use one variant or another from the very first moment based on the kind of list developers want to insert. <List.Order> or <List.Unorder>.

API

This component extends the native anchor tag props. This means this component can receive the native html div tag attributes.

Props
Data Type
Required

children

List.Item

βœ…

className

string

❌

type

'1' | 'A' | 'a' | 'I' | 'i'

❌

circle-info

The type prop will only work for ordered lists.

List.Item

This subcomponent basically works as the <li> tag on normal lists, with the main different it will only accept text as children element. Besides that, if the developer is working with an un-order list, they can add the prop symbol and customize the bullet that's shown next to the text content.

Props
Data Type
Required

children

string

βœ…

className

string

❌

symbol

'disc' | 'circle | 'square' | 'string'

❌

circle-exclamation

Example

Last updated