Skip to content
Browse documentation
whisk/ui

whisk/ui overview

Build accessible, themed Framework interfaces with shared foundations, styling props, and composable components.

Overview

Whisk/UI is Smoothie Framework's component toolkit and UI contract for building themed, accessible product interfaces. It gives hand-authored interfaces and validated generated UI the same foundations, component vocabulary, and theme model.

  • Start with the foundations and semantic tokens that define the visual language.
  • Prefer component props and theme tokens for shared interface rules. Use CSS for host-specific behavior that the component API does not express.
  • Choose an adapter for the rendering runtime your application owns.

Whisk/UI model

  • Native components: compose React components with ordinary application state and callbacks. You can also compose components with Octane, an independent JavaScript UI framework and the successor to Inferno. No catalog is required.
  • Validated generated UI: validate UI documents against an application-owned catalog before an adapter renders them.
  • Semantic events: send declared UI events to an application handler. Your application owns the resulting action, state change, and side effect.

Start here

Choose a React or Octane path to install Whisk/UI, load the shared styles, provide a theme, and render your first component.

Ownership

Whisk/UI provides the shared visual language, component semantics, theme contract, catalog validation, and renderer bindings. Your application owns data, state, business rules, actions, permissions, side effects, and surface lifecycle. Whisk/UI does not execute application actions or own application state.