Side menu

A side navigation that helps the user navigate between pages.

Props

testId
string
Sets a data-testid attribute for automated testing.
testId
string
Sets a data-testid attribute for automated testing.
testId
string
Sets a data-testid attribute for automated testing.

Side Menu Group Props

heading
string
The heading text for the menu group.
icon
GoabIconType
Icon displayed alongside the heading.
testId
string
Sets a data-testid attribute for automated testing.
mt, mr, mb, ml
Spacing
Apply margin to the top, right, bottom, and/or left of the component.
heading
string
The heading text for the menu group.
icon
GoabIconType
Icon displayed alongside the heading.
testId
string
Sets the data-testid attribute for automated testing.
mt, mr, mb, ml
Spacing
Apply margin to the top, right, bottom, and/or left of the component.
heading
string
The heading text for the menu group.
icon
GoabIconType
Icon displayed alongside the heading.
testId
string
Sets a data-testid attribute for automated testing.
mt, mr, mb, ml
Spacing
Apply margin to the top, right, bottom, and/or left of the component.

Side Menu Group Events

_open
CustomEvent

Side Menu Heading Props

icon
GoabIconType
Icon displayed before the heading text.
testId
string
Sets a data-testid attribute for automated testing.
icon
GoabIconType
Icon displayed before the heading text.
testId
string
Sets a data-testid attribute for automated testing.
icon
GoabIconType
Icon displayed before the heading text.
testId
string
Sets a data-testid attribute for automated testing.
Defaults to section-heading.

Side Menu Heading Slots

meta
Content rendered in the meta slot, displayed alongside the heading.
meta
Content rendered in the meta slot, displayed alongside the heading.
meta
Content rendered in the meta slot, displayed alongside the heading.
Examples
Examples show common usage patterns and implementation guidance.

No usage guidelines have been documented for this component yet.

All GoA Design System components are built to meet WCAG 2.2 AA standards. The following guidelines provide additional context for accessible implementation.

No accessibility-specific guidelines have been documented for this component yet.

View old component docs