React List Group Component API

List Group API

Explore the API reference for the React List Group component and discover how to effectively utilize its props for customization.

On this page

jsx

import { CListGroup } from '@coreui/react-pro'

Property	Default	Type
as	`ul`	`(ElementType & 'symbol') \| (ElementType & 'object') \| (ElementType & 'ul') \| (ElementType & 'slot') \| (ElementType & 'style') \| ... 175 more ...`
Component used for the root node. Either a string to use a HTML element or a component.
className	-	`string`
A string of all className you want applied to the component.
flush	-	`boolean`
Remove some borders and rounded corners to render list group items edge-to-edge in a parent component (e.g., `<CCard>`).
layout	-	`'horizontal'`, `'horizontal-sm'`, `'horizontal-md'`, `'horizontal-lg'`, `'horizontal-xl'`, `'horizontal-2xl'`
Specify a layout type.
numbered6.0.0+	-	`boolean`
Number the items — pair it with `as="ol"` so the markup matches the visual order.

jsx

import { CListGroupItem } from '@coreui/react-pro'

Property	Default	Type
active	-	`boolean`
Toggle the active state for the component.
as	`li`	`(ElementType & 'symbol') \| (ElementType & 'object') \| (ElementType & 'li') \| (ElementType & 'slot') \| (ElementType & 'style') \| ... 175 more ...`
Component used for the root node. Either a string to use a HTML element or a component.
className	-	`string`
A string of all className you want applied to the component.
colorDeprecated 6.0.0	-	`'primary'`, `'secondary'`, `'success'`, `'danger'`, `'warning'`, `'info'`, `'inverse'`, `string`
Sets the color context of the component to one of CoreUI’s themed colors. Use `theme` instead — `color` renders the same `theme-{color}` class and loses to `theme` when both are set.
disabled	-	`boolean`
Toggle the disabled state for the component.
theme6.0.0+	-	`'primary'`, `'secondary'`, `'success'`, `'danger'`, `'warning'`, `'info'`, `'inverse'`, `string`
Sets the color context of the component to one of CoreUI’s themed colors.