Mermaid Editor SDK

@mermaid-editor-sdk/ui

@mermaid-editor-sdk/ui / EditorShellComponent

Interface: EditorShellComponent()

Defined in: package/ui/src/ui/components/EditorShell.tsx:33

EditorShell component with named compound regions for composing the editor layout.

Extends

EditorShellComponent(props): ReactNode | Promise<ReactNode>

Defined in: package/ui/src/ui/components/EditorShell.tsx:33

EditorShell component with named compound regions for composing the editor layout.

Parameters

ParameterType
propsEditorShellProps

Returns

ReactNode | Promise<ReactNode>

Properties

Actions

readonly Actions: FunctionComponent<EditorShellRegionProps>

Defined in: package/ui/src/ui/components/EditorShell.tsx:47

Region for header actions.

Canvas

readonly Canvas: FunctionComponent<EditorShellRegionProps>

Defined in: package/ui/src/ui/components/EditorShell.tsx:37

Region for the diagram canvas.

HeaderControls

readonly HeaderControls: FunctionComponent<EditorShellRegionProps>

Defined in: package/ui/src/ui/components/EditorShell.tsx:45

Region for diagram type and other header controls.

Selection

readonly Selection: FunctionComponent<EditorShellRegionProps>

Defined in: package/ui/src/ui/components/EditorShell.tsx:41

Region for the selection editor.

readonly Sidebar: FunctionComponent<EditorShellRegionProps>

Defined in: package/ui/src/ui/components/EditorShell.tsx:35

Region for sidebar content.

Source

readonly Source: FunctionComponent<EditorShellRegionProps>

Defined in: package/ui/src/ui/components/EditorShell.tsx:39

Region for the Mermaid source editor.

Status

readonly Status: FunctionComponent<EditorShellRegionProps>

Defined in: package/ui/src/ui/components/EditorShell.tsx:43

Region for the status message.