React List Group Component API

List Group API

Rocket
New Year sale. Skyrocket your business in 2025!
Extra 25% off for all sale items + Free CoreUI Icons PRO with every order!
Limited-time offer for the first 100 customers in 2025. Use code 2025SKY25 at checkout.

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

On this page

CListGroup#

import { CListGroup } from '@coreui/react'
// or
import CListGroup from '@coreui/react/src/components/list-group/CListGroup'
PropertyDefaultType
as#-(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.

CListGroupItem#

import { CListGroupItem } from '@coreui/react'
// or
import CListGroupItem from '@coreui/react/src/components/list-group/CListGroupItem'
PropertyDefaultType
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.