marcel/mermaid
1
0
Fork 0
mirror of https://github.com/mermaid-js/mermaid.git synced 2025-09-17 22:39:56 +02:00
Code Issues Packages Projects Releases Wiki Activity
Files
d51ea942e11d1de2fdbc82ad075c3edfaa4d966b
mermaid/docs/config/setup/interfaces/mermaid.RunOptions.md
Sidharth Vinod bed6c5dd0c chore: Move icons to architecture 
We are planning to release an icons library separately. Till we figure out the APIs for those, all external surface for icons are removed, to avoid making a breaking change when the new library comes.
2024-08-28 21:04:21 +05:30

1.6 KiB
Raw Blame History

Warning

THIS IS AN AUTOGENERATED FILE. DO NOT EDIT.

Please edit the corresponding file in /packages/mermaid/src/docs/config/setup/interfaces/mermaid.RunOptions.md.

Interface: RunOptions

mermaid.RunOptions

Properties

nodes

• Optional nodes: ArrayLike<HTMLElement>

The nodes to render. If this is set, querySelector will be ignored.

Defined in

packages/mermaid/src/mermaid.ts:48

postRenderCallback

• Optional postRenderCallback: (id: string) => unknown

A callback to call after each diagram is rendered.

Type declaration

▸ (id): unknown

Parameters
Name Type
id string
Returns

unknown

Defined in

packages/mermaid/src/mermaid.ts:52

querySelector

• Optional querySelector: string

The query selector to use when finding elements to render. Default: ".mermaid".

Defined in

packages/mermaid/src/mermaid.ts:44

suppressErrors

• Optional suppressErrors: boolean

If true, errors will be logged to the console, but not thrown. Default: false

Defined in

packages/mermaid/src/mermaid.ts:56