API reference
This section is a navigation hub, not a generated per-symbol reference. Hand-written guides under Components, Forms, Stores, Theming, Authentication, Primitives, and Services explain usage. Package .d.ts files remain the source of truth for exact TypeScript signatures.
How to use these docs
- Find the package and maturity label in the Package index.
- Open the linked live guide for that domain.
- Confirm prop and function details against the installed package types in your editor.
Do not expect auto-generated pages for every export. Prefer deep guides with examples, edge cases, and FAQs.
Start by domain
| Domain | Live docs | Typical packages |
|---|---|---|
| Stores | Stores, Store | @sometic/store, @sometic/store-immer |
| Theming | Theming | @sometic/theme |
| Authentication | Authentication | @sometic/auth, @sometic/auth-* |
| HTTP | HTTP, Services | @sometic/http |
| Components | Components | @sometic/react/*, @sometic/vue/*, @sometic/elements/* |
| Forms | Forms | @sometic/forms, @sometic/validation |
| Primitives | Primitives | core, events, styling, accessibility, dom, date-* |
| Frameworks | Frameworks | adapter packages |
| Concepts | Architecture and siblings | cross-cutting |
Stability labels
| Label | Meaning |
|---|---|
| Beta | Usable and tested; breaking changes may land in minors with changelog notes |
| Experimental | Wave B/C adapters and incomplete contracts; prefer React / Vue / Elements |
| Deferred | Not in this beta (for example picker UI polish, missing custom elements) |
Full wording: Beta maturity.
Shared prop conventions
Where a surface exposes value or style hooks, prefer these names:
value, defaultValue, onValueChange, disabled, readonly, required, invalid, loading, unstyled, classes, styles, cssVariables, size, variant
Controlled detection and ownership rules: Controlled state, Uncontrolled state.
Errors
Public failures use typed SometicError with stable codes (isSometicError helpers). Do not rely on legacy error class names from earlier product identity. See Beta maturity and Changelog.
What is not documented as shipped
The following are Deferred for this beta and must not be treated as public catalog APIs:
- Autocomplete polish, multi-select, tags, sliders, color picker
- Date / time picker UI
- Pagination, stepper, timeline, nav-menu chrome, split/resizable panes
- Floating UI positioning adapter
- Dedicated
sometic-*elements for data surfaces and app primitives
Menu, Combobox, Drawer, Tabs, Accordion, Command palette, Tree, data-table engines, and app primitive engines ship as listed in What’s included. Select and Popover are not substitutes for Menu or Combobox.
App primitives (feature flags, drafts, commands, history, conflict, offline queue, permissions) ship as engines. See App primitives.