FxOperationButton

Type: React component

How to get FxOperationButton?

JavaScript

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

A compact button that invokes and reflects the state of an operation.

Props

  1. focusEditorWhenDone

    (Optional)

    Type: 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

  2. icon

    (Optional)

    Type: String

    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

  3. iconAfter

    (Optional)

    Type: String

    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

  4. isDisabled

    (Optional)

    Type: 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

  5. isHighlighted

    (Optional)

    Type: Boolean

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

  6. isSelected

    (Optional)

    Type: 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

  7. label

    (Optional)

    Type: String

    The label of the button. This overrides the label provided by the operation (operation.label).

    Default value

  8. onClick

    (Optional)

    Type: 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.

    Default value

  9. operationName

    (Required)

    Type: String

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

  10. operationData

    (Optional)

    Type: Object

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

    Default value

  11. tooltipContent

    (Optional)

    Type: String

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

    Default value

  12. type

    (Optional)

    Type: String

    Allows you to override the background and border color from its default values (which are based on the context where you use the button; masthead / masthead tab buttons / toolbar) to one of either:

    • 'default'

    • 'primary'

    • 'transparent'

    • 'warning'

    • 'error' Defaults to 'default', which is then interpreted based on the context.

    Please visit the Button playground example for visual examples for each type in each context.