tiptap/docs/guide/accessibility.md

40 lines
2.5 KiB
Markdown
Raw Normal View History

---
tableOfContents: true
---
# Accessibility
2021-02-06 03:37:09 +08:00
:::pro Fund the development ♥
2021-04-16 03:48:19 +08:00
We need your support to maintain, update, support and develop tiptap. If youre waiting for progress here, [become a sponsor and fund our work](/sponsor).
:::
## Introduction
We strive to make tiptap accessible to everyone, but to be honest, theres not much work done now. From our current understanding, thats what needs to be done:
2021-02-05 00:33:59 +08:00
## Interface
2021-01-21 06:19:33 +08:00
An interface needs to have well-defined contrasts, big enough click areas, semantic markup, must be keyboard accessible and well documented. Currently, we dont even provide an interface, so for now thats totally up to you.
But no worries, well provide an interface soon and take accessibility into account early on.
2021-03-25 16:48:47 +08:00
## Output
The editor needs to produce semantic markup, must be keyboard accessible and well documented. The tiptap content is well structured so thats a good foundation already. That said, we can add support and encourage the usage of additional attributes, for example the Alt-attribute for images.
2021-03-25 16:48:47 +08:00
### Writing assistance (optional)
An optional writing assitance could help people writing content semanticly correct, for example pointing out an incorrect usage of heading levels. With that kind of assistance provided by the core developers, we could help to improve the content of a lot of applications.
## Resources
| Document | Section | Heading |
| -------- | ------- | -------------------------------------------------------------------------------------- |
2021-02-03 23:36:24 +08:00
| WCAG 3.0 | 7.1 | [Text Alternatives](https://www.w3.org/TR/wcag-3.0/#text-alternatives) |
| WCAG 2.1 | 1.1.1 | [Non-text Content](https://www.w3.org/WAI/WCAG21/Understanding/non-text-content) |
| WCAG 2.1 | 2.1 | [Keyboard Accessible](https://www.w3.org/WAI/WCAG21/Understanding/keyboard-accessible) |
| WCAG 2.1 | 2.1.1 | [Keyboard](https://www.w3.org/WAI/WCAG21/Understanding/keyboard) |
| WCAG 2.1 | 4.1.1 | [Parsing](https://www.w3.org/WAI/WCAG21/Understanding/parsing) |
| WCAG 2.1 | 4.1.2 | [Name, Role, Value](https://www.w3.org/WAI/WCAG21/Understanding/name-role-value) |
2021-02-03 23:36:24 +08:00
| WCAG 2.1 | 2.1.2 | [No Keyboard Trap](https://www.w3.org/TR/WCAG21/#no-keyboard-trap) |
2021-01-21 06:19:33 +08:00
2021-01-26 22:11:25 +08:00
TODO: Update resources to point to WCAG 3.0 https://www.w3.org/TR/wcag-3.0/
2021-02-09 00:39:50 +08:00
Anything we should add here? [Please let us know](mailto:humans@tiptap.dev), so we can take it into account.