Menu Item
Type: React component
How to get MenuItem?
JavaScript
import { MenuItem } from 'fds/components';
Visually renders the outer container of a menu item and standardizes things like disabled, hovered and selected states while leaving the actual content arbitrary.
Should be rendered inside a Menu or MenuGroup.
Keyboard behavior:
-
Enter: call the onClick prop when focused/hovered and isDisabled is false.
Props
icon
(Optional)
Type: String
The name of the icon displayed in the component.
This should be one of the FontAwesome (v5 Pro) icon names with an optional style prefix ('far ' is the default prefix). For more info, see the Font Awesome concept page.
Default value
icon
After (Optional)
Type: String
The name of the icon displayed after the component.
This should be one of the FontAwesome (v5 Pro) icon names with an optional style prefix ('far ' is the default prefix). For more info, see the Font Awesome concept page.
Default value
is
Disabled (Optional)
Type: Boolean
Whether or not the component should be rendered in a disabled state.
Default value
is
Hovered (Optional)
Type: Boolean
Whether or not the component is currently hovered.
Default value
is
Selected (Optional)
Type: Boolean
Whether or not the component should be rendered in a selected state.
Default value
key
Binding Label (Optional)
Type: String
The human readable label indicating a key binding (shortcut) displayed in the component.
Default value
label
(Optional)
Type: String
The human readable label displayed in the component.
Default value
on
Click (Optional)
Type: Function
A callback that is called whenever the component is clicked and is not in a disabled state.
For more information about React and "events", check the React documentation
Arguments
Default value
on
Mouse Enter (Optional)
Type: Function
A callback that is called whenever the pointer is moved over the component. This callback is only fired when the pointer enters the component.
For more information about React and "events", check the React documentation
Arguments
Default value
on
Mouse Leave (Optional)
Type: Function
A callback that is called whenever the pointer is moved off the component. This callback is only fired when the pointer leaves the component.
For more information about React and "events", check the React documentation
Arguments
Default value
on
Ref (Optional)
Type: Function
A callback that is called whenever a component's ref changes.
Use this callback to get a ref to (the domNode of) a component. There shouldn't be many usecases for using this prop yourself, but you might have to implement it with a given argument from a render callback somewhere.
For more information about React and "refs", check the React documentation
Arguments
Returns
Default value
tooltip
Content (Optional)
Type: String | ReactElement
The content of the tooltip that is displayed when hovering over the whole component.
-
string: the textual content of the tooltip
-
ReactElement: a React Element (instance of a React Component, usually created with JSX)
Default value
-