List groups

    List groups are a flexible and powerful component for displaying a series of content. Modify and extend them to support just about any content within.

    Basic Example

    Press esc to disable tab trapping

    Active items

    Set the active prop to indicate the list groups current active selection.

    Press esc to disable tab trapping

    Disabled items

    Set the disabled prop to prevent actions on a <List.Item>. For elements that aren't naturally disable-able (like anchors) onClick handlers are added that call preventDefault to mimick disabled behavior.

    Press esc to disable tab trapping

    Actionable items

    Toggle the action prop to create actionable list group items, with disabled, hover and active styles. List item actions will render a <button> or <a> (depending on the presence of an href) by default but can be overridden by setting the as prop as usual.

    List items actions are distinct from plain items to ensure that click or tap affordances aren't applied to non-interactive items.

    Link 1Link 2
    Press esc to disable tab trapping

    Flush

    Add the flush variant to remove outer borders and rounded corners to render list group items edge-to-edge in a parent container such as a Card.

    Press esc to disable tab trapping

    Contextual classes

    Use contextual variants on <List.Item>s to style them with a stateful background and color.

    Press esc to disable tab trapping

    When paired with actions, additional hover and active styles apply.

    Press esc to disable tab trapping

    Tabbed Interfaces

    You can also use the Tab components to create ARIA compliant tabbable interfaces with the <ListGroup> component. Swap out the <Nav> component for the list group and you are good to go.

    Press esc to disable tab trapping

    API

    import ListGroup from 'react-bootstrap/ListGroup'
    NameTypeDefaultDescription
    as
    elementType

    You can use a custom element type for this component.

    variant
    'flush'
    null

    Adds a variant to the list-group

    bsPrefix
    string
    'list-group'

    Change the underlying component CSS base class name and modifier class names prefix. This is an escape hatch for working with heavily customized bootstrap css.

    ListGroup.Itemview source file

    import ListGroup from 'react-bootstrap/ListGroup'
    NameTypeDefaultDescription
    action
    boolean

    Marks a ListGroupItem as actionable, applying additional hover, active and disabled styles for links and buttons.

    active
    boolean
    false

    Sets list item as active

    as
    elementType
    <{div | a | button}>

    You can use a custom element type for this component. For none action items, items render as li. For actions the default is an achor or button element depending on whether a href is provided.

    disabled
    boolean
    false

    Sets list item state as disabled

    eventKey
    string

    A unique identifier for the Component, the eventKey makes it distinguishable from others in a set. Similar to React's key prop, in that it only needs to be unique amongst the Components siblings, not globally.

    href
    string
    onClick
    function
    variant
    'primary' | 'secondary' | 'success' | 'danger' | 'warning' | 'info' | 'dark' | 'light'
    null

    Sets contextual classes for list item

    bsPrefix
    string
    'list-group-item'

    Change the underlying component CSS base class name and modifier class names prefix. This is an escape hatch for working with heavily customized bootstrap css.