Skip to content

Interface: MermaidOptions

Defined in: packages/core/src/mermaid.ts:32

Options for toMermaid.

Properties

direction?

ts
optional direction?: "TD" | "LR";

Defined in: packages/core/src/mermaid.ts:34

Flowchart orientation (default "TD", top-down).


resolveComponent?

ts
optional resolveComponent?: ResolveStructureComponent;

Defined in: packages/core/src/mermaid.ts:45

Classify a bare class as a sibling component — a child that is itself a documented record. Such nodes get the stadium shape, are labelled by component name, and (when an href is returned) link to that component's page. Absent → every non-slot, non-root node is a plain part.


self?

ts
optional self?: string;

Defined in: packages/core/src/mermaid.ts:39

The current record's base class, no leading dot (e.g. alert). Its top-level node renders as the diagram root; a descendant that references the same class stays a part, never a sibling component.

Released under the MIT License