2.5.0
Headers combine a title, border, and–when appropriate–actions to introduce a group of information and/or functionality. They also help establish clear visual hierarchy, adding structure to a composition.
That combination of options is invalid.
Headers can be configured in a variety of ways to accomplish their intended goal. Implementing teams are encouraged to use the particular set of elements which best serve their use case.
Name
|
Required
|
Description
|
---|---|---|
Title |
Yes |
Briefly summarizes the content following the header. |
Border |
No |
Visually defines the header’s space, dividing content into related groups, and helping to establish information hierarchy. |
Title Description |
No |
Provides an Icon-only Button as an interaction point to surface additional information via a Tooltip or Popover. |
Action |
No |
Includes Buttons, Button Groups, or other UI components. |
Use to pair typography and a border to create visual hierarchy. Headers can use the full range of Header borders to define their border-top
.
<div class="mds-header mds-header--primary">
<h2 class="mds-header__title"> Header Title </h2>
</div>
Omit the border modifier class to render a borderless header.
<div class="mds-header">
<h2 class="mds-header__title"> Header Title </h2>
</div>
Nest headers to create layered hierarchies which clearly communicate the relationship between sets of information.
Use to include an Icon-only Button to provide an interaction point for surfacing additional information that clarifies the content introduced by the header, e.g., a data definition housed in a Tooltip or a Popover.
<div class="mds-header mds-header--primary">
<h2 class="mds-header__title"> Header Title <div class="mds-header__title-description">
<button class="mds-button mds-button--icon-only">
<svg class="mds-icon mds-button__icon mds-button__icon--left" aria-hidden="true">
<use xlink:href="/icons/mds.svg#question-circle">
</use>
</svg>
</button>
</div>
</h2>
</div>
Use to provide functionality related to the elements grouped under a header.
<div class="mds-header mds-header--primary">
<h2 class="mds-header__title"> Header Title <div class="mds-header__title-description">
<button class="mds-button mds-button--icon-only">
<svg class="mds-icon mds-button__icon mds-button__icon--left" aria-hidden="true">
<use xlink:href="/icons/mds.svg#question-circle">
</use>
</svg>
</button>
</div>
</h2>
<div class="mds-header__actions">
<div class="mds-button-group">
<button class="mds-button mds-button--secondary mds-button--small mds-button--active"> Option 1 </button>
<button class="mds-button mds-button--secondary mds-button--small"> Option 2 </button>
</div>
</div>
</div>
Reposition the border and increase padding above and below the title by applying the mds-header--border-bottom
modifier class.
<div class="mds-header mds-header--primary mds-header--border-bottom">
<h2 class="mds-header__title"> Header Title </h2>
</div>
Sizing affects text size and internal padding. Modifier classes provide access to the full set of font sizes offered within the system.
<div class="mds-header mds-header--primary mds-header--level-1">
<h2 class="mds-header__title"> Header Title </h2>
</div>
To maintain proper proportional relationships while providing flexibility, choose what size of UI Components to use within a With Actions header, and what size of Icon-only Button to use within the Info element, using the table below.
Title
|
Text Size
|
Small Components
|
Medium Components
|
Large Components
|
---|---|---|---|---|
Level 1 Heading |
|
Can Use |
Can Use |
Can Use |
Level 2 Heading |
|
Can Use |
Can Use |
— |
Level 3 Heading |
|
Can Use |
Can Use |
— |
Level 4 Heading |
|
Can Use |
Can Use |
— |
Level 5 Heading |
|
Can Use |
Can Use |
— |
Level 6 Heading |
|
Can Use |
— |
— |
Level 7 Heading |
|
Can Use |
— |
— |
Level 8 Heading |
|
Can Use |
— |
— |
Level 9 Heading |
|
— |
— |
— |
level-6
through level-9
, the internal padding tightens.font-weight
, work with a designer to create custom styles within your product’s CSS, which utilize the MDS font weight constants.mds-header__title
of a header component, teams should use the header tag (<h#>
) which properly places the content within their product's information hierarchy.mds-header__title
to be referenced by its parent container through an aria-labelledby
attribute. This will clearly communicate their relationship.
Class
|
Applies to
|
Outcome
|
---|---|---|
|
|
Applies a Primary Header Border to the |
|
|
Applies a Secondary Header Border to the |
|
|
Applies a Tertiary Header Border to the |
|
|
For use in Module Containers only. Repositions the border and increases padding above and below the title. |
|
|
Sets the Title to |
|
|
Sets the Title to |
|
|
Sets the Title to |
|
|
Sets the Title to |
|
|
Sets the Title to |
|
|
Sets the Title to |
|
|
Sets the Title to |
|
|
Sets the Title to $mds-font-size-s and reduces the |
|
|
Sets the Title to |