mirror of
https://github.com/ueberdosis/tiptap.git
synced 2024-12-04 03:29:03 +08:00
40 lines
2.5 KiB
Markdown
40 lines
2.5 KiB
Markdown
---
|
||
tableOfContents: true
|
||
---
|
||
|
||
# Accessibility
|
||
|
||
:::pro Fund the development ♥
|
||
We need your support to maintain, update, support and develop Tiptap. If you’re 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, there’s not much work done now. From our current understanding, that’s what needs to be done:
|
||
|
||
## Interface
|
||
An interface needs to have well-defined contrasts, big enough click areas, semantic markup, must be keyboard accessible and well documented. Currently, we don’t even provide an interface, so for now that’s totally up to you.
|
||
|
||
But no worries, we’ll provide an interface soon and take accessibility into account early on.
|
||
|
||
## Output
|
||
The editor needs to produce semantic markup, must be keyboard accessible and well documented. The Tiptap content is well structured so that’s a good foundation already. That said, we can add support and encourage the usage of additional attributes, for example the Alt-attribute for images.
|
||
|
||
### 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 |
|
||
| -------- | ------- | -------------------------------------------------------------------------------------- |
|
||
| 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) |
|
||
| WCAG 2.1 | 2.1.2 | [No Keyboard Trap](https://www.w3.org/TR/WCAG21/#no-keyboard-trap) |
|
||
|
||
TODO: Update resources to point to WCAG 3.0 https://www.w3.org/TR/wcag-3.0/
|
||
|
||
Anything we should add here? [Please let us know](mailto:humans@tiptap.dev), so we can take it into account.
|