API reference
The reference is generated from the TypeScript declarations of @open-symbols/core and @open-symbols/react with TypeDoc, so it cannot drift from the shipped types. It covers the wider unions (named weights, replace, rendering modes held back from this release) that exist in the types but sit outside the 0.x public contract; the presets page states which parts are public.
Entry points
| Import | Contents |
|---|---|
@open-symbols/core | Engine, config, spring solver, method and preset registries, types, catalog accessors. |
@open-symbols/core/engine, /config, /spring, /types, /platform-web, /registry, /icons, /icons/all | Tree-shakable subpaths of the same modules. |
@open-symbols/core/icons/<slug> | One resolved IconDefinition per icon (default export and icon). |
@open-symbols/core/runtime, /contract, /loader | Catalog-free runtime for adapters; the public contract (PUBLIC_PRESETS, schema version); fetchIcon for the JSON distribution. |
@open-symbols/react | Lean root: registry-based Icon, registerIcons, SymbolProvider, useSymbolEffect, useReducedMotion, useReducedTransparency — no icon data included. |
@open-symbols/react/catalog | The same components resolving any of the 2,000 bundled icons by name, plus the catalog accessors. |
@open-symbols/react/core | useSymbolLifecycle and the injectable ticker for custom renderers. |