Skip to content

Requirement Diagram Config Schema

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

The object containing configurations specific for req diagrams

AbstractExtensibleStatusIdentifiableCustom PropertiesAdditional PropertiesAccess RestrictionsDefined In
Can be instantiatedNoUnknown statusNoForbiddenAllowednoneconfig.schema.json*

RequirementDiagramConfig Type

object (Requirement Diagram Config)

all of

RequirementDiagramConfig Properties

PropertyTypeRequiredNullableDefined by
themestringOptionalcannot be nullMermaid Config
lookstringOptionalcannot be nullMermaid Config
rect_fillstringOptionalcannot be nullMermaid Config
text_colorstringOptionalcannot be nullMermaid Config
rect_border_sizestringOptionalcannot be nullMermaid Config
rect_border_colorstringOptionalcannot be nullMermaid Config
rect_min_widthnumberOptionalcannot be nullMermaid Config
rect_min_heightnumberOptionalcannot be nullMermaid Config
fontSizenumberOptionalcannot be nullMermaid Config
rect_paddingnumberOptionalcannot be nullMermaid Config
line_heightnumberOptionalcannot be nullMermaid Config

theme

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

theme

theme Type

string

theme Constraints

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

ValueExplanation
"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

theme Default Value

The default value is:

json
"redux-color"

look

Defines which main look to use for the diagram.

look

look Type

string

look Constraints

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

ValueExplanation
"classic"
"handDrawn"
"neo"

look Default Value

The default value is:

json
"neo"

rect_fill

rect_fill

rect_fill Type

string

rect_fill Default Value

The default value is:

json
"#f9f9f9"

text_color

text_color

text_color Type

string

text_color Default Value

The default value is:

json
"#333"

rect_border_size

rect_border_size

rect_border_size Type

string

rect_border_size Default Value

The default value is:

json
"0.5px"

rect_border_color

rect_border_color

rect_border_color Type

string

rect_border_color Default Value

The default value is:

json
"#bbb"

rect_min_width

rect_min_width

rect_min_width Type

number

rect_min_width Default Value

The default value is:

json
200

rect_min_height

rect_min_height

rect_min_height Type

number

rect_min_height Default Value

The default value is:

json
200

fontSize

fontSize

fontSize Type

number

fontSize Default Value

The default value is:

json
14

rect_padding

rect_padding

rect_padding Type

number

rect_padding Default Value

The default value is:

json
10

line_height

line_height

line_height Type

number

line_height Default Value

The default value is:

json
20
Opens in mermaid.ai