Skip to content

aceshooting/lyra-ui

Repository files navigation

Lyra UI: UI, made light 🪶 ✨

CI Coverage CodeQL OpenSSF Scorecard OpenSSF Best Practices docs website npm npm downloads npm weekly downloads Node.js Lit Web Components avg per component total gzip types license

Lyra UI constellation logo

A pnpm workspace hosting lyra-ui and its optional companion packages.

Browse the live docs site → — every component with a live example, source code, and API reference.

Lyra UI Conversation & Agent UI example: a chat message thread Lyra UI sortable table example Lyra UI line chart example

A few of 268 custom elements — browse them all live →

Table of Contents

Lyra UI is a free, independent alternative to Shoelace and Web Awesome. It is a MIT-licensed, framework-agnostic Lit web-component library for production interfaces: accessible form controls, navigation, overlays, dashboards, data visualization, file workflows, and a complete conversation and agent UI toolkit for chat products. It runs on native custom elements, has no runtime dependency on Shoelace or Web Awesome, and ships with its own design tokens, localization runtime, RTL support, reduced-motion behavior, and form-associated controls.

Lyra also makes migration practical. Selected components expose a documented Web Awesome-compatible surface under the lr- prefix, so many wa-* integrations can move through a mechanical tag-name and import change, with intentional differences documented per component. Shoelace users get a clear sl-*lr-* component map and migration notes; Lyra is an independent implementation, not a fork, rebrand, official product, or affiliated project. No Web Awesome Pro source code was available to or used by the maintainers.

The result is one open library for everyday UI, dashboards and charts, and AI chat/agent interfaces — with the broad component coverage of a general-purpose design system and original building blocks for data-heavy and streaming applications.

Package Description Version Size
packages/lyra-ui Free, independent Lit web components — an alternative to Shoelace and Web Awesome. npm avg per component total gzip
packages/lyra-flags Optional waving flag SVGs for <lr-flag>, kept out of lyra-ui's install by default. npm n/a — SVG assets, not a JS bundle

See each package's own README for full install/usage details.

Quick Start

npm install @aceshooting/lyra-ui
import '@aceshooting/lyra-ui/components/forms/combobox/combobox.js';
import '@aceshooting/lyra-ui/components/forms/combobox/option.js';
<lr-combobox label="Fruit" with-clear>
  <lr-option value="a">Apple</lr-option>
  <lr-option value="b">Banana</lr-option>
</lr-combobox>

Per-component optional peers and the tree-shakeable import patterns: packages/lyra-ui/README.md#install.

🔗 Open in StackBlitz — try it in-browser, no local install.

For local development of this monorepo:

pnpm install
pnpm build        # builds every package
pnpm test         # tests every package
pnpm lint         # typechecks every package
pnpm docs         # Storybook docs site demoing every component

Contributors and AI coding agents working on this repo: see AGENTS.md.

Principles & Guidelines

Principle Description
🆓 Free & Open Source MIT-licensed and free — nothing hidden inside
🪶 Lightweight & Tree-Shakeable Import only what you use — no dead weight
⚡ Performance-First Native custom elements, no virtual DOM, minimal deps
🤖 AI & Agentic-AI Ready Machine-readable docs and manifests AI agents use correctly
🧩 Consistent Architecture One shared base — learn one component, know them all
🎨 Design Tokens Only Every value is a --lr-* token — restyle from one place
🌍 i18n & RTL by Default Every string translatable, every layout mirrors RTL
♿ Accessibility First Correct ARIA in shadow DOM, automated a11y checks
📐 Responsive by Allocation Adapts to its container, not just the viewport
🎬 Motion-Aware Themeable timing, honors prefers-reduced-motion
🔗 Synchronized Public API Docs, tests, and manifest always match the code
🔒 Responsible Disclosure Private reporting, 90-day coordinated disclosure

Components

268 custom elements across eleven component families. Every tag has a live, interactive example on the docs site; for the full per-tag reference (Web Awesome mirror, props, events, slots, parts) see packages/lyra-ui/README.md#components.

The family name is also the import path — @aceshooting/lyra-ui/components/<family>/<name>.

Family Highlights
forms button, input, textarea, select, combobox, date picker, calendar, phone/token/file input, color and swatch pickers, emoji picker, locale picker, code editor, checkbox/radio/switch/slider, time range, rubric form
layout tabs, menu, command palette, breadcrumb, details, card, widget, split, stepper, carousel, scroller, app rail, dock panel, dashboard grid, drilldown panel, filter bar, segmented, virtual list, responsive panel
overlays dialog, drawer, overlay, toast, callout, badge, chip, kbd, rating, progress, spinner, skeleton, empty
data table, data grid, tree, timeline, calendar, gauge, heatmap, sparkline, word cloud, stat, pagination, query builder, flow canvas and nodes, sequence strip, file tree, env list, context meter
charts Chart.js-backed lr-chart (optional peer)
conversation chat message, composer and viewport, structured message parts, prompt input and queue, streaming text, markdown, code block, model select, realtime session, selection toolbar, thinking panel, branch picker, checkpoint, message actions and feedback, push-to-talk, audio visualizer, thread list
agent-tools agent run and trace, subagent panel, MCP app, prompt studio, schema viewer, tool call chip, tool approval dialog and approval queue, task list, terminal, span waterfall, stack trace, test results, activity feed, context inspector, artifact panel, commit card, eval dataset/run/result, evaluation dashboard, policy summary
retrieval retrieval search and results, retrieval comparison, grounded RAG answer, claim evidence, grounding summary, RAG evaluation dashboard, citation badge, chunk inspector, knowledge base and admin, ingestion queue, knowledge-graph explorer, graph, mind map, embedding explorer, entity card/chip/dossier, provenance panel, memory panel, neighbor list, path strip
viewers document, PDF, DOCX, PPTX, spreadsheet, CSV, notebook, ebook, email, calendar, contact, archive, XML, SVG, HTML and GeoJSON viewers, document compare and preview, dataset viewer, highlight layer, page rail
media image viewer and comparer, lightbox, zoomable frame, AV player, playback, animated image, avatar and avatar group, file icon, file input, attachment chip, map, QR code, flag
utility icon, format, copy and export buttons, diff view, JSON viewer, divider, live region, mention popover, tour, poll status, known date, resize/intersection/mutation observers

Theming, internationalization & RTL

Every one of the 268 tags is built on the same three guarantees — not opt-in per component:

  • Theming through --lr-* design tokens — retheme by overriding a custom property, no per-component theming API to learn.
  • Internationalization via a small runtime (registerLyraLocale/setLyraLocale, or a per-instance .strings override) — every built-in string (labels, announcements, aria-labels) is translatable without a rebuild or a per-locale bundle.
  • RTL with zero per-component opt-in — set dir="rtl" (or an RTL lang) anywhere up the tree and every component mirrors its layout and keyboard navigation to match.

See packages/lyra-ui/README.md#theming-internationalization--rtl for the full usage details.

Framework integration (React, Vue, Angular, Svelte)

Lyra ships plain custom elements — no framework-specific wrapper package needed.

// React 19+
import '@aceshooting/lyra-ui/components/forms/combobox/combobox.js';

<lr-combobox label="Fruit" with-clear>
  <lr-option value="a">Apple</lr-option>
</lr-combobox>
<!-- Vue -->
<lr-combobox label="Fruit" @lr-change="onChange" />
<!-- Angular — module/component needs schemas: [CUSTOM_ELEMENTS_SCHEMA] -->
<lr-combobox label="Fruit" (lr-change)="onChange($event)"></lr-combobox>
<!-- Svelte -->
<lr-combobox label="Fruit" on:lr-change={onChange} />

Property-vs-attribute binding, Angular's CUSTOM_ELEMENTS_SCHEMA, and event-name casing notes: packages/lyra-ui/README.md#framework-integration-vue-angular-svelte.

SSR & Declarative Shadow DOM

Lyra components are standard Lit 3 custom elements: they render through @lit-labs/ssr into Declarative Shadow DOM in principle, and a spot check of <lr-button> confirms basic server-rendering works — but the library has not been systematically tested or tuned for SSR at scale. See packages/lyra-ui/README.md#ssr--declarative-shadow-dom for details.

Browser & Node support

  • Node ≥ 20 to build/test this repo (engines.node); the published packages have no Node runtime dependency — they run in the browser.
  • Browsers — any evergreen browser with Custom Elements v1 + Shadow DOM support (Chrome, Edge, Firefox, Safari). CI runs the full test suite against Chromium plus a separate platform-contract suite against Firefox and WebKit, on Node 20 and 22.
  • Not tested against Internet Explorer or other browsers without native custom-element support.

Built with

  • Lit 3 — the web-component base every Lyra element extends
  • Floating UI — positioning engine for popovers, tooltips, dropdowns, and the combobox menu
  • Chart.js & D3 — optional peers powering the Chart.js chart family and <lr-graph>
  • Storybook — the live docs site and component workshop
  • Noto Emoji flag artwork — vendored into @aceshooting/lyra-flags (Public Domain)

Documentation

Claude Code plugin

@aceshooting/lyra-ui ships a Claude Code plugin so Claude gets the exact component API (not a guess from training data) while working in a project that depends on this library, plus commands for migrating off Web Awesome/Shoelace and auditing lyra-ui usage.

# Via Claude Code's plugin marketplace
/plugin marketplace add aceshooting/lyra-ui
/plugin install lyra-ui@aceshooting

Prefer a standalone download (e.g. for claude.ai Skills, outside Claude Code's plugin system)? Grab skills/lyra-ui.skill directly from this repo.

See plugins/lyra-ui for the plugin source, or packages/lyra-ui/llms.txt for the same component reference without Claude Code.

Status

@aceshooting/lyra-ui is published at 7.6.0; @aceshooting/lyra-flags at 2.0.0 — see each package's own CHANGELOG.md for release history. The two are versioned independently (not always lockstep) with Changesets and follow semver: a major bump signals a breaking change, everything else is additive or a fix. Every release passes the same CI gate as every PR (install, lint, test, build, manifest — see the badge above), and both packages are under active development, with new components and fixes shipping regularly.

License

MIT for the code. packages/lyra-flags ships third-party flag artwork vendored from Google's Noto Emoji project (Public Domain / copyright-exempt) — see its README for the sourcing details and upstream license text.


A UI library built with ❤️ by AI, for AI.

About

Free, independent Lit web components (268 elements) for accessible forms, dashboards, charts, and AI chat/agent interfaces — an alternative to Shoelace and Web Awesome.

Topics

Resources

Contributing

Security policy

Stars

Watchers

Forks

Releases

Packages

Used by

Contributors

Languages