Menu
Menu
☰ Documentation
Documentation
A navigation menu adapted to its page region. Menu owns the final semantic navigation and link markup, including optional supporting icons.
Properties
ariaLabel
string
Accessible label for the action or navigation.
class
string
Optional styling hook.
*
items
MenuItem[]
Items rendered in authored order.
mobileCollapse
boolean
Enables the theme-controlled mobile menu disclosure.
navId
string
Stable DOM ID used by menu controls and nested disclosures.
search
object
Optional label search for this menu's authored item tree.
placeholder — string
Search-field placeholder; defaults to Search.
*
type
string
Identifies the Element type represented by this object.
"menu"
Example
Required
{
"items": [],
"type": "menu"
}
Full
{
"ariaLabel": "Example navigation",
"class": "example",
"items": [
{
"label": "Search",
"icon": {
"name": "search"
},
"link": {
"href": "#search"
}
},
{
"label": "About",
"link": {
"href": "#about"
}
}
],
"mobileCollapse": false,
"navId": "example",
"search": {
"placeholder": "example"
},
"type": "menu"
}
examples are generated from the schema.