List

A list component embeds a formatted list—bulleted or numbered—into page content.

Examples

Basic

First
Second
Third

Inline

First
Second
Third

Ordered

First
Second
Third

Plain

First
Second
Third

With horizontal rules

First
Second
Third

With icons

First
Second
Third

With large icons

First
Second
Third

Props

List

*required
Name	Type	Default	Description
aria-label	string		Adds an accessible label to the list.
children	React.ReactNode	null	Anything that can be rendered inside of the list
className	string	''	Additional classes added to the list
component	'ol' \| 'ul'	ListComponent.ul	Sets the type of the list component.
iconSize	'default' \| 'large'	'default'	Modifies the size of the icons in the list
isBordered	boolean	false	Modifies the list to add borders between items
isPlain	boolean	false	Modifies the list to include plain styling
ref	No type info	null
type	OrderType	OrderType.number	Sets the way items are numbered if component is set to "ol".
variant	ListVariant.inline	null	Adds list variant styles

ListItem

*required
Name	Type	Default	Description
children	React.ReactNode	null	Anything that can be rendered inside of list item
icon	React.ReactNode \| null	null	Icon for the list item

CSS variables

Expand or collapse column	Selector	Variable	Value

View source on GitHub

Red Hat

Copyright © 2014-2024 Red Hat, Inc.

Privacy statement Terms of use All policies and guidelines