Screen reader accessibility

Make custom shapes describe themselves to screen readers, and announce messages from your own UI.

Official example

The preview embeds the official tldraw examples site. tldraw hosts it and updates it from its main branch; JGuang does not copy the example source or the SDK.

• Open on the examples site: https://examples.tldraw.com/screen-reader-accessibility/full
• Example source (GitHub): https://github.com/tldraw/tldraw/tree/main/apps/examples/src/examples/ui/screen-reader-accessibility
• Category: UI & theming

Use it in a project

npm install tldraw@5.5.2

The examples site runs main-branch code, so some APIs may be newer than the stable npm release. Check APIs against your installed version before adapting an example. Import tldraw/tldraw.css and give the editor container an explicit size.

License

The tldraw SDK uses the tldraw license: development use is free, and production deployments need a valid license key (trial, commercial or hobby).

• Licensing details: https://tldraw.dev/community/license