Skip to content

List groups

List group components for standard ordered, unordered and definition list types.

Examples (anchor)

The list group styles can be customized before compiling using Sass or in real-time with CSS variables.

List groups (anchor)

The .list-group utility is applied to each list type, links included are treated as regular inline elements and multiple terms can be used with definition lists (see below).

  • List item
  • List item
  • List item
  1. List item
  2. List item
  3. List item
Term
Description
Description
Example HTML 
<ul class="list-group">
<li>List item</li>
<li>List item</li>
<li>List item</li>
</ul>

<ol class="list-group">
<li>List item</li>
<li>List item</li>
<li>List item</li>
</ol>

<dl class="list-group">
<dt>Term</dt>
<dd>Description</dd>
<dd>Description</dd>
</dl>

The .list-links turn single links within standard list types into block link elements with hover and focus styles. With the definition lists <dl> the block links are only provided for the <dd> content as shown below.

  1. List item link
  2. List item link
  3. List item link
Term
Description link
Description link
Example HTML 
<ul class="list-links">
<li><a href="#">List item link</a></li>
<li><a href="#">List item link</a></li>
<li><a href="#">List item link</a></li>
</ul>

<ol class="list-links">
<li><a href="#">List item link</a></li>
<li><a href="#">List item link</a></li>
<li><a href="#">List item link</a></li>
</ol>

<dl class="list-links">
<dt><a href="#">Term</a></dt>
<dd><a href="#">Description link</a></dd>
<dd><a href="#">Description link</a></dd>
</dl>

Definition terms (anchor)

Definition lists <dl> can include multiple terms <dt> for both .list-group and .list-links utilities, and with the latter terms don't have to include links if required*.

Term
Description
Description
Term
Description
Description
Term
Description link
Description link
Term
Description link
Description link
Term
Description link
Description link
Term
Description link
Description link
Example HTML 
<dl class="list-group">
<dt>Term</dt>
<dd>Description</dd>
<dd>Description</dd>
<dt>Term</dt>
<dd>Description</dd>
<dd>Description</dd>
</dl>

<dl class="list-links">
<dt><a href="#">Term</a></dt>
<dd><a href="#">Description link</a></dd>
<dd><a href="#">Description link</a></dd>
<dt><a href="#">Term</a></dt>
<dd><a href="#">Description link</a></dd>
<dd><a href="#">Description link</a></dd>
</dl>

<dl class="list-links">
<dt>Term</dt>
<dd><a href="#">Description link</a></dd>
<dd><a href="#">Description link</a></dd>
<dt>Term</dt>
<dd><a href="#">Description link</a></dd>
<dd><a href="#">Description link</a></dd>
</dl>

*This is currently only applicable to <dt> items within .list-links.

Fixed light and dark (anchor)

  • List item
  • List item
  • List item
  1. List item
  2. List item
  3. List item
Term
Description
Description
  1. List item link
  2. List item link
  3. List item link
Term
Description link
Description link
  • List item
  • List item
  • List item
  1. List item
  2. List item
  3. List item
Term
Description
Description
  1. List item link
  2. List item link
  3. List item link
Term
Description link
Description link
Example HTML 
<ul class="list-group list-group-light">
<li>List item</li>
<li>List item</li>
<li>List item</li>
</ul>

<ol class="list-group list-group-light">
<li>List item</li>
<li>List item</li>
<li>List item</li>
</ol>

<dl class="list-group list-group-light">
<dt>Term</dt>
<dd>Description</dd>
<dd>Description</dd>
</dl>

<ul class="list-links list-group-light">
<li><a href="#">List item link</a></li>
<li><a href="#">List item link</a></li>
<li><a href="#">List item link</a></li>
</ul>

<ol class="list-links list-group-light">
<li><a href="#">List item link</a></li>
<li><a href="#">List item link</a></li>
<li><a href="#">List item link</a></li>
</ol>

<dl class="list-links list-group-light">
<dt>Term</dt>
<dd><a href="#">Description link</a></dd>
<dd><a href="#">Description link</a></dd>
</dl>

<ul class="list-group list-group-dark">
<li>List item</li>
<li>List item</li>
<li>List item</li>
</ul>

<ol class="list-group list-group-dark">
<li>List item</li>
<li>List item</li>
<li>List item</li>
</ol>

<dl class="list-group list-group-dark">
<dt>Term</dt>
<dd>Description</dd>
<dd>Description</dd>
</dl>

<ul class="list-links list-group-dark">
<li><a href="#">List item link</a></li>
<li><a href="#">List item link</a></li>
<li><a href="#">List item link</a></li>
</ul>

<ol class="list-links list-group-dark">
<li><a href="#">List item link</a></li>
<li><a href="#">List item link</a></li>
<li><a href="#">List item link</a></li>
</ol>

<dl class="list-links list-group-dark">
<dt>Term</dt>
<dd><a href="#">Description link</a></dd>
<dd><a href="#">Description link</a></dd>
</dl>

Using the module (anchor)

Load StyleMods as demonstrated (change file path as required) then include the Sass mixin anywhere below.

custom.scss 
@use "stylemods/scss" as *;
@include list-groups-css;

See the using modules page for more information.

Using the framework (anchor)

Using the recommended custom setup enable the styles in an overrides document:

overrides.scss 
@use "stylemods/scss/configuration" as *;
$enable-list-groups: true;

Include the overrides and the framework styles with your custom document for compiling the framework:

custom.scss 
@use "overrides";
@use "stylemods/scss/stylemods";

See using the framework for more information.

Source code (anchor)

The List groups source file is included with the components module files, you can view the source code from the latest release (v1.5.0) via the Github link below.

Source document
stylemods/scss/components/list-groups.scss
View on Github
https://github.com/pmbrown/StyleMods/blob/main/scss/components/list-groups.scss

Shared documentation about how to customize the default property values for the styles using the Sass and CSS variables is provided on the customizing page.