marcel/mermaid
1
0
Fork 0
mirror of https://github.com/mermaid-js/mermaid.git synced 2025-08-29 21:26:51 +02:00
Code Issues Packages Projects Releases Wiki Activity

docs: Update new shape registration doc

Browse Source
This commit is contained in:
Sidharth Vinod
2024-10-03 22:12:41 +05:30
parent c5a19f6e85
commit 339c670839
2 changed files with 20 additions and 10 deletions
Download Patch File Download Diff File Expand all files Collapse all files

15
docs/adding-new-shape.md
View File

@@ -101,7 +101,7 @@ To add a new shape:
- **Example**: - **Example**:
```typescript ```typescript
import { Node, RenderOptions } from '../../types.d.ts'; import { Node, RenderOptions } from '../../types.ts';
export const myNewShape = async ( export const myNewShape = async (
parent: SVGAElement, parent: SVGAElement,
@@ -117,7 +117,7 @@ To add a new shape:
### 2. Register the Shape ### 2. Register the Shape
- **Register the shape**: Add your shape to the `shapes` object in the main shapes module. This allows your shape to be recognized and used within the system. - **Register the shape**: Add your shape to the `shapes` object in the [main shapes module](../rendering-util/rendering-elements/shapes.ts). This allows your shape to be recognized and used within the system.
- **Example**: - **Example**:
@@ -126,9 +126,14 @@ To add a new shape:
const shapes = { const shapes = {
..., ...,
'my-new-shape': myNewShape, {
// Shortened alias (if any). semanticName: 'My Shape',
'm-nsh': myNewShape name: 'Shape Name',
shortName: '<short-name>',
description: '<Description for the shape>',
aliases: ['<alias-one>', '<al-on>', '<alias-two>', '<al-two>'],
handler: myNewShape,
},
}; };
``` ```

15
packages/mermaid/src/docs/adding-new-shape.md
View File

@@ -95,7 +95,7 @@ To add a new shape:
- **Example**: - **Example**:
```typescript ```typescript
import { Node, RenderOptions } from '../../types.d.ts'; import { Node, RenderOptions } from '../../types.ts';
export const myNewShape = async ( export const myNewShape = async (
parent: SVGAElement, parent: SVGAElement,
@@ -111,7 +111,7 @@ To add a new shape:
### 2. Register the Shape ### 2. Register the Shape
- **Register the shape**: Add your shape to the `shapes` object in the main shapes module. This allows your shape to be recognized and used within the system. - **Register the shape**: Add your shape to the `shapes` object in the [main shapes module](../rendering-util/rendering-elements/shapes.ts). This allows your shape to be recognized and used within the system.
- **Example**: - **Example**:
@@ -120,9 +120,14 @@ To add a new shape:
const shapes = { const shapes = {
..., ...,
'my-new-shape': myNewShape, {
// Shortened alias (if any). semanticName: 'My Shape',
'm-nsh': myNewShape name: 'Shape Name',
shortName: '<short-name>',
description: '<Description for the shape>',
aliases: ['<alias-one>', '<al-on>', '<alias-two>', '<al-two>'],
handler: myNewShape,
},
}; };
``` ```