Skip to content

Commit

Permalink
Merge pull request #5730 from mermaid-js/sidv/cleanupLayoutElk
Browse files Browse the repository at this point in the history
chore: Cleanup layoutelk
  • Loading branch information
knsv authored Aug 21, 2024
2 parents f4097df + 9134e1c commit 0b9554c
Show file tree
Hide file tree
Showing 27 changed files with 1,271 additions and 1,154 deletions.
24 changes: 15 additions & 9 deletions cypress/platform/knsv2.html
Original file line number Diff line number Diff line change
Expand Up @@ -86,14 +86,20 @@
---
config:
look: handDrawn
flowchart:
htmlLabels: false
layout: elk
elk:
nodePlacementStrategy: BRANDES_KOEPF
---
flowchart
A[I am a long text, where do I go??? handdrawn - false]
flowchart TB
%% A --> C
B -- sdf sdf --> C{"Evaluate"}
C --> n4["salkdfjh akljd lkasdjf lkashj lksjadf klasdh"]
C --> F


</pre
>
<pre id="diagram" class="mermaid">
<pre id="diagram" class="mermaid2">
---
config:
look: handdrawn
Expand All @@ -106,7 +112,7 @@
>
</div>
<div class="flex">
<pre id="diagram" class="mermaid">
<pre id="diagram" class="mermaid2">
---
config:
flowchart:
Expand All @@ -116,7 +122,7 @@
A[I am a long text, where do I go??? classic - false]
</pre
>
<pre id="diagram" class="mermaid">
<pre id="diagram" class="mermaid2">
---
config:
flowchart:
Expand Down Expand Up @@ -159,8 +165,8 @@

<script type="module">
import mermaid from './mermaid.esm.mjs';
// import layouts from './mermaid-layout-elk.esm.mjs';
// mermaid.registerLayoutLoaders(layouts);
import layouts from './mermaid-layout-elk.esm.mjs';
mermaid.registerLayoutLoaders(layouts);
mermaid.parseError = function (err, hash) {
console.error('Mermaid error: ', err);
};
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -16,7 +16,7 @@

#### Defined in

[packages/mermaid/src/rendering-util/render.ts:11](https://github.com/mermaid-js/mermaid/blob/master/packages/mermaid/src/rendering-util/render.ts#L11)
[packages/mermaid/src/rendering-util/render.ts:25](https://github.com/mermaid-js/mermaid/blob/master/packages/mermaid/src/rendering-util/render.ts#L25)

---

Expand All @@ -26,7 +26,7 @@

#### Defined in

[packages/mermaid/src/rendering-util/render.ts:10](https://github.com/mermaid-js/mermaid/blob/master/packages/mermaid/src/rendering-util/render.ts#L10)
[packages/mermaid/src/rendering-util/render.ts:24](https://github.com/mermaid-js/mermaid/blob/master/packages/mermaid/src/rendering-util/render.ts#L24)

---

Expand All @@ -36,4 +36,4 @@

#### Defined in

[packages/mermaid/src/rendering-util/render.ts:9](https://github.com/mermaid-js/mermaid/blob/master/packages/mermaid/src/rendering-util/render.ts#L9)
[packages/mermaid/src/rendering-util/render.ts:23](https://github.com/mermaid-js/mermaid/blob/master/packages/mermaid/src/rendering-util/render.ts#L23)
69 changes: 13 additions & 56 deletions docs/config/setup/interfaces/mermaid.Mermaid.md

Large diffs are not rendered by default.

19 changes: 19 additions & 0 deletions docs/config/setup/interfaces/mermaid.RenderOptions.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,19 @@
> **Warning**
>
> ## THIS IS AN AUTOGENERATED FILE. DO NOT EDIT.
>
> ## Please edit the corresponding file in [/packages/mermaid/src/docs/config/setup/interfaces/mermaid.RenderOptions.md](../../../../packages/mermaid/src/docs/config/setup/interfaces/mermaid.RenderOptions.md).
# Interface: RenderOptions

[mermaid](../modules/mermaid.md).RenderOptions

## Properties

### algorithm

`Optional` **algorithm**: `string`

#### Defined in

[packages/mermaid/src/rendering-util/render.ts:8](https://github.com/mermaid-js/mermaid/blob/master/packages/mermaid/src/rendering-util/render.ts#L8)
8 changes: 4 additions & 4 deletions docs/config/setup/interfaces/mermaid.RunOptions.md
Original file line number Diff line number Diff line change
Expand Up @@ -18,7 +18,7 @@ The nodes to render. If this is set, `querySelector` will be ignored.

#### Defined in

[packages/mermaid/src/mermaid.ts:45](https://github.com/mermaid-js/mermaid/blob/master/packages/mermaid/src/mermaid.ts#L45)
[packages/mermaid/src/mermaid.ts:48](https://github.com/mermaid-js/mermaid/blob/master/packages/mermaid/src/mermaid.ts#L48)

---

Expand All @@ -44,7 +44,7 @@ A callback to call after each diagram is rendered.

#### Defined in

[packages/mermaid/src/mermaid.ts:49](https://github.com/mermaid-js/mermaid/blob/master/packages/mermaid/src/mermaid.ts#L49)
[packages/mermaid/src/mermaid.ts:52](https://github.com/mermaid-js/mermaid/blob/master/packages/mermaid/src/mermaid.ts#L52)

---

Expand All @@ -56,7 +56,7 @@ The query selector to use when finding elements to render. Default: `".mermaid"`

#### Defined in

[packages/mermaid/src/mermaid.ts:41](https://github.com/mermaid-js/mermaid/blob/master/packages/mermaid/src/mermaid.ts#L41)
[packages/mermaid/src/mermaid.ts:44](https://github.com/mermaid-js/mermaid/blob/master/packages/mermaid/src/mermaid.ts#L44)

---

Expand All @@ -68,4 +68,4 @@ If `true`, errors will be logged to the console, but not thrown. Default: `false

#### Defined in

[packages/mermaid/src/mermaid.ts:53](https://github.com/mermaid-js/mermaid/blob/master/packages/mermaid/src/mermaid.ts#L53)
[packages/mermaid/src/mermaid.ts:56](https://github.com/mermaid-js/mermaid/blob/master/packages/mermaid/src/mermaid.ts#L56)
33 changes: 32 additions & 1 deletion docs/config/setup/modules/mermaid.md
Original file line number Diff line number Diff line change
Expand Up @@ -20,11 +20,22 @@
- [MermaidConfig](../interfaces/mermaid.MermaidConfig.md)
- [ParseOptions](../interfaces/mermaid.ParseOptions.md)
- [ParseResult](../interfaces/mermaid.ParseResult.md)
- [RenderOptions](../interfaces/mermaid.RenderOptions.md)
- [RenderResult](../interfaces/mermaid.RenderResult.md)
- [RunOptions](../interfaces/mermaid.RunOptions.md)

## Type Aliases

### InternalHelpers

Ƭ **InternalHelpers**: typeof `internalHelpers`

#### Defined in

[packages/mermaid/src/internals.ts:33](https://github.com/mermaid-js/mermaid/blob/master/packages/mermaid/src/internals.ts#L33)

---

### ParseErrorFunction

Ƭ **ParseErrorFunction**: (`err`: `string` | [`DetailedError`](../interfaces/mermaid.DetailedError.md) | `unknown`, `hash?`: `any`) => `void`
Expand All @@ -48,6 +59,26 @@

[packages/mermaid/src/Diagram.ts:10](https://github.com/mermaid-js/mermaid/blob/master/packages/mermaid/src/Diagram.ts#L10)

---

### SVG

Ƭ **SVG**: `d3.Selection`<`SVGSVGElement`, `unknown`, `Element` | `null`, `unknown`>

#### Defined in

[packages/mermaid/src/diagram-api/types.ts:130](https://github.com/mermaid-js/mermaid/blob/master/packages/mermaid/src/diagram-api/types.ts#L130)

---

### SVGGroup

Ƭ **SVGGroup**: `d3.Selection`<`SVGGElement`, `unknown`, `Element` | `null`, `unknown`>

#### Defined in

[packages/mermaid/src/diagram-api/types.ts:132](https://github.com/mermaid-js/mermaid/blob/master/packages/mermaid/src/diagram-api/types.ts#L132)

## Variables

### default
Expand All @@ -56,4 +87,4 @@

#### Defined in

[packages/mermaid/src/mermaid.ts:442](https://github.com/mermaid-js/mermaid/blob/master/packages/mermaid/src/mermaid.ts#L442)
[packages/mermaid/src/mermaid.ts:440](https://github.com/mermaid-js/mermaid/blob/master/packages/mermaid/src/mermaid.ts#L440)
9 changes: 6 additions & 3 deletions packages/mermaid-layout-elk/package.json
Original file line number Diff line number Diff line change
Expand Up @@ -31,13 +31,16 @@
],
"license": "MIT",
"dependencies": {
"elkjs": "^0.9.3",
"d3": "^7.9.0"
"d3": "^7.9.0",
"elkjs": "^0.9.3"
},
"peerDependencies": {
"mermaid": "workspace:^"
},
"files": [
"dist"
]
],
"devDependencies": {
"@types/d3": "^7.4.3"
}
}
Loading

0 comments on commit 0b9554c

Please sign in to comment.