Skip to content

TreeView Diagram Config Schema ​

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

The object containing configurations specific for treeView diagrams.

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

TreeViewDiagramConfig Type ​

object (TreeView Diagram Config)

all of

TreeViewDiagramConfig Properties ​

PropertyTypeRequiredNullableDefined by
rowIndentnumberOptionalcannot be nullMermaid Config
paddingXnumberOptionalcannot be nullMermaid Config
paddingYnumberOptionalcannot be nullMermaid Config
lineThicknessnumberOptionalcannot be nullMermaid Config
showIconsbooleanOptionalcannot be nullMermaid Config
defaultIconPackstringOptionalcannot be nullMermaid Config
filenameIconsobjectOptionalcannot be nullMermaid Config
extensionIconsobjectOptionalcannot be nullMermaid Config

rowIndent ​

Horizontal distance between rows differing by one level

rowIndent

rowIndent Type ​

number

rowIndent Constraints ​

minimum: the value of this number must greater than or equal to: 0

rowIndent Default Value ​

The default value is:

json
10

paddingX ​

Horizontal padding of label

paddingX

paddingX Type ​

number

paddingX Constraints ​

minimum: the value of this number must greater than or equal to: 0

paddingX Default Value ​

The default value is:

json
5

paddingY ​

Vertical padding of label

paddingY

paddingY Type ​

number

paddingY Constraints ​

minimum: the value of this number must greater than or equal to: 0

paddingY Default Value ​

The default value is:

json
5

lineThickness ​

Thickness of the line

lineThickness

lineThickness Type ​

number

lineThickness Constraints ​

minimum: the value of this number must greater than or equal to: 0

lineThickness Default Value ​

The default value is:

json
1

showIcons ​

Whether to show the default file/folder icons next to labels. Explicit icon() annotations always render, regardless of this setting.

showIcons

showIcons Type ​

boolean

showIcons Default Value ​

The default value is:

json
false

defaultIconPack ​

Name of a registered iconify pack used to resolve unprefixed icon references — icon(name) annotations and filenameIcons/ extensionIcons values without a pack: prefix. The pack must be registered with registerIconPacks. When empty, unprefixed names resolve to the built-in file/folder icons.

defaultIconPack

defaultIconPack Type ​

string

defaultIconPack Default Value ​

The default value is:

json
""

filenameIcons ​

Exact-filename → icon map used to pick a file's icon when showIcons is enabled, e.g. { "Dockerfile": "material-icon-theme:docker" }. Values are resolved like icon() references: pack:name is used as-is, unprefixed names resolve via defaultIconPack, and none hides the icon for matching files.

filenameIcons

filenameIcons Type ​

object (Details)

filenameIcons Default Value ​

The default value is:

json
{}

extensionIcons ​

File-extension → icon map used to pick a file's icon when showIcons is enabled, e.g. { ".ts": "material-icon-theme:typescript" }. Keys are lowercase and may include or omit the leading dot. Values are resolved like icon() references: pack:name is used as-is, unprefixed names resolve via defaultIconPack, and none hides the icon for matching files.

extensionIcons

extensionIcons Type ​

object (Details)

extensionIcons Default Value ​

The default value is:

json
{}
Opens in mermaid.ai