Skip to main content

Interface: SelectionActionAnnotateProps

Defined in: widgets/selectionAction.tsx:834

Props for SelectionActionAnnotate component.

See​

SelectionActionAnnotate

Extends​

Properties​

PropertyTypeDescriptionInherited from

className?

string

Additional CSS class for the component.

SelectionActionStyleProps.className

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

initialContent?

null | AnnotationContent | GetInitialAnnotationContent

Initial annotation content.

Default

Translation.text('selection_action.annotate.defaultContent')

‐

title?

string

Title for the action button.

SelectionActionStyleProps.title