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

import { CListGroup } from '@coreui/react'
// or
import CListGroup from '@coreui/react/src/components/list-group/CListGroup'

Property	Default	Type
as#	`ul`	`(ElementType & 'symbol')`, `(ElementType & 'object')`, `(ElementType & 'ul')`, `(ElementType & 'slot')`, `(ElementType & 'style')`, `... 174 more ...`, `(ElementType & FunctionComponent<...>)`
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-xxl'`
Specify a layout type.

import { CListGroupItem } from '@coreui/react'
// or
import CListGroupItem from '@coreui/react/src/components/list-group/CListGroupItem'

Property	Default	Type
active#	-	`boolean`
Toggle the active state for the component.
as#	`li`	`(ElementType & 'symbol')`, `(ElementType & 'object')`, `(ElementType & 'li')`, `(ElementType & 'slot')`, `(ElementType & 'style')`, `... 174 more ...`, `(ElementType & FunctionComponent<...>)`
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.
color#	-	`'primary'`, `'secondary'`, `'success'`, `'danger'`, `'warning'`, `'info'`, `'dark'`, `'light'`, `string`
Sets the color context of the component to one of CoreUI’s themed colors.
disabled#	-	`boolean`
Toggle the disabled state for the component.