API reference

Per-symbol pages for every public component, hook, and error type the SDK exports.

Sections

• Components — every React component on the happy path.
• Hooks — hook-level access to the same flows the components drive.
• Errors — RiftApiError, every registered code, and the typed extensions each one carries.

Page conventions

Every reference page follows the same shape so you can scan once and read the rest faster:

1. Intro — one sentence: what the symbol is and what it's for.
2. Basic usage — the smallest runnable code block.
3. Reference — the props table (components) or Parameters / Returns tables (hooks/functions). Every entry has its own H3 with description, default, and a code example where useful.
4. Examples — task-titled snippets showing common deviations from the basic-usage example.
5. Related — links forward to companion components, hooks, and guides.

A Version history section is added to each page once the SDK ships its first numbered release; while the surface is pre-release the section is omitted to avoid a false changelog signal.

Three callout styles appear throughout the reference, each with a specific meaning:

Note Neutral additional context that's worth knowing but doesn't block the reader.

Tip Non-essential improvement — a faster or cleaner way to do the same thing.

Warning The reader can damage state, lose data, or violate a contract. Always actionable.