Skip to main content

Interface: SelectionActionProps

Defined in: widgets/selectionAction.tsx:79

Props for SelectionAction component.

See

SelectionAction

Extends

Properties

PropertyTypeDescriptionInherited from

children?

ReactNode

Action content.

className?

string

Additional CSS class for the component.

SelectionActionStyleProps.className

disabled?

boolean

Whether the action is disabled.

dock

DockDirection

Dock side direction for the action around the selected elements.

SelectionActionStyleProps.dock

dockColumn?

number

Horizontal place shift for the action button (e.g. -1 for one place to the left, 1 for one place to the right).

SelectionActionStyleProps.dockColumn

dockRow?

number

Vertical place shift for the action button (e.g. -1 for one place above, 1 for one place below).

SelectionActionStyleProps.dockRow

hotkey?

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

Keyboard hotkey for the action when it's mounted.

Passing null disables a default hotkey if there is one.

SelectionActionStyleProps.hotkey

onMouseDown?

(e) => void

Raw handler for mouse down event on the action button.

onSelect?

() => void

Handler to call when the action is selected.

title?

string

Title for the action button.

SelectionActionStyleProps.title