Skip to content

Reference

Seven pages generated from the source at build time — so what they list is what the version you installed ships — and one declared by hand and measured against it. Each answers one question:

PageThe question it answers
The UI kit — classesWhich ready-made classes can I put on my own elements? Every class on one page. Buttons, fields, switches, tags, alerts, menus, tabs, avatars — plain classes on plain elements, themed by the same variables as the chat, with their HTML verbatim. To see them first, one family per page, start at the UI kit.
CSS variablesWhich --aparte-* token do I set to change this? Every declared variable with its default, and the ones a component reads with a fallback.
EventsWhat does aparté dispatch, with what detail? The kebab-case event map, one row per event.
ConfigWhat can aparteGlobalConfig (or a per-chat AparteConfig) be told? Providers, transports, renderers, hooks, host handlers.
EngineWhat does @aparte/engine export? The loop and its run events.
WrappersWhat is the same on React, Vue, Svelte and Angular? The one imperative contract and how each framework spells it.
IconsWhich glyphs exist, and how do I swap them? The built-in set and the extended set behind @aparte/core/icons.
Support matrixDoes it run where my users are? The browser, Node, framework, bundler and TypeScript floors — each derived from what the code uses — beside the versions CI runs.