Skip to main content

Interface: DefaultWorkspaceProps

Props for DefaultWorkspace component.

See

DefaultWorkspace

Extends

  • BaseDefaultWorkspaceProps

Properties

PropertyTypeDescriptionInherited from

actions?

ReactNode

Content for the secondary (actions) toolbar, in a form of ToolbarAction elements.

If specified as null, the secondary toolbar will be hidden.

  • Default:
<>
<ToolbarActionUndo />
<ToolbarActionRedo />
<ToolbarActionLayout />
<ToolbarLanguageSelector languages={props.languages} />
</>

actionsToolbar?

Pick<ToolbarProps, "dock" | "dockOffsetX" | "dockOffsetY">

Additional props for the secondary (actions) toolbar.

canvas?

CanvasProps

Props for the Canvas component.

BaseDefaultWorkspaceProps.canvas

canvasWidgets?

readonly ReactElement<any, string | JSXElementConstructor<any>>[]

Additional widgets to pass as children to the Canvas component.

BaseDefaultWorkspaceProps.canvasWidgets

colorScheme?

"auto" | "dark" | "light"

Sets a color scheme for the UI components.

If set to auto, the component will track the following places in order:

  • <html data-theme="..."> attribute in case it is set to dark;
  • (prefers-color-scheme: dark) media query matches;
  • fallback to the default light color scheme otherwise.

Default

"auto"

BaseDefaultWorkspaceProps.colorScheme

connectionsMenu?

null | Omit<ConnectionsMenuProps, "commands">

Props for the ConnectionMenu canvas widget.

If specified as null, the component will not be rendered.

BaseDefaultWorkspaceProps.connectionsMenu

dropOnCanvas?

null | DropOnCanvasProps

Props for the DropOnCanvas canvas widget.

If specified as null, the component will not be rendered.

BaseDefaultWorkspaceProps.dropOnCanvas

halo?

null | HaloProps

Props for the Halo canvas widget.

If specified as null, the component will not be rendered.

BaseDefaultWorkspaceProps.halo

haloLink?

null | HaloLinkProps

Props for the HaloLink canvas widget.

If specified as null, the component will not be rendered.

BaseDefaultWorkspaceProps.haloLink

languages?

readonly WorkspaceLanguage[]

Set of languages for the diagram data language selector.

If not specified or empty, the selector will be hidden.

mainToolbar?

Pick<ToolbarProps, "dock" | "dockOffsetX" | "dockOffsetY">

Additional props for the primary (main) toolbar.

menu?

ReactNode

Main menu content, in a form of ToolbarAction elements.

If specified as null, the menu toggle button will be hidden.

Default:

<>
<ToolbarActionClearAll />
<ToolbarActionExport kind='exportRaster' />
<ToolbarActionExport kind='exportSvg' />
<ToolbarActionExport kind='print' />
</>

See

ToolbarProps.menu

navigator?

null | Partial<NavigatorProps>

Props for the Navigator canvas widget.

If specified as null, the component will not be rendered.

BaseDefaultWorkspaceProps.navigator

search?

null | UnifiedSearchProps

Props for the UnifiedSearch canvas widget.

If specified as null, the component will not be rendered.

selection?

null | SelectionProps

Props for the Selection canvas widget.

If specified as null, the component will not be rendered.

BaseDefaultWorkspaceProps.selection

visualAuthoring?

Omit<VisualAuthoringProps, "children" | "commands">

Props for the VisualAuthoring context component.

BaseDefaultWorkspaceProps.visualAuthoring

zoomControl?

null | Partial<ZoomControlProps>

Props for the ZoomControl canvas widget.

If specified as null, the component will not be rendered.

BaseDefaultWorkspaceProps.zoomControl