Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add named composite state example to stateDiagram-v2 #5485

Merged
merged 4 commits into from
Apr 26, 2024
Merged

Add named composite state example to stateDiagram-v2 #5485

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
8d9cb09
Update stateDiagram.md
cbugk Apr 19, 2024
718811b
Update stateDiagram.md
cbugk Apr 19, 2024
e49c95c
chore: Fix typo
sidharthv96 Apr 26, 2024
3000f02
Merge branch 'develop' into develop
sidharthv96 Apr 26, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
18 changes: 17 additions & 1 deletion docs/syntax/stateDiagram.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -160,7 +160,7 @@ In a real world use of state diagrams you often end up with diagrams that are mu
have several internal states. These are called composite states in this terminology.

In order to define a composite state you need to use the state keyword followed by an id and the body of the composite
state between {}. See the example below:
state between {}. You can name a composite state on a separate line just like a simple state. See the example below:

```mermaid-example
stateDiagram-v2
Expand All @@ -169,6 +169,14 @@ stateDiagram-v2
[*] --> second
second --> [*]
}

[*] --> NamedComposite
NamedComposite: Another Composite
state NamedComposite {
[*] --> namedSimple
namedSimple --> [*]
namedSimple: Another simple
}
```

```mermaid
Expand All @@ -178,6 +186,14 @@ stateDiagram-v2
[*] --> second
second --> [*]
}

[*] --> NamedComposite
NamedComposite: Another Composite
state NamedComposite {
[*] --> namedSimple
namedSimple --> [*]
namedSimple: Another simple
}
```

You can do this in several layers:
Expand Down
10 changes: 9 additions & 1 deletion packages/mermaid/src/docs/syntax/stateDiagram.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -98,7 +98,7 @@ In a real world use of state diagrams you often end up with diagrams that are mu
have several internal states. These are called composite states in this terminology.

In order to define a composite state you need to use the state keyword followed by an id and the body of the composite
state between \{\}. See the example below:
state between \{\}. You can name a composite state on a separate line just like a simple state. See the example below:

```mermaid-example
stateDiagram-v2
Expand All @@ -107,6 +107,14 @@ stateDiagram-v2
[*] --> second
second --> [*]
}

[*] --> NamedComposite
NamedComposite: Another Composite
state NamedComposite {
[*] --> namedSimple
namedSimple --> [*]
namedSimple: Another simple
}
```

You can do this in several layers:
Expand Down
Loading