Skip to main content

List

List is used to display list items. It renders a <ul> element by default.

Import

import {
List,
ListItem,
ListIcon,
OrderedList,
UnorderedList,
} from '@chakra-ui/react';

Unordered List

Ordered List

Unstyled List with icon

Add icons to the list items by using the ListIcon component. You can pass the name of the icon or use custom icons. The size of the icon is relative to the font size of the list item.

Props

List Props

colorScheme

Description

Color Schemes for List are not implemented in the default theme. You can extend the theme to implement them.

Type
string

size

Description

Sizes for List are not implemented in the default theme. You can extend the theme to implement them.

Type
string

spacing

Description

The space between each list item

Type
SystemProps["margin"]

stylePosition

Description

Shorthand prop for listStylePosition

Type
SystemProps["listStylePosition"]

styleType

Description

Shorthand prop for listStyleType

Type
SystemProps["listStyleType"]

variant

Description

Variants for List are not implemented in the default theme. You can extend the theme to implement them.

Type
string

List Item Props

ListItem composes Box so you can pass all style and pseudo style props.