Skip to content

docs: add browser requirements section to README #30

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

Open
Luc0-0 wants to merge 1 commit into
base: main
Choose a base branch
from
Open

docs: add browser requirements section to README #30

Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
10 changes: 10 additions & 0 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -127,6 +127,16 @@ clearCache(): void // clears Pretext's shared internal caches used by prepare()
setLocale(locale?: string): void // optional (by default we use the current locale). Sets locale for future prepare() and prepareWithSegments(). Internally, it also calls clearCache(). Setting a new locale doesn't affect existing prepare() and prepareWithSegments() states (no mutations to them)
```

## Browser Requirements

Pretext uses [`Intl.Segmenter`](https://developer.mozilla.org/en-US/docs/Web/API/Intl/Segmenter) for word segmentation and the Canvas 2D API (`measureText`) for font metrics. Both are required at runtime.

- Chrome/Edge 87+
- Firefox 125+ (April 2024)
- Safari 15+

Older browsers — including Firefox before 125 — will throw `Intl.Segmenter is not a constructor`. There is no polyfill path currently.

## Caveats

Pretext doesn't try to be a full font rendering engine (yet?). It currently targets the common text setup:
Expand Down