From 463eb07979cc959f31ca0a22f444c11970664c18 Mon Sep 17 00:00:00 2001 From: nour kouider Date: Wed, 9 Apr 2025 11:31:40 +0100 Subject: [PATCH] fix(config.schema): add inheritDir to Flowchart config and regenerate types/docs --- .../setup/defaultConfig/variables/configKeys.md | 2 +- packages/mermaid/src/config.type.ts | 13 ++++++------- packages/mermaid/src/schemas/config.schema.yaml | 7 +++++++ 3 files changed, 14 insertions(+), 8 deletions(-) diff --git a/docs/config/setup/defaultConfig/variables/configKeys.md b/docs/config/setup/defaultConfig/variables/configKeys.md index ea65e33d6..4aa7405e1 100644 --- a/docs/config/setup/defaultConfig/variables/configKeys.md +++ b/docs/config/setup/defaultConfig/variables/configKeys.md @@ -12,4 +12,4 @@ > `const` **configKeys**: `Set`<`string`> -Defined in: [packages/mermaid/src/defaultConfig.ts:279](https://github.com/mermaid-js/mermaid/blob/master/packages/mermaid/src/defaultConfig.ts#L279) +Defined in: [packages/mermaid/src/defaultConfig.ts:278](https://github.com/mermaid-js/mermaid/blob/master/packages/mermaid/src/defaultConfig.ts#L278) diff --git a/packages/mermaid/src/config.type.ts b/packages/mermaid/src/config.type.ts index 4e38152c7..7ef4a71a4 100644 --- a/packages/mermaid/src/config.type.ts +++ b/packages/mermaid/src/config.type.ts @@ -226,12 +226,6 @@ export interface FlowchartDiagramConfig extends BaseDiagramConfig { * Defines a top/bottom margin for subgraph titles * */ - /** - * If true, subgraphs without explicit direction will inherit the global graph direction (e.g., LR, TB, RL, BT). - * Defaults to `false` to preserve legacy layout behavior. - */ - inheritDir?: boolean; - subGraphTitleMargin?: { top?: number; bottom?: number; @@ -301,12 +295,17 @@ export interface FlowchartDiagramConfig extends BaseDiagramConfig { * */ wrappingWidth?: number; + /** + * If true, subgraphs without explicit direction will inherit the global graph direction + * (e.g., LR, TB, RL, BT). Defaults to false to preserve legacy layout behavior. + * + */ + inheritDir?: boolean; } /** * This interface was referenced by `MermaidConfig`'s JSON-Schema * via the `definition` "BaseDiagramConfig". */ - export interface BaseDiagramConfig { useWidth?: number; /** diff --git a/packages/mermaid/src/schemas/config.schema.yaml b/packages/mermaid/src/schemas/config.schema.yaml index 48e113a94..128ae8f3e 100644 --- a/packages/mermaid/src/schemas/config.schema.yaml +++ b/packages/mermaid/src/schemas/config.schema.yaml @@ -2105,6 +2105,13 @@ $defs: # JSON Schema definition (maybe we should move these to a separate file) type: number default: 200 + inheritDir: + type: boolean + default: false + description: | + If true, subgraphs without explicit direction will inherit the global graph direction + (e.g., LR, TB, RL, BT). Defaults to false to preserve legacy layout behavior. + SankeyLinkColor: description: | Picks the color of the sankey diagram links, using the colors of the source and/or target of the links.