On this page

Angular List Group Component

List Group component allows displaying a series of content. Learn how to use CoreUI list group to build complex list structure on your website.

Examples

Basic

The default list group is an unordered list with items and the proper CSS classes. Build upon it with the options that follow, or with your CSS as required.

Cras justo odio
Dapibus ac facilisis in
Morbi leo risus
Porta ac consectetur ac
Vestibulum at eros

Active item

Add active boolean property for cListGroupItem to show the current active selection.

Cras justo odio
Dapibus ac facilisis in
Morbi leo risus
Porta ac consectetur ac
Vestibulum at eros

Disabled item

Add disabled attribute property for cListGroupItem to make it appear disabled.

Cras justo odio
Dapibus ac facilisis in
Morbi leo risus
Porta ac consectetur ac
Vestibulum at eros

Links and buttons

Use a or button to create actionable list group items with hover, disabled, and active states. We separate these pseudo-classes to ensure list groups made of non-interactive elements (like li or div) don't provide a click or tap affordance.

Cras justo odio Dapibus ac facilisis in Morbi leo risus Porta ac consectetur ac Vestibulum at eros

Flush

Add flush boolean property to remove some borders and rounded corners to render list group items edge-to-edge in a parent container (e.g., cards).

Cras justo odio
Dapibus ac facilisis in
Morbi leo risus
Porta ac consectetur ac
Vestibulum at eros

import { Component } from '@angular/core';
import { ListGroupDirective, ListGroupItemDirective } from '@coreui/angular';

@Component({
  selector: 'docs-list-group06',
  templateUrl: './list-group06.component.html',
  standalone: true,
  imports: [ListGroupDirective, ListGroupItemDirective]
})
export class ListGroup06Component {}

Horizontal

Add horizontal prop to change the layout of list group items from vertical to horizontal across all breakpoints. Alternatively, choose a responsive variant with horizontal="sm|md|lg|xl|xxl" to make a list group horizontal starting at that breakpoint's min-width. Currently horizontal list groups cannot be combined with flush list groups.

Cras justo odio
Dapibus ac facilisis in
Morbi leo risus

Cras justo odio
Dapibus ac facilisis in
Morbi leo risus

Cras justo odio
Dapibus ac facilisis in
Morbi leo risus

Cras justo odio
Dapibus ac facilisis in
Morbi leo risus

Cras justo odio
Dapibus ac facilisis in
Morbi leo risus

Cras justo odio
Dapibus ac facilisis in
Morbi leo risus

import { Component } from '@angular/core';
import { ListGroupDirective, ListGroupItemDirective } from '@coreui/angular';

@Component({
  selector: 'docs-list-group07',
  templateUrl: './list-group07.component.html',
  standalone: true,
  imports: [ListGroupDirective, ListGroupItemDirective]
})
export class ListGroup07Component {
  breakpoints = [true, 'sm', 'md', 'lg', 'xl', 'xxl'];
}

Contextual classes

Use contextual classes to style list items with a stateful background and color.

A simple primary list group item
A simple secondary list group item
A simple success list group item
A simple danger list group item
A simple warning list group item
A simple info list group item
A simple light list group item
A simple dark list group item

import { Component } from '@angular/core';
import { ListGroupDirective, ListGroupItemDirective } from '@coreui/angular';

@Component({
  selector: 'docs-list-group08',
  templateUrl: './list-group08.component.html',
  standalone: true,
  imports: [ListGroupDirective, ListGroupItemDirective]
})
export class ListGroup08Component {
  colors = ['primary', 'secondary', 'success', 'danger', 'warning', 'info', 'light', 'dark'];
}

Colors for links and buttons

Contextual classes also work with a or button. Note the addition of the hover styles here not present in the previous example. Also supported is the active state; apply it to indicate an active selection on a contextual list group item.

A simple primary list group item A simple secondary list group item A simple success list group item A simple danger list group item A simple warning list group item A simple info list group item A simple light list group item A simple dark list group item

import { Component } from '@angular/core';
import { RouterLink } from '@angular/router';
import { ListGroupDirective, ListGroupItemDirective } from '@coreui/angular';

@Component({
  selector: 'docs-list-group09',
  templateUrl: './list-group09.component.html',
  standalone: true,
  imports: [ListGroupDirective, ListGroupItemDirective, RouterLink]
})
export class ListGroup09Component {
  colors = ['primary', 'secondary', 'success', 'danger', 'warning', 'info', 'light', 'dark'];
}

Conveying meaning to assistive technologies

Using color to add meaning only provides a visual indication, which will not be conveyed to users of assistive technologies – such as screen readers. Ensure that information denoted by the color is either obvious from the content itself (e.g. the visible text), or is included through alternative means, such as additional text hidden with the .visually-hidden class.

With badges

Add badges to any list group item to show unread counts, activity, and more.

import { Component } from '@angular/core';
import { BadgeComponent, ListGroupDirective, ListGroupItemDirective } from '@coreui/angular';

@Component({
  selector: 'docs-list-group10',
  templateUrl: './list-group10.component.html',
  standalone: true,
  imports: [ListGroupDirective, ListGroupItemDirective, BadgeComponent]
})
export class ListGroup10Component {}

Custom content

Add nearly any HTML within, even for linked list groups like the one below, with the help of flexbox utilities

List group item heading

3 days ago

Donec id elit non mi porta gravida at eget metus. Maecenas sed diam eget risus varius blandit.

Donec id elit non mi porta.

List group item heading

3 days ago

Donec id elit non mi porta gravida at eget metus. Maecenas sed diam eget risus varius blandit.

Donec id elit non mi porta.

List group item heading

3 days ago

Donec id elit non mi porta gravida at eget metus. Maecenas sed diam eget risus varius blandit.

Donec id elit non mi porta.

import { Component } from '@angular/core';
import { RouterLink } from '@angular/router';
import { ListGroupDirective, ListGroupItemDirective } from '@coreui/angular';

@Component({
  selector: 'docs-list-group11',
  templateUrl: './list-group11.component.html',
  standalone: true,
  imports: [
    ListGroupDirective,
    ListGroupItemDirective,
    RouterLink
  ]
})
export class ListGroup11Component {}

Checkboxes and radios

Place CoreUI's checkboxes and radios within list group items and customize as needed.

API reference

ListGroup Module

import { ListGroupModule } from '@coreui/angular';

@NgModule({
   imports: [ListGroupModule,]
})
export class AppModule() { }

cListGroup

directive

Inputs

name	description	type	default
`flush`	Remove some borders and rounded corners to render list group items edge-to-edge in a parent component	`boolean`	false
`horizontal`	Specify horizontal layout type.	`Sizes` \| `boolean`	undefined

cListGroupItem

directive

Inputs

name	description	type	default
`active`	Toggle the active state for the list item	`boolean`	false
`color`	Color context of the component to one of CoreUI’s themed colors.	`Colors`	undefined