List groups

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

Examples (anchor)

The list groups expect the existence of basic reset styles for font styling and typography properties. The typography style module provides this but the styles should work with any reset/normalize document used.

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).

  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>Term</dt>
<dd><a href="#">Description link</a></dd>
<dd><a href="#">Description link</a></dd>
</dl>

Multiple terms (anchor)

Definition lists <dl> can include multiple terms for both .list-group and .list-links utilities.

Term
Description
Description
Term
Description
Description
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>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>

Fixed light and dark (anchor)

  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
  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)

To use the module load the StyleMods scss directory as follows (changing the path to suit the source files location as required) then include the Sass mixin anywhere below.

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

Source code (anchor)

See customizing for information about using the Sass and CSS variables in the source code to customize the styles, and Sass functionality (on the using StyleMods page) for other ways to use the variables to create custom styles.

list-groups.scss 
// ---------------------------------------------------------- 
// List groups
// ----------------------------------------------------------
$list-group-text-color:           var(--list-group-text, CanvasText) !default;
$list-group-background-color:     var(--list-group-bg, Canvas) !default;
$list-group-link-color:           var(--link, LinkText) !default;
$list-links-background-hover:     var(--list-group-hover, color-mix(in srgb, CanvasText 4%, Canvas)) !default;
$list-group-padding-block:        var(--list-group-py, 0.5rem) !default;
$list-group-padding-inline:       var(--list-group-px, 0.75rem) !default;
$list-group-border-color:         var(--list-group-bd-color, color-mix(in srgb, CanvasText 15%, Canvas)) !default;
$list-group-radius:               var(--list-group-radius, 0.188rem) !default;
$list-group-inner-radius:         calc(var(--list-group-radius, 0.188rem) - 1px) !default;
$list-group-dt-font-weight:       var(--dt-fw, 500) !default;
$list-group-dt-background-color:  var(--list-group-dt-bg, color-mix(in srgb, CanvasText 8%, Canvas)) !default;

@mixin list-groups-css {

:where(.list-group, .list-links) {
  --list-group-inner-radius: $list-group-inner-radius;
  color: $list-group-text-color;
  max-inline-size: var(--list-group-width);
  border: 1px solid $list-group-border-color;
  border-radius: $list-group-radius;
  background-color: $list-group-background-color;
}

:where(.list-group, .list-links):is(ul, ol) {
  list-style-type: "";
  padding-inline-start: 0;
}

:where(.list-group, .list-links) dd {
  margin-inline-start: 0;
}

:where(.list-group, .list-links) :is(li, dd):not(:last-child) {
  border-block-end: 1px solid $list-group-border-color;
}

:where(.list-group :is(li, dt, dd), .list-links dt) {
  padding-block: $list-group-padding-block;
  padding-inline: $list-group-padding-inline;
}

:where(.list-group, .list-links) dt {
  font-weight: $list-group-dt-font-weight;
  border-block-end: 1px solid $list-group-border-color;
  background-color: $list-group-dt-background-color;
}

:where(.list-group, .list-links) dt:first-child {
  border-radius: var(--list-group-inner-radius) var(--list-group-inner-radius) 0 0;
}

// List links
:where(.list-links a) {
  color: $list-group-link-color;
  text-decoration: none;
  display: block;
  padding-block: $list-group-padding-block;
  padding-inline: $list-group-padding-inline;
}

:where(.list-links a:is(:hover, :focus)) {
  background-color: $list-links-background-hover;
}

:where(.list-links a:focus-visible) {
  outline: none;
}

:where(.list-links *:first-child a:is(:hover, :focus)) {
  border-radius: var(--list-group-inner-radius) var(--list-group-inner-radius) 0 0;
}

:where(.list-links *:last-child a:is(:hover, :focus)) {
  border-radius: 0 0 var(--list-group-inner-radius) var(--list-group-inner-radius);
}

// Ordered lists, inserts counter-increment to replace list-style-type.
:where(.list-group, .list-links) ol {
  counter-reset: ol-list;
}

:where(.list-group, .list-links):is(ol) li {
  counter-increment: ol-list;
}

:where(.list-group):is(ol) li:before {
  content: counter(ol-list) ". "; 
  margin-inline-end: 0.25rem;
}

:where(.list-links):is(ol) li a:before {
  content: counter(ol-list) ". "; 
  margin-inline-end: 0.25rem;
}

.list-group-light {
  color-scheme: light;
}

.list-group-dark {
  color-scheme: dark;
}

.list-links-light {
  color-scheme: light;
}

.list-links-dark {
  color-scheme: dark;
}

}