Base Diagram Config Schema

https://mermaid.js.org/schemas/config.schema.json#/$defs/BaseDiagramConfig

Abstract	Extensible	Status	Identifiable	Custom Properties	Additional Properties	Access Restrictions	Defined In
Can be instantiated	No	Unknown status	No	Forbidden	Allowed	none	config.schema.json*

BaseDiagramConfig Type

object (Base Diagram Config)

BaseDiagramConfig Properties

Property	Type	Required	Nullable	Defined by
useWidth	number	Optional	cannot be null	Mermaid Config
useMaxWidth	boolean	Optional	cannot be null	Mermaid Config
theme	string	Optional	cannot be null	Mermaid Config
look	string	Optional	cannot be null	Mermaid Config
layout	string	Optional	cannot be null	Mermaid Config

useWidth

useWidth

• is optional

• Type: number

• cannot be null

• defined in: Mermaid Config

useWidth Type

number

useMaxWidth

When this flag is set to true, the height and width is set to 100% and is then scaled with the available space. If set to false, the absolute space required is used.

useMaxWidth

• is optional

• Type: boolean

• cannot be null

• defined in: Mermaid Config

useMaxWidth Type

boolean

useMaxWidth Default Value

The default value is:

true

theme

Theme, the CSS style sheet. You may also use themeCSS to override this value.

theme

• is optional

• Type: string

• cannot be null

• defined in: Mermaid Config

theme Type

string

theme Constraints

enum: the value of this property must be equal to one of the following values:

Value	Explanation
"default"
"base"
"dark"
"forest"
"neutral"
"neo"
"neo-dark"
"redux"
"redux-dark"
"redux-color"
"redux-dark-color"
"null"	Can be set to disable any pre-defined mermaid theme

look

Defines which main look to use for the diagram.

look

• is optional

• Type: string

• cannot be null

• defined in: Mermaid Config

look Type

string

look Constraints

enum: the value of this property must be equal to one of the following values:

Value	Explanation
"classic"
"handDrawn"
"neo"

layout

Defines which layout algorithm to use for rendering the diagram.

layout

• is optional

• Type: string

• cannot be null

• defined in: Mermaid Config

layout Type

string