Work Side Menu
Side menu variant for worker applications.
Props
heading
string
The application name displayed in the header.
url
string
URL for the header link. Clicking the logo/heading navigates to this URL.
open
any
Controls whether the side menu is expanded or collapsed.
Defaults to
false.
testId
string
Sets a data-testid attribute for automated testing.
userName
string
User's name displayed in the profile section.
userSecondaryText
string
Secondary text displayed below the user's name, such as role or email.
Events
onToggle
(event: Event) => void
_toggle
CustomEvent
onUpdate
(event: Event) => void
_update
CustomEvent
Slots
primary
Named slot for content
secondary
Named slot for content
account
Named slot for content
Work Side Menu Group Props
heading
string
The text displayed in the group heading.
icon
GoAIconType
Icon displayed before the group label. When omitted, no icon is rendered and no space is reserved.
testId
string
Sets a data-testid attribute for automated testing.
open
boolean
Whether the group is open.
Defaults to
false.
Work Side Menu Item Props
label
string
The text label displayed for the menu item.
url
string
The URL the menu item links to. Optional — when absent, renders as a button instead of a link.
badge
string
Badge text displayed alongside the menu item (e.g., notification count).
current
boolean
When true, indicates this is the currently active menu item.
Defaults to
false.
divider
boolean
When true, displays a divider line above this menu item.
Defaults to
false.
icon
string
Icon displayed before the menu item label.
testId
string
Sets a data-testid attribute for automated testing.
type
normal | emergency | success
Sets the visual style of the badge. Use "emergency" for urgent items, "success" for positive status.
Defaults to
normal.
Work Side Menu Item Slots
popoverContent
Content displayed in a popover panel beside the menu item.
Workspace
Preview not available
No React code available