Skip to main content

Interface: LinkActionProps

Defined in: src/widgets/linkAction.tsx:109

Props for LinkAction component.

See​

LinkAction

Extends​

Properties​

PropertyTypeDescriptionInherited from

children?

ReactNode

Action content.

‐

className?

string

Additional CSS class for the component.

LinkActionStyleProps.className

disabled?

boolean

Whether the action is disabled.

‐

dockIndex

number

Place shift for the action button from the dockSide endpoint towards another endpoint (e.g. 1 for one place towards link target if dockSide is `source).

LinkActionStyleProps.dockIndex

dockSide

"source" | "target"

Link endpoint to place the action.

LinkActionStyleProps.dockSide

hotkey?

null | `Mod+${Capitalize<string>}` | `Ctrl+${Capitalize<string>}` | `Meta+${Capitalize<string>}` | `Alt+${Capitalize<string>}` | `Shift+${Capitalize<string>}` | `None+${Capitalize<string>}`

Keyboard hotkey for the action when it's mounted.

Passing null disables a default hotkey if there is one.

LinkActionStyleProps.hotkey

onMouseDown?

(e) => void

Raw handler for mouse down event on the action button.

‐

onPointerDown?

(e) => void

Raw handler for pointer down event on the action button.

‐

onSelect?

() => void

Handler to call when the action is selected.

‐

title?

string

Title for the action button.

LinkActionStyleProps.title