Underglass documentation
Start here if you are using Underglass or writing components for it.
- Getting started: requirements, install, your first layer, enabling GPU.
- Concepts: the two modes, layers, admission, what the GPU adds over CSS.
- Motion: transitions, groups,
Presence, animation ownership. - Effects: built-in effects and your own WGSL.
- Building components: the standard for components that work in Underglass.
- Troubleshooting: every fallback reason and its fix.
- Other frameworks and plain DOM: the core runtime without React, and writing an adapter.
Reference
Section titled “Reference”- API reference: every export, option and contract.
- Effects contract: effect validation, time and fallback rules in detail.
- Worker compositor: the experimental worker path.
- Distribution: packing and installing the library.
- Showcase: the example gallery and its deployment.
Contributing
Section titled “Contributing”- Architecture and the GPU-first contract.
- Open issues: known limits and unperformed validation.
- Releasing: versions, changesets, the Release workflow and how to enable publishing.
- Change notes: the notes written before Changesets, kept as history.
- GPU browser tests in CI: the self-hosted GPU runner.
- 3D UI library plan: proposal for a component library with its own 3D design language.
- Instrument level plan: proposed 3D-first hardware components (knobs, faders, switches, lamps) as a fourth Strata level.
- Strata design language: the spec and tokens of the 3D UI library.
- Archive: the phase-by-phase engineering history, measurements and verification records.