obix-component-toast
v0.5.0
Published
Compatibility name: obix-component-toast now resolves to obix-core-component. Contains no logic of its own — import from obix-core-component in new code.
Readme
obix-component-toast
Previous name:
@obinexusltd/obix-component-toast— OBIX packages are named without an npm scope since decision D-102 (2026-09-29); the package, its version and its exports are unchanged.
Compatibility package.
obix-component-toastis kept so that code and documents that import it keep resolving. It contains no logic: every export below is the export ofobix-core-componentunder the old name. New code should import fromobix-core-component.
Old package: npm:[email protected]. Decision: compat-shim (published name; listed in obix-naming.json (OBIX monorepo record) legacyShims) in docs/recovery/migration-table.md (OBIX monorepo record) — PUBLISHED (0.1.0): exports kept via a shim that re-exports the canonical definition..
obix-component-toast
| Old name | Is |
|---|---|
| createToast | obix-core-component.createToast |
| renderToast | renderWith(createToast) (from obix-core-component) |
Types: ToastConfig, ToastPosition, ToastState, ToastType.
Types the old package exported that the owner does not have (TypeScript consumers importing them must switch): Action, DOPComponent.
Verification
test/shim.test.mjs imports both packages and asserts, for every entry point: each old name is identical (===) to the owner's export (or, for the derived renderX, behaves as renderWith(createX)); the shim exports exactly these names and nothing else; every excluded name is absent. Verified on Node 26.7 only.
Installation
npm install obix-component-toastBasic usage
// existing code keeps working under the old name…
import { createToast, renderToast } from 'obix-component-toast';
// …new code imports the owner: obix-core-componentAPI surface
obix-component-toast— 2 value exports:createToast,renderToast- Type declarations:
./dist/index.d.ts(and a declaration next to every JS entry point).
Architecture role
obix-component-toast is a compatibility package: it keeps an old name resolving and contains no logic — every export is the export of obix-core-component. New code imports from obix-core-component (or from the umbrella obix).
The architecture of OBIX — the package families and which packages are public API — is indexed in the umbrella: docs/architecture.md.
Package relationships
- Depends on (OBIX):
obix-core-component. - Used by (OBIX): no other OBIX package.
Testing
- 2 test files ship in the npm package (
test/): the evidence of the package's contract, published so that its verification can be inspected — not runtime code (no entry point reaches them). - Standalone: 2 of 2 — they read nothing outside the package.
- Run them with
npm test(node --test "test/*.test.mjs") in the OBIX monorepo, which provides the test tooling (Node's test runner, TypeScript) and the harness.
Documentation
- CHANGELOG.md
- The OBIX architecture index: obix/docs/architecture.md
Repository
- https://github.com/obinexus/obix-component-toast —
[email protected]:obinexus/obix-component-toast.git - Issues: https://github.com/obinexus/obix-component-toast/issues
- The repository is a clean export of the package from the OBIX monorepo. Its lineage — the sources it was recovered from and its earlier names — is
PROVENANCE.json, shipped in this package; the repository's copy also records the monorepo commit it was exported from.
License
MIT — see LICENSE.
