FxOperationTextLink

How to get FxOperationTextLink

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

Type: Component

A text link that invokes and reflects the state of an operation.

Props

# Name Type Description
1. [colorName] String

The name of the color to use in the component. FDS has implemented a color palette for all of the components implemented in the library.

When building a custom component, try to use the existing colors as much as possible. Try to find an FDS component which is similar to the component you're building. When using colors this way, you can guarantee your component will use the correct color when the style of the library updates.

The possible values can be found in the example.

  Default value
"text-link-color"
  Related links
2. [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
3. [icon] String

The name of the icon displayed in the component.

For more information about the available icon names, check the https://fontawesome.com/v4.7.0/icons/

  Default value
null
4. [iconAfter] String

The name of the icon displayed after the component.

For more information about the available icon names, check the https://fontawesome.com/v4.7.0/icons/

  Default value
null
5. [isBold] Boolean

Whether or not the textual content of the component should be rendered in a bold font weight.

  Default value
false
6. [isDisabled] Boolean

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

  Default value
false
7. [label] String

The human readable label displayed in the component.

  Default value
null
8. [onClick] 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
# Name Type Description
1. event ReactSyntheticEvent
9. [onRef] 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
# Name Type Description
1. domNode HTMLElement

The domNode on which the component placed its ref callback attribute.

  Returns

Type: void

10. operationName String

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

11. [operationData] Object

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

  Default value
{}
12. [size] String

The size of font to render. The possible values are:

  • 's'

  • 'm'

Defaults to 'm'.


  Default value
"m"
13. [tooltipContent] 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
null