mermaid/docs/config/setup/modules/defaultConfig.md

56 lines
1.3 KiB
Markdown
Raw Normal View History

2022-10-17 19:32:47 -03:00
# THIS IS AN AUTOGENERATED FILE. DO NOT EDIT. Please edit the corresponding file in src/docs.
2022-10-15 00:50:11 -03:00
# Module: defaultConfig
## Variables
### <a id="configkeys" name="configkeys"></a> configKeys
`Const` **configKeys**: `string`\[]
#### Defined in
2022-10-17 19:32:47 -03:00
[defaultConfig.ts:1855](https://github.com/emersonbottero/mermaid/blob/0da56a12/packages/mermaid/src/defaultConfig.ts#L1855)
2022-10-15 00:50:11 -03:00
---
### <a id="default" name="default"></a> default
`Const` **default**: `Partial`<`MermaidConfig`>
**Configuration methods in Mermaid version 8.6.0 have been updated, to learn more\[[click
here](8.6.0_docs.md)].**
## **What follows are config instructions for older versions**
These are the default options which can be overridden with the initialization call like so:
**Example 1:**
```js
mermaid.initialize({ flowchart: { htmlLabels: false } });
```
**Example 2:**
```js
let config = {
startOnLoad: true,
flowchart: { useMaxWidth: true, htmlLabels: true, curve: 'cardinal' },
securityLevel: 'loose',
};
mermaid.initialize(config);
```
A summary of all options and their defaults is found [here](#mermaidapi-configuration-defaults).
A description of each option follows below.
**`Name`**
Configuration
#### Defined in
2022-10-17 19:32:47 -03:00
[defaultConfig.ts:31](https://github.com/emersonbottero/mermaid/blob/0da56a12/packages/mermaid/src/defaultConfig.ts#L31)