API stability
Every API in these docs carries a label that tells you how much you can rely on it.
| Label | Meaning |
|---|---|
| Stable | Supported, and kept compatible. A breaking change only comes in a major release, announced in the release notes with how to migrate. |
| Preview | Available and supported, but its shape may still change in a minor release. Changes are listed in the release notes. Good to use; expect small updates when you upgrade. |
Anything not in these docs is not public, even if your IDE shows it. It may change or disappear in any release without notice, so don't depend on it. If you need something that isn't documented, tell us: that's how Preview and Stable APIs are chosen.
What's stable
The integration path is stable on every platform:
- installing the license key and reading its status;
- creating, saving and reopening projects;
- adding media and text;
- showing the preview and the editor, and answering its requests with your own pickers;
- hiding built-in editor items;
- language and your own wording;
- registering fonts;
- undo, redo and change notifications;
- export.
What's in preview
The web SDK (@nitrakit/web and its React, Vue, Svelte and Angular packages) is in preview as
a whole.
Editing from code beyond adding media is in preview: moving, trimming and splitting clips, clip properties and keyframes, effects, transitions, animations, text styles, captions and links. These work today and are what the editor itself uses; their names and options may still be refined.
Built-in ids, such as effect, preset and font names, can be added or renamed between releases. Look them up at runtime from the catalogs the SDK provides instead of hard-coding them.
Versions
Nitrakit is in beta. Until 1.0, minor releases can include breaking changes to Preview APIs; Stable APIs only change if a beta finding makes it unavoidable, and the release notes say so.