mermaid - npm Package Compare versions

Comparing version 10.5.1 to 10.6.0

dist/config.type.d.ts

@@ -135,2 +135,3 @@ /**
     quadrantChart?: QuadrantChartConfig;
+    xyChart?: XYChartConfig;
     requirement?: RequirementDiagramConfig;
@@ -690,2 +691,190 @@ mindmap?: MindmapDiagramConfig;
 /**
+ * This object contains configuration for XYChart axis config
+ *
+ * This interface was referenced by `MermaidConfig`'s JSON-Schema
+ * via the `definition` "XYChartAxisConfig".
+ */
+export interface XYChartAxisConfig {
+    /**
+     * Should show the axis labels (tick text)
+     */
+    showLabel?: boolean;
+    /**
+     * font size of the axis labels (tick text)
+     */
+    labelFontSize?: number;
+    /**
+     * top and bottom space from axis label (tick text)
+     */
+    labelPadding?: number;
+    /**
+     * Should show the axis title
+     */
+    showTitle?: boolean;
+    /**
+     * font size of the axis title
+     */
+    titleFontSize?: number;
+    /**
+     * top and bottom space from axis title
+     */
+    titlePadding?: number;
+    /**
+     * Should show the axis tick lines
+     */
+    showTick?: boolean;
+    /**
+     * length of the axis tick lines
+     */
+    tickLength?: number;
+    /**
+     * width of the axis tick lines
+     */
+    tickWidth?: number;
+    /**
+     * Show line across the axis
+     */
+    showAxisLine?: boolean;
+    /**
+     * Width of the axis line
+     */
+    axisLineWidth?: number;
+}
+/**
+ * This object contains configuration specific to XYCharts
+ *
+ * This interface was referenced by `MermaidConfig`'s JSON-Schema
+ * via the `definition` "XYChartConfig".
+ */
+export interface XYChartConfig extends BaseDiagramConfig {
+    /**
+     * width of the chart
+     */
+    width?: number;
+    /**
+     * height of the chart
+     */
+    height?: number;
+    /**
+     * Font size of the chart title
+     */
+    titleFontSize?: number;
+    /**
+     * Top and bottom space from the chart title
+     */
+    titlePadding?: number;
+    /**
+     * Should show the chart title
+     */
+    showTitle?: boolean;
+    xAxis?: XYChartAxisConfig1;
+    yAxis?: XYChartAxisConfig2;
+    /**
+     * How to plot will be drawn horizontal or vertical
+     */
+    chartOrientation?: 'vertical' | 'horizontal';
+    /**
+     * Minimum percent of space plots of the chart will take
+     */
+    plotReservedSpacePercent?: number;
+}
+/**
+ * This object contains configuration for XYChart axis config
+ */
+export interface XYChartAxisConfig1 {
+    /**
+     * Should show the axis labels (tick text)
+     */
+    showLabel?: boolean;
+    /**
+     * font size of the axis labels (tick text)
+     */
+    labelFontSize?: number;
+    /**
+     * top and bottom space from axis label (tick text)
+     */
+    labelPadding?: number;
+    /**
+     * Should show the axis title
+     */
+    showTitle?: boolean;
+    /**
+     * font size of the axis title
+     */
+    titleFontSize?: number;
+    /**
+     * top and bottom space from axis title
+     */
+    titlePadding?: number;
+    /**
+     * Should show the axis tick lines
+     */
+    showTick?: boolean;
+    /**
+     * length of the axis tick lines
+     */
+    tickLength?: number;
+    /**
+     * width of the axis tick lines
+     */
+    tickWidth?: number;
+    /**
+     * Show line across the axis
+     */
+    showAxisLine?: boolean;
+    /**
+     * Width of the axis line
+     */
+    axisLineWidth?: number;
+}
+/**
+ * This object contains configuration for XYChart axis config
+ */
+export interface XYChartAxisConfig2 {
+    /**
+     * Should show the axis labels (tick text)
+     */
+    showLabel?: boolean;
+    /**
+     * font size of the axis labels (tick text)
+     */
+    labelFontSize?: number;
+    /**
+     * top and bottom space from axis label (tick text)
+     */
+    labelPadding?: number;
+    /**
+     * Should show the axis title
+     */
+    showTitle?: boolean;
+    /**
+     * font size of the axis title
+     */
+    titleFontSize?: number;
+    /**
+     * top and bottom space from axis title
+     */
+    titlePadding?: number;
+    /**
+     * Should show the axis tick lines
+     */
+    showTick?: boolean;
+    /**
+     * length of the axis tick lines
+     */
+    tickLength?: number;
+    /**
+     * width of the axis tick lines
+     */
+    tickWidth?: number;
+    /**
+     * Show line across the axis
+     */
+    showAxisLine?: boolean;
+    /**
+     * Width of the axis line
+     */
+    axisLineWidth?: number;
+}
+/**
  * The object containing configurations specific for entity relationship diagrams
@@ -692,0 +881,0 @@ *

dist/diagram-api/diagramAPI.d.ts

@@ -9,2 +9,5 @@ import type { DiagramDefinition, DiagramDetector } from './types.js';
 export declare const getConfig: () => import("../config.type.js").MermaidConfig;
+export declare const setConfig: (conf: import("../config.type.js").MermaidConfig) => import("../config.type.js").MermaidConfig;
+export declare const defaultConfig: import("../config.type.js").MermaidConfig;
+export declare const setSiteConfig: (conf: import("../config.type.js").MermaidConfig) => import("../config.type.js").MermaidConfig;
 export declare const sanitizeText: (text: string) => string;
@@ -11,0 +14,0 @@ export declare const setupGraphViewbox: (graph: any, svgElem: any, padding: any, useMaxWidth: any) => void;

dist/docs/vite.config.d.ts

@@ -1,2 +0,2 @@
-declare const _default: import("vite").UserConfigExport;
+declare const _default: import("vite").UserConfig;
 export default _default;

dist/rendering-util/createText.d.ts

@@ -0,1 +1,3 @@
+import type { Group } from '../diagram-api/types.js';
+export declare function computeDimensionOfText(parentNode: Group, lineHeight: number, text: string): DOMRect | undefined;
 export declare const createText: (el: any, text?: string, { style, isTitle, classes, useHtmlLabels, isNode, width, addSvgBackground, }?: {
@@ -2,0 +4,0 @@ style?: string | undefined;

dist/themes/theme-base.d.ts

@@ -145,2 +145,3 @@ export function getThemeVariables(userOverrides: any): Theme;
     quadrantTitleFill: any;
+    xyChart: any;
     requirementBackground: any;
@@ -147,0 +148,0 @@ requirementBorderColor: any;

dist/themes/theme-dark.d.ts

@@ -133,2 +133,3 @@ export function getThemeVariables(userOverrides: any): Theme;
     quadrantTitleFill: any;
+    xyChart: any;
     classText: any;
@@ -135,0 +136,0 @@ requirementBackground: any;

dist/themes/theme-default.d.ts

@@ -145,2 +145,3 @@ export function getThemeVariables(userOverrides: any): Theme;
     quadrantTitleFill: any;
+    xyChart: any;
     requirementBackground: any;
@@ -147,0 +148,0 @@ requirementBorderColor: any;

dist/themes/theme-forest.d.ts

@@ -142,2 +142,3 @@ export function getThemeVariables(userOverrides: any): Theme;
     quadrantTitleFill: any;
+    xyChart: any;
     requirementBackground: any;
@@ -144,0 +145,0 @@ requirementBorderColor: any;

dist/themes/theme-neutral.d.ts

@@ -138,2 +138,3 @@ export function getThemeVariables(userOverrides: any): Theme;
     quadrantTitleFill: any;
+    xyChart: any;
     requirementBackground: any;
@@ -140,0 +141,0 @@ requirementBorderColor: any;

dist/vitepress/vite.config.d.ts

@@ -1,2 +0,2 @@
-declare const _default: import("vite").UserConfigExport;
+declare const _default: import("vite").UserConfig;
 export default _default;

package.json

 {
   "name": "mermaid",
-  "version": "10.5.1",
+  "version": "10.6.0",
   "description": "Markdown-ish syntax for generating flowcharts, sequence diagrams, class diagrams, gantt charts and git graphs.",
@@ -5,0 +5,0 @@ "type": "module",

README.md

@@ -23,2 +23,5 @@ <p align="center">
 </p>
+<p align="center">
+Try Live Editor previews of future releases: <a href="https://develop.git.mermaid.live/" title="Try the mermaid version from the develop branch.">Develop</a> | <a href="https://next.git.mermaid.live/" title="Try the mermaid version from the next branch.">Next</a>
+</p>
 
@@ -35,3 +38,3 @@ <br>
 [![Join our Slack!](https://img.shields.io/static/v1?message=join%20chat&color=9cf&logo=slack&label=slack)](https://join.slack.com/t/mermaid-talk/shared_invite/enQtNzc4NDIyNzk4OTAyLWVhYjQxOTI2OTg4YmE1ZmJkY2Y4MTU3ODliYmIwOTY3NDJlYjA0YjIyZTdkMDMyZTUwOGI0NjEzYmEwODcwOTE)
-[![Twitter Follow](https://img.shields.io/badge/Social-mermaidjs__-blue?style=social&logo=twitter)](https://twitter.com/mermaidjs_)
+[![Twitter Follow](https://img.shields.io/badge/Social-mermaidjs__-blue?style=social&logo=X)](https://twitter.com/mermaidjs_)
 
@@ -38,0 +41,0 @@ <img src="./img/header.png" alt="" />

README.zh-CN.md

@@ -15,3 +15,3 @@ <p align="center">
 <p align="center">
-<a href="https://mermaid.live/"><b>Live Editor!</b></a>
+<a href="https://mermaid.live/"><b>实时编辑器!</b></a>
 </p>
@@ -25,2 +25,6 @@ <p align="center">
 
+<p align="center">
+尝试未来版本的实时编辑器预览: <a href="https://develop.git.mermaid.live/" title="尝试来自develop分支的mermaid版本。">Develop</a> | <a href="https://next.git.mermaid.live/" title="尝试来自next分支的mermaid版本。">Next</a>
+</p>
+
 <br>
@@ -36,3 +40,3 @@ <br>
 [![Join our Slack!](https://img.shields.io/static/v1?message=join%20chat&color=9cf&logo=slack&label=slack)](https://join.slack.com/t/mermaid-talk/shared_invite/enQtNzc4NDIyNzk4OTAyLWVhYjQxOTI2OTg4YmE1ZmJkY2Y4MTU3ODliYmIwOTY3NDJlYjA0YjIyZTdkMDMyZTUwOGI0NjEzYmEwODcwOTE)
-[![Twitter Follow](https://img.shields.io/badge/Social-mermaidjs__-blue?style=social&logo=twitter)](https://twitter.com/mermaidjs_)
+[![Twitter Follow](https://img.shields.io/badge/Social-mermaidjs__-blue?style=social&logo=X)](https://twitter.com/mermaidjs_)
 
@@ -39,0 +43,0 @@ <img src="./img/header.png" alt="" />

New alerts

License Policy Violation

License

This package is not allowed per your license policy. Review the package's license to ensure compliance.

Found 1 instance in 1 package

Major refactor

Supply chain risk

Package has recently undergone a major refactor. It may be unstable or indicate significant internal changes. Use caution when updating to versions that include significant changes.

Found 1 instance in 1 package

Fixed alerts

License Policy Violation

License

This package is not allowed per your license policy. Review the package's license to ensure compliance.

Found 1 instance in 1 package

Major refactor

Supply chain risk

Package has recently undergone a major refactor. It may be unstable or indicate significant internal changes. Use caution when updating to versions that include significant changes.

Found 1 instance in 1 package

Improved metrics

Total package byte prevSize

21586558

increased by1.75%

Number of package files

331

increased by6.43%

Lines of code

336075

increased by1.92%

Number of lines in readme file

421

increased by0.72%

No dependency changes