CodexMenuItem
A MenuItem is a selectable option within a Menu.
WARNING
This is not a standalone component, nor will it typically be directly used. It's intended for use by the Menu component, which will provide it with props and menu state information. See Menu for more details.
Guidelines
Using menu items
MenuItem is an “internal” component, used exclusively to represent content within a Menu. It cannot be used by itself.
MenuItems contain text, and supporting media (icons or thumbnails) that represent an available choice for users.
Specifications
Each menu item may include the following elements:
- Visual element (optional)
An icon or thumbnail can be included in order to provide more context about the menu item content. - Label
A clear and descriptive title for the menu item. - Supporting text (optional)
Optional and subtle text that supports or explains the label. - Match text (optional)
In the context of a search suggestions menu, this optional text displays the alternative label of an item that matches the search query (e.g. an alias). - Description (optional)
Optional and subtle descriptive text that provides additional information about the menu item.
Interaction states
Menu items have the following visually separate states:
- Default
- Hover
- Active
- Selected
- Selected hover
- Disabled
Demos
Note that these demos do not properly show some interactive states of menu items (like active or hovered/highlighted), since they display menu items as standalone or as part of an always-expanded, detached menu. To see the full interactivity of menu items, check out a component that contains a menu, like Select, Lookup, or TypeaheadSearch.
Configurable
Note that manually hovering over or selecting this menu item is disabled, the configuration options to set these states should be used.
| Name | Value |
|---|---|
| Props | |
disabled | |
selected | |
active | |
highlighted | |
label | |
match | |
supportingText | |
icon | |
description | |
searchQuery | |
boldLabel | |
hideDescriptionOverflow | |
| View | |
Reading direction | |
Note: For icon properties, the relevant icon also needs to be imported from the @wikimedia/codex-icons package. See the usage documentation for more information. | |
Default
With description and bold label
With link
If a url property is included, the menu item will be wrapped in an anchor tag.
With icon
With thumbnail
With search query highlighted
When a menu item displays a search result, the current search query can be provided (along with the highlightQuery prop) and it will be visually differentiated within the menu item's title. The search query text will have a normal font weight, while the rest of the title will be bold, which is meant to bring attention to the available suggestions based on the current search query.
In the example below, the search query is "Co".
With search query match
For search results, a match property may be included that represents the text related to that item that matched the search query (e.g. a Wikidata alias). The match will be displayed after the label. In the example below, the search query is "felis margarita," an alias of the Wikidata item "sand cat."
With supporting text
Text that supports or explains the label can be added via the supportingText prop. This text will be displayed after the label in a more subtle color.
The example below shows a result for the search term "Corn," which redirects to the article for "Maize" on English Wikipedia.
With multiple languages
Individual lang attributes can be set for the label, description, match, and supportingText props via the language prop, which is an object of lang attributes for those props.
The example below demonstrates a search result in a Greek interface for the English word "moon."
With long title and search query highlighted
With description text overflow hidden
Within a list
With graphemes
Vue usage
A value must be provided, and various optional elements can be displayed:
- A human-readable label
- A description
- A thumbnail or icon
Alternately, the entire content and layout of the menu item can be customized via the default slot.
For search results, the search query can be visually differentiated within the result title.
Props
| Prop name | Description | Type | Default |
|---|---|---|---|
id(required) | ID for HTML id attribute. | string | |
value(required) | The value provided to the parent menu component when this menu item is selected. | string|number | |
disabled | Whether the menu item is disabled. | boolean | false |
selected | Whether this menu item is selected. | boolean | false |
active | Whether this menu item is being pressed. | boolean | false |
highlighted | Whether this menu item is visually highlighted due to hover or keyboard navigation. | boolean | false |
label | Label for the menu item. If this isn't provided, the value will be displayed instead. | string | '' |
match | Text that matches current search query. Only used for search results and will be displayed after the label. | string | '' |
supportingText | Text that supports the label. Supporting text will appear next to the label in a more subtle color. | string | '' |
url | URL for the menu item. If provided, the content of the menu item will be wrapped in an anchor tag. | string | '' |
icon | Icon for the menu item. | Icon | '' |
showThumbnail | Whether a thumbnail (or a placeholder icon) should be displayed. | boolean | false |
thumbnail | Thumbnail for the menu item. | Thumbnail|null | null |
description | Description of the menu item. | string|null | '' |
searchQuery | The search query to be highlighted within the menu item's title. | string | '' |
boldLabel | Whether to bold menu item labels. | boolean | false |
hideDescriptionOverflow | Whether to hide description text overflow via an ellipsis. | boolean | false |
language | Optional language codes for label, match, supporting text, and description. If included, that language code will be added as a lang attribute to the element wrapping that text node. | MenuItemLanguageData | () => { return {}; } |
Events
| Event name | Properties | Description |
|---|---|---|
change | menuState MenuState - State to change setState boolean - Whether to set that state to this menu item | Emitted when the menu item becomes selected, active or highlighted in response to user interaction. Handled in the Menu component. |
Slots
| Name | Description | Bindings |
|---|---|---|
| default | Custom menu item content. |