Skip to main content

Interface: DefaultWorkspaceProps

Defined in: src/workspace/defaultWorkspace.tsx:122

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.

‐

annotations?

null | Partial<AnnotationSupportProps>

Props for the AnnotationSupport canvas widget.

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

BaseDefaultWorkspaceProps.annotations

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.

Deprecated

Place additional widgets as direct children instead.

BaseDefaultWorkspaceProps.canvasWidgets

children?

ReactNode

Children to the Canvas component (e.g. additional widgets).

BaseDefaultWorkspaceProps.children

className?

string

Additional CSS class for the WorkspaceRoot component.

BaseDefaultWorkspaceProps.className

colorScheme?

"light" | "dark" | "auto"

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 | Partial<UnifiedSearchProps>

Props for the UnifiedSearch canvas widget.

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

Default:

{
    sections: [
        {
            key: 'elementTypes',
            label: t.text('default_workspace.search_section_entity_types.label'),
            title: t.text('default_workspace.search_section_entity_types.title'),
            component: <SearchSectionElementTypes />,
        },
        {
            key: 'entities',
            label: t.text('default_workspace.search_section_entities.label'),
            title: t.text('default_workspace.search_section_entities.title'),
            component: <SearchSectionEntities />,
        },
        {
            key: 'linkTypes',
            label: t.text('default_workspace.search_section_link_types.label'),
            title: t.text('default_workspace.search_section_link_types.title'),
            component: <SearchSectionLinkTypes />,
        },
    ]
}

‐

selection?

null | SelectionProps

Props for the Selection canvas widget.

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

BaseDefaultWorkspaceProps.selection

style?

CSSProperties

Additional CSS styles for the WorkspaceRoot component.

BaseDefaultWorkspaceProps.style

visualAuthoring?

VisualAuthoringProps

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