mirror of
https://github.com/mermaid-js/mermaid.git
synced 2025-10-31 19:04:16 +01:00
4a7489a7b6
- covert `cSpell.json` to `cspell.config.yaml` - break up the word list into multiple dictionary files - fix spelling issues - Enable spell checking code for non-test files
437 lines
12 KiB
Markdown
437 lines
12 KiB
Markdown
> **Warning**
|
|
>
|
|
> ## THIS IS AN AUTOGENERATED FILE. DO NOT EDIT.
|
|
>
|
|
> ## Please edit the corresponding file in [/packages/mermaid/src/docs/config/accessibility.md](../../packages/mermaid/src/docs/config/accessibility.md).
|
|
|
|
# Accessibility Options
|
|
|
|
## Accessibility
|
|
|
|
Now with Mermaid library in much wider use, we have started to work towards more accessible features, based on the feedback from the community.
|
|
|
|
Adding accessibility means that the rich information communicated by visual diagrams can be made available to those using assistive technologies (and of course to search engines).
|
|
[Read more about Accessible Rich Internet Applications and the W3 standards.](https://www.w3.org/WAI/standards-guidelines/aria/)
|
|
|
|
Mermaid will automatically insert the [aria-roledescription](#aria-roledescription) and, if provided in the diagram text by the diagram author, the [accessible title and description.](#accessible-title-and-description)
|
|
|
|
### aria-roledescription
|
|
|
|
The [aria-roledescription](https://www.w3.org/TR/wai-aria-1.1/#aria-roledescription) for the SVG HTML element is set to the diagram type key. (Note this may be slightly different than the keyword used for the diagram in the diagram text.)
|
|
|
|
For example: The diagram type key for a state diagram is "stateDiagram". Here (a part of) the HTML of the SVG tag that shows the automatically inserted aria-roledescription set to "stateDiagram". _(Note that some of the SVG attributes and the SVG contents are omitted for clarity.):_
|
|
|
|
```html
|
|
<svg
|
|
aria-roledescription="stateDiagram"
|
|
class="statediagram"
|
|
xmlns="http://www.w3.org/2000/svg"
|
|
width="100%"
|
|
id="mermaid-1668720491568"
|
|
></svg>
|
|
```
|
|
|
|
### Accessible Title and Description
|
|
|
|
Support for accessible titles and descriptions is available for all diagrams/chart types. We have tried to keep the same keywords and format for all diagrams so that it is easy to understand and maintain.
|
|
|
|
The accessible title and description will add `<title>` and `<desc>` elements within the SVG element and the [aria-labelledby](https://www.w3.org/TR/wai-aria/#aria-labelledby) and [aria-describedby](https://www.w3.org/TR/wai-aria/#aria-describedby) attributes in the SVG tag.
|
|
|
|
Here is HTML that is generated, showing that the SVG element is labelled by the accessible title (id = `chart-title-mermaid-1668725057758`)
|
|
and described by the accessible description (id = `chart-desc-mermaid-1668725057758` );
|
|
and the accessible title element (text = "This is the accessible title")
|
|
and the accessible description element (text = "This is an accessible description").
|
|
|
|
_(Note that some of the SVG attributes and the SVG contents are omitted for clarity.)_
|
|
|
|
```html
|
|
<svg
|
|
aria-labelledby="chart-title-mermaid-1668725057758"
|
|
aria-describedby="chart-desc-mermaid-1668725057758"
|
|
xmlns="http://www.w3.org/2000/svg"
|
|
width="100%"
|
|
id="mermaid-1668725057758"
|
|
>
|
|
<title id="chart-title-mermaid-1668725057758">This is the accessible title</title>
|
|
<desc id="chart-desc-mermaid-1668725057758">This is an accessible description</desc>
|
|
</svg>
|
|
```
|
|
|
|
Details for the syntax follow.
|
|
|
|
#### accessible title
|
|
|
|
The **accessible title** is specified with the **accTitle** _keyword_, followed by a colon (`:`), and the string value for the title.
|
|
The string value ends at the end of the line. (It can only be a single line.)
|
|
|
|
Ex: `accTitle: This is a single line title`
|
|
|
|
See [the accTitle and accDescr usage examples](#acctitle-and-accdescr-usage-examples) for how this can be used in a diagram and the resulting HTML generated.
|
|
|
|
#### accessible description
|
|
|
|
An accessible description can be 1 line long (a single line) or many lines long.
|
|
|
|
The **single line accessible description** is specified with the **accDescr** _keyword_, followed by a colon (`:`), followed by the string value for the description.
|
|
|
|
Ex: `accDescr: This is a single line description.`
|
|
|
|
A **multiple line accessible description** _does not have a colon (`:`) after the accDescr keyword_ and is surrounded by curly brackets (`{}`).
|
|
|
|
Ex:
|
|
|
|
```markdown
|
|
accDescr {
|
|
This is a multiple line accessible description.
|
|
It does not have a colon and is surrounded by curly brackets.
|
|
}
|
|
```
|
|
|
|
See [the accTitle and accDescr usage examples](#acctitle-and-accdescr-usage-examples) for how this can be used in a diagram and the resulting HTML generated.
|
|
|
|
#### accTitle and accDescr Usage Examples
|
|
|
|
- Flowchart with the accessible title "Big Decisions" and the single-line accessible description "Bob's Burgers process for making big decisions"
|
|
|
|
```mermaid-example
|
|
graph LR
|
|
accTitle: Big Decisions
|
|
accDescr: Bob's Burgers process for making big decisions
|
|
A[Identify Big Decision] --> B{Make Big Decision}
|
|
B --> D[Be done]
|
|
```
|
|
|
|
```mermaid
|
|
graph LR
|
|
accTitle: Big Decisions
|
|
accDescr: Bob's Burgers process for making big decisions
|
|
A[Identify Big Decision] --> B{Make Big Decision}
|
|
B --> D[Be done]
|
|
```
|
|
|
|
Here is the HTML generated for the SVG element: _(Note that some of the SVG attributes and the SVG contents are omitted for clarity.):_
|
|
|
|
```html
|
|
<svg
|
|
aria-labelledby="chart-title-mermaid_382ee221"
|
|
aria-describedby="chart-desc-mermaid_382ee221"
|
|
aria-roledescription="flowchart-v2"
|
|
xmlns="http://www.w3.org/2000/svg"
|
|
width="100%"
|
|
id="mermaid_382ee221"
|
|
>
|
|
<title id="chart-title-mermaid_382ee221">Big decisions</title>
|
|
<desc id="chart-desc-mermaid_382ee221">Bob's Burgers process for making big decisions</desc>
|
|
</svg>
|
|
```
|
|
|
|
- Flowchart with the accessible title "Bob's Burger's Making Big Decisions" and the multiple line accessible description "The official Bob's Burgers corporate processes that are used
|
|
for making very, very big decisions.
|
|
This is actually a very simple flow: identify the big decision and then make the big decision."
|
|
|
|
```mermaid-example
|
|
graph LR
|
|
accTitle: Bob's Burger's Making Big Decisions
|
|
accDescr {
|
|
The official Bob's Burgers corporate processes that are used
|
|
for making very, very big decisions.
|
|
This is actually a very simple flow: identify the big decision and then make the big decision.
|
|
}
|
|
A[Identify Big Decision] --> B{Make Big Decision}
|
|
B --> D[Be done]
|
|
```
|
|
|
|
```mermaid
|
|
graph LR
|
|
accTitle: Bob's Burger's Making Big Decisions
|
|
accDescr {
|
|
The official Bob's Burgers corporate processes that are used
|
|
for making very, very big decisions.
|
|
This is actually a very simple flow: identify the big decision and then make the big decision.
|
|
}
|
|
A[Identify Big Decision] --> B{Make Big Decision}
|
|
B --> D[Be done]
|
|
```
|
|
|
|
Here is the HTML generated for the SVG element: _(Note that some of the SVG attributes and the SVG contents are omitted for clarity.):_
|
|
|
|
```html
|
|
<svg
|
|
aria-labelledby="chart-title-mermaid_382ee221"
|
|
aria-describedby="chart-desc-mermaid_382ee221"
|
|
aria-roledescription="flowchart-v2"
|
|
xmlns="http://www.w3.org/2000/svg"
|
|
width="100%"
|
|
id="mermaid_382ee221"
|
|
>
|
|
<title id="chart-title-mermaid_382ee221">Big decisions</title>
|
|
<desc id="chart-desc-mermaid_382ee221">
|
|
The official Bob's Burgers corporate processes that are used for making very, very big
|
|
decisions. This is actually a very simple flow: identify the big decision and then make the big
|
|
decision.
|
|
</desc>
|
|
</svg>
|
|
```
|
|
|
|
#### Sample Code Snippets for other diagram types
|
|
|
|
##### Class Diagram
|
|
|
|
```mermaid-example
|
|
classDiagram
|
|
accTitle: My Class Diagram
|
|
accDescr: My Class Diagram Description
|
|
|
|
Vehicle <|-- Car
|
|
```
|
|
|
|
```mermaid
|
|
classDiagram
|
|
accTitle: My Class Diagram
|
|
accDescr: My Class Diagram Description
|
|
|
|
Vehicle <|-- Car
|
|
```
|
|
|
|
##### Entity Relationship Diagram
|
|
|
|
```mermaid-example
|
|
erDiagram
|
|
accTitle: My Entity Relationship Diagram
|
|
accDescr: My Entity Relationship Diagram Description
|
|
|
|
CUSTOMER ||--o{ ORDER : places
|
|
ORDER ||--|{ LINE-ITEM : contains
|
|
CUSTOMER }|..|{ DELIVERY-ADDRESS : uses
|
|
|
|
```
|
|
|
|
```mermaid
|
|
erDiagram
|
|
accTitle: My Entity Relationship Diagram
|
|
accDescr: My Entity Relationship Diagram Description
|
|
|
|
CUSTOMER ||--o{ ORDER : places
|
|
ORDER ||--|{ LINE-ITEM : contains
|
|
CUSTOMER }|..|{ DELIVERY-ADDRESS : uses
|
|
|
|
```
|
|
|
|
##### Gantt Chart
|
|
|
|
```mermaid-example
|
|
gantt
|
|
accTitle: My Gantt Chart Accessibility Title
|
|
accDescr: My Gantt Chart Accessibility Description
|
|
|
|
title A Gantt Diagram
|
|
dateFormat YYYY-MM-DD
|
|
section Section
|
|
A task :a1, 2014-01-01, 30d
|
|
Another task :after a1 , 20d
|
|
section Another
|
|
Task in sec :2014-01-12 , 12d
|
|
another task : 24d
|
|
|
|
```
|
|
|
|
```mermaid
|
|
gantt
|
|
accTitle: My Gantt Chart Accessibility Title
|
|
accDescr: My Gantt Chart Accessibility Description
|
|
|
|
title A Gantt Diagram
|
|
dateFormat YYYY-MM-DD
|
|
section Section
|
|
A task :a1, 2014-01-01, 30d
|
|
Another task :after a1 , 20d
|
|
section Another
|
|
Task in sec :2014-01-12 , 12d
|
|
another task : 24d
|
|
|
|
```
|
|
|
|
##### Gitgraph
|
|
|
|
```mermaid-example
|
|
gitGraph
|
|
accTitle: My Gitgraph Accessibility Title
|
|
accDescr: My Gitgraph Accessibility Description
|
|
|
|
commit
|
|
commit
|
|
branch develop
|
|
checkout develop
|
|
commit
|
|
commit
|
|
checkout main
|
|
merge develop
|
|
commit
|
|
commit
|
|
|
|
```
|
|
|
|
```mermaid
|
|
gitGraph
|
|
accTitle: My Gitgraph Accessibility Title
|
|
accDescr: My Gitgraph Accessibility Description
|
|
|
|
commit
|
|
commit
|
|
branch develop
|
|
checkout develop
|
|
commit
|
|
commit
|
|
checkout main
|
|
merge develop
|
|
commit
|
|
commit
|
|
|
|
```
|
|
|
|
##### Pie Chart
|
|
|
|
```mermaid-example
|
|
pie
|
|
accTitle: My Pie Chart Accessibility Title
|
|
accDescr: My Pie Chart Accessibility Description
|
|
|
|
title Key elements in Product X
|
|
"Calcium" : 42.96
|
|
"Potassium" : 50.05
|
|
"Magnesium" : 10.01
|
|
"Iron" : 5
|
|
|
|
```
|
|
|
|
```mermaid
|
|
pie
|
|
accTitle: My Pie Chart Accessibility Title
|
|
accDescr: My Pie Chart Accessibility Description
|
|
|
|
title Key elements in Product X
|
|
"Calcium" : 42.96
|
|
"Potassium" : 50.05
|
|
"Magnesium" : 10.01
|
|
"Iron" : 5
|
|
|
|
```
|
|
|
|
##### Requirement Diagram
|
|
|
|
```mermaid-example
|
|
requirementDiagram
|
|
accTitle: My Requirement Diagram
|
|
accDescr: My Requirement Diagram Description
|
|
|
|
requirement test_req {
|
|
id: 1
|
|
text: the test text.
|
|
risk: high
|
|
verifymethod: test
|
|
}
|
|
|
|
element test_entity {
|
|
type: simulation
|
|
}
|
|
|
|
test_entity - satisfies -> test_req
|
|
|
|
```
|
|
|
|
```mermaid
|
|
requirementDiagram
|
|
accTitle: My Requirement Diagram
|
|
accDescr: My Requirement Diagram Description
|
|
|
|
requirement test_req {
|
|
id: 1
|
|
text: the test text.
|
|
risk: high
|
|
verifymethod: test
|
|
}
|
|
|
|
element test_entity {
|
|
type: simulation
|
|
}
|
|
|
|
test_entity - satisfies -> test_req
|
|
|
|
```
|
|
|
|
##### Sequence Diagram
|
|
|
|
```mermaid-example
|
|
sequenceDiagram
|
|
accTitle: My Sequence Diagram
|
|
accDescr: My Sequence Diagram Description
|
|
|
|
Alice->>John: Hello John, how are you?
|
|
John-->>Alice: Great!
|
|
Alice-)John: See you later!
|
|
```
|
|
|
|
```mermaid
|
|
sequenceDiagram
|
|
accTitle: My Sequence Diagram
|
|
accDescr: My Sequence Diagram Description
|
|
|
|
Alice->>John: Hello John, how are you?
|
|
John-->>Alice: Great!
|
|
Alice-)John: See you later!
|
|
```
|
|
|
|
##### State Diagram
|
|
|
|
```mermaid-example
|
|
stateDiagram
|
|
accTitle: My State Diagram
|
|
accDescr: My State Diagram Description
|
|
|
|
s1 --> s2
|
|
|
|
```
|
|
|
|
```mermaid
|
|
stateDiagram
|
|
accTitle: My State Diagram
|
|
accDescr: My State Diagram Description
|
|
|
|
s1 --> s2
|
|
|
|
```
|
|
|
|
##### User Journey Diagram
|
|
|
|
```mermaid-example
|
|
journey
|
|
accTitle: My User Journey Diagram
|
|
accDescr: My User Journey Diagram Description
|
|
|
|
title My working day
|
|
section Go to work
|
|
Make tea: 5: Me
|
|
Go upstairs: 3: Me
|
|
Do work: 1: Me, Cat
|
|
section Go home
|
|
Go downstairs: 5: Me
|
|
Sit down: 5: Me
|
|
|
|
```
|
|
|
|
```mermaid
|
|
journey
|
|
accTitle: My User Journey Diagram
|
|
accDescr: My User Journey Diagram Description
|
|
|
|
title My working day
|
|
section Go to work
|
|
Make tea: 5: Me
|
|
Go upstairs: 3: Me
|
|
Do work: 1: Me, Cat
|
|
section Go home
|
|
Go downstairs: 5: Me
|
|
Sit down: 5: Me
|
|
|
|
```
|