Build faster with Premium Chakra UI Components 💎

Learn more
Skip to Content
DocsPlaygroundGuidesBlog
Sponsor

List

Used to display a list of items

SourceStorybookRecipe
  • Lorem ipsum dolor sit amet, consectetur adipisicing elit
  • Assumenda, quia temporibus eveniet a libero incidunt suscipit
  • Quidem, ipsam illum quis sed voluptatum quae eum fugit earum

Usage

import { List } from "@chakra-ui/react"
<List.Root>
  <List.Item>Item 1</List.Item>
  <List.Item>Item 2</List.Item>
</List.Root>

Examples

Ordered

Pass the as="ol" prop to create an ordered list

  1. Lorem ipsum dolor sit amet, consectetur adipisicing elit
  2. Assumenda, quia temporibus eveniet a libero incidunt suscipit
  3. Quidem, ipsam illum quis sed voluptatum quae eum fugit earum

Icon

Use the List.Indicator component to add an icon to the list

  • Lorem ipsum dolor sit amet, consectetur adipisicing elit
  • Assumenda, quia temporibus eveniet a libero incidunt suscipit
  • Quidem, ipsam illum quis sed voluptatum quae eum fugit earum

Nested

Here's an example of a nested list

  • First order item
  • First order item
  • First order item with list
    • Nested item
    • Nested item
    • Nested item
  • First order item

Marker Style

Use the _marker prop to style the marker of the list

  1. Your failure to comply with any provision of these Terms of Service;
  2. Your use of the Services, including but not limited to economic, physical, emotional, psychological or privacy related considerations; and
  3. Your actions to knowingly affect the Services via any bloatware, malware, computer virus, worm, Trojan horse, spyware, adware, crimeware, scareware, rootkit or any other program installed in a way that executable code of any program is scheduled to utilize or utilizes processor cycles during periods of time when such program is not directly or indirectly being used.

Props

PropDefaultType
colorPalette 'gray'
'gray' | 'red' | 'orange' | 'yellow' | 'green' | 'teal' | 'blue' | 'cyan' | 'purple' | 'pink' | 'accent'

The color palette of the component

variant 'marker'
'marker' | 'plain'

The variant of the component

align
'center' | 'start' | 'end'

The align of the component

Previous

Link Overlay

Next

Mark