Skip to Content
Changelog

Changelog

This page tracks changes to the public Orbz package and its documented component contract. The source of truth for code is the GitHub repository ; published artifacts are available on npm .

0.2.0 — Current repository version

Version 0.2.0 is the current project version. Publish status is managed separately from this documentation.

Component API

  • Replaced the open colors property and CSS-variable theming surface with a strict preset attribute/property or five custom color attributes.
  • Added six built-in presets: neongate, periwinkle, magenta, peach, mocha, and ivory.
  • Made preset mode and custom-color mode mutually exclusive. A conflicting runtime configuration reports a console error and applies the preset.
  • Added the elevated boolean control for a centered shadow.
  • Retained the five-state vocabulary, positive speed multiplier, pause/play controls, and system / always / never reduced-motion policies.

Integration and packaging

  • Tightened the React/Next.js adapter at @neongate-ai/orbz/react to accept only documented Orbz props. Arbitrary host props, children, style, className, and forwarded refs are no longer part of the adapter contract.
  • Changed the Shadow DOM from open to closed and removed public Shadow Parts; internal nodes, selectors, and CSS variables are now private implementation details.
  • Kept the native browser registration entry at @neongate-ai/orbz/browser and the standalone browser bundle at @neongate-ai/orbz/standalone.
  • Kept custom-element creation and registration guarded for server-rendered environments.
  • Added synchronized Vanilla, React, Vue, Svelte, Angular, and Next.js showcases built around the same interface.

Documentation

  • Replaced the initial VitePress scaffold with a Nextra documentation site.
  • Added getting-started, concepts, framework, microfrontend, SSR, voice assistant, API, examples, troubleshooting, and changelog areas.
  • Established https://orbz.site as the documentation destination and framework subdomains as example destinations.

0.1.0 — Initial public release

  • Published the first @neongate-ai/orbz package on npm.
  • Established Orbz as a framework-agnostic AI voice visual built with Web Components.
  • Shipped the five assistant states, motion-speed and pause controls, reduced-motion profiles, SSR-safe registration, browser and standalone entries, and the first React adapter.
  • Exposed color overrides through a colors property, public CSS variables, open Shadow DOM, and named Shadow Parts.

View 0.1.0 on npm

Migrating from 0.1.0

  • Replace the native colors property with color-primary, color-secondary, color-accent, color-highlight, and color-background attributes.
  • Remove CSS overrides targeting --orbz-* or ::part(...); choose a preset or pass the five supported colors instead.
  • Replace React’s colors object with the corresponding camel-cased color props, or pass preset.
  • Move React host styling, event handlers, accessibility text, and layout to a wrapper around <Orbz />.
  • Remove forwarded refs to the React adapter. Drive visual state through props; use the native element integration when imperative element methods are a hard requirement.

Versioning expectations

The documented attributes, properties, methods, exports, and strict adapter types are public API. Changes that remove or incompatibly redefine those contracts should require a major version. New backward-compatible presets, states, controls, or helpers can be minor releases; compatible fixes remain patch releases.

Examples and documentation may evolve without becoming part of the npm payload. They demonstrate the public package but do not define extra runtime surface area.

Last updated on
Troubleshooting