Skip to main content

Interface: ToolbarActionExportProps

Defined in: widgets/toolbarAction.tsx:259

Props for ToolbarActionExport component.

See​

ToolbarActionExport

Extends​

Properties​

PropertyTypeDescriptionInherited from

children?

ReactNode

Action content.

‐

className?

string

Additional CSS class for the component.

ToolbarActionStyleProps.className

disabled?

boolean

Whether the action is disabled.

ToolbarActionStyleProps.disabled

fileName?

string

Exported file name without extension.

Only applicable when kind is exportRaster or exportSvg.

Default

"diagram"

‐

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.

ToolbarActionStyleProps.hotkey

kind

"print" | "exportRaster" | "exportSvg"

Export mode:

  • exportRaster - exports the diagram into a raster image file;
  • exportSvg - export the diagram into an SVG file;
  • print - prints the diagram.

‐

rasterOptions?

ExportRasterOptions

Export options (e.g. background color) for raster images.

Only applicable when kind is exportRaster.

Default

{backgroundColor: "white"}

‐

title?

string

Title for the action button or menu item.

ToolbarActionStyleProps.title