FxMultiOperationsMenuItem

How to get FxMultiOperationsMenuItem

import FxMultiOperationsMenuItem from 'fontoxml-fx/src/FxMultiOperationsMenuItem.jsx'

Type: Component

Renders a menu item that invokes and reflects the state of an operation. The first enabled or else the first operation in the operations array, is used in the menu item. This is updated every time the state of one of the operations changes.

Props

# Name Type Description
1. [focusEditorWhenDone] Boolean

Whether or not the given component should tell the editor (content view) to take back focus after its operation is done executing. By default this is has a value of null and is then determined at render time: its true if the component is placed inside the masthead or statusbar (including when used in drops or popovers triggered from the masthead or statusbar) and false otherwise.

Setting this prop to a value other than null or undefined forces that value for all renders, regardless of where the component is rendered.

  Default value
null
2. [icon] String

The icon that is displayed before the label. This overrides the icon provided by the operation (operation.icon) and provided by the operations array.

Use an icon in this 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
null
3. [isDisabled] Boolean

Set to true to render this component in a disabled state.

Setting it to false does not (re)enable it if the associated operation(s) are not enabled. This prevents users from executing operations that would cause errors or even break the document.

  Default value
false
4. [isSelected] Boolean

Set to true to render this component in a selected state.

Setting it to false does not force to deselected it if the associated operation(s) are active. This prevents users from getting misleading/inconsistent information from the underlying system.

If you never want to show the UI in a selected state for a particular operation, you can make and use a custom operation instead which ends with a final custom step that sets operationState.active to false. But breaking visual consistency this way with the rest of the editor is strongly discouraged and should only be used as a last resort.

  Default value
false
5. [label] String

The label of the menu item. This overrides the label provided by the operation (operation.label) and provided by the operations array.


  Default value
null
6. [onClick] Function

Add additional onClick callback. The callback is called when the user clicks on the component and at the same time the operation is executed.

7. operations Array<OperationSpec>

The first enabled or else the first operation in the list, is used in the menu item.


  OperationSpec

Type: Object

An array of operations with properties. Each operation will at least define the operation name. All other properties are there to add or override the original operation.

Properties

Name Type Description
[icon] String

Overrides the icon of the operation.

Use an icon in this 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.

[isDisabled] Boolean

Overrides the disabled state of the operation (!operationState.enabled).

Whether or not the component should be rendered in a disabled state.

[isSelected] Boolean

Overrides the selected state of the operation (operationState.active).

Whether or not the component should be rendered in a selected state.

[label] String

Overrides the label of the operation.

[operationData] Object

Additional operation data, which will be added to the stepData of the operation.

operationName String

The name by with the operation was registered. The component will be replaced with a CompactStateMessage if the operation is not found.

[tooltipContent] String

Overrides the tooltip content of the operation (operation.description).

The content of the tooltip that is displayed when hovering over the whole component.

8. [tooltipContent] String

The tooltip for the menu item. This overrides the tooltipContent provided by the operation (operation.description) and provided by the operations array.

The content of the tooltip that is displayed when hovering over the whole component.

  Default value
null
9. hoverHighlightType
  Default value
"contextual-operation-hover-highlight"
Was this page helpful?