@eagami/ui
v5.6.1
Published
Lightweight, accessible, themeable Angular UI component library and icon set built on CSS custom properties
Downloads
5,125
Maintainers
Readme
@eagami/ui is a lightweight, accessible Angular component library. Sensible defaults out of the box, with a fully customizable design to fit any brand.
Live documentation: eagami.com/ui
Try it live: open a starter on StackBlitz, no install needed.
Why Eagami UI
Angular teams usually reach for Angular Material, PrimeNG, or a Tailwind copy-paste kit like Spartan. Eagami UI is different where it counts:
- Themes to your brand. Give it one color per role and it generates a full, accessibility-checked palette; every other style is a CSS variable you can override (see design tokens). Light and dark are built in and follow the system preference.
- Lightweight. One runtime dependency (
tslib), no CSS framework, and standalone side-effect-free components, so your app bundles only what it imports (the whole library, every component and icon, is ~260 KB gzipped). - Accessible and localized out of the box. Every component is keyboard-navigable and screen-reader-ready, with built-in text in 15 languages you can switch at runtime.
- Yours to own. Plain Angular and CSS with no lock-in: read, copy, or fork any component like the rest of your app.
- Modern Angular. Signals, native control flow, and SSR-safe rendering throughout.
| | Eagami UI | Angular Material | PrimeNG | Spartan |
|---|---|---|---|---|
| Styling model | CSS custom properties | Sass / Material 3 tokens | Design tokens + presets | Tailwind, copy-paste |
| Re-skin to any brand | First-class | Within Material Design | Preset-based | You own the markup |
| Built-in text i18n | 15 languages, runtime | Provide your own | Provide your own | Your markup |
| Per-component a11y tests | Yes (axe-core) | Backed by the CDK | Varies by component | Your responsibility |
| Requires a CSS framework | No | No | No | Tailwind |
| Runtime dependencies | 1 (tslib) | Angular CDK | multiple | Tailwind |
Installation
The quickest way is the schematic, which installs the package and registers the global stylesheet and fonts for you:
ng add @eagami/uiPrefer to wire it up by hand? Install the package:
npm install @eagami/ui
# or
pnpm add @eagami/ui
# or
yarn add @eagami/uiThen add the global stylesheet to your angular.json:
"styles": ["node_modules/@eagami/ui/src/styles/eagami-ui.scss"]See the Setup page for fonts and your first component import.
What's included
- Actions: Button, Command Palette
- Form controls: Autocomplete, Avatar Editor, Checkbox, Code Input, Color Picker, Date Picker, Dropdown, File Uploader, Input, Multi-Select, Radio, Range Slider, Rating, Segmented, Slider, Switch, Textarea, Time Picker, Transfer List
- Overlays: Dialog, Drawer, Menu, Popover, Toast, Tooltip
- Navigation: Breadcrumbs, Paginator, Stepper, Tabs
- Display: Accordion, Alert, Avatar, Badge, Card, Data Table, Divider, Eagami Wordmark, Empty State, Progress Bar, Skeleton, Spinner, Tag, Tree, Virtual List
Full API and live demos at eagami.com/ui/components.
Icons
Standalone Angular components (<ea-icon-*>) that inherit their color and scale with font-size, so they render at any size. The library ships the full Feather Icons set (287 icons at their canonical slugs) by Cole Bemis, used under the MIT License, plus additional line icons from Lucide (ISC License), a set of original Eagami UI additions (basic shapes, household objects, the Eagami brand mark), and a coloured brand-icon set for nominative use that includes marks from Simple Icons (CC0).
Each icon component exposes static readonly metadata so consumers can build catalogues, search indices, or doc tables without importing every icon:
import { GithubIconComponent } from '@eagami/ui';
GithubIconComponent.slug; // 'github'
GithubIconComponent.category; // 'feather'
GithubIconComponent.isBrand; // true
GithubIconComponent.tags; // ['github', 'git', 'repository', ...]The shape of this metadata is described by the exported IconCategory, IconMeta, and IconComponentType types. Every icon component extends the abstract IconComponentBase directive, which contributes the shared display: inline-flex; width: 1em; height: 1em host bindings.
For catalogue-style use cases, import the ICONS array (a slug-sorted, ReadonlyArray<IconComponentType> of every non-deprecated icon) and the iconDisplayName(iconOrSlug) helper that resolves the human-readable label with the correct casing for acronyms and brand marks (GitHub, npm, CodePen, X (Twitter), etc.). Importing ICONS pulls every icon into the bundle, so apps that only render a handful should keep importing the components they use directly.
See icons for the full set, per-brand guideline links, and a searchable filter.
Theming
Every visual property is a CSS custom property on :root, so overriding any token retunes the whole library. See design tokens for the full reference and theming examples.
For the brand colour specifically, pass a single hex to provideEagamiUi and the library derives a full ten-shade scale (50 through 900) in OKLCH space:
bootstrapApplication(AppComponent, {
providers: [
provideEagamiUi({
palette: {
primary: { base: '#2563eb' },
secondary: { base: '#f97316' },
},
}),
],
});Every brand-role pairing is checked against WCAG 2.1 AA at bootstrap; a contrast violation throws before the app loads. Pin specific shades with overrides or remap which derived shade backs each role with roles. See design tokens for the full API.
Internationalization
Built-in strings ship in 15 languages, with runtime switching via EagamiI18nService. English is bundled by default; register the other languages you use with provideEagamiUi({ locales: [...] }) (or pass EAGAMI_ALL_LOCALES for all of them) so you ship only what you need. See internationalization for setup and per-string overrides.
Accessibility
Every component adheres to WCAG 2.2 Level AA and follows the matching WAI-ARIA Authoring Practices pattern: correct roles and states, full keyboard support with roving tabindex and RTL-aware arrows, focus trapping and restoration in modal surfaces, and live-region announcements for toasts, alerts, and validation errors, localized in all 15 languages. Conformance is self-assessed and continuously verified: each component has an axe-core (vitest-axe) test suite that runs on every change, so regressions in roles, names, contrast, or ARIA usage fail the build. Components that render no visible text expose aria-label inputs (with localized defaults for built-in controls), which is the one piece the consuming app must supply. See accessibility for an overview.
Server-side rendering
The library is SSR-safe and renders on the server (Angular Universal / @angular/ssr) without reaching for window or document. Browser-only work (focus management, the native <dialog>, overlay positioning, resize/intersection observers) is deferred to the client via afterNextRender and isPlatformBrowser guards, so prerendering, streaming SSR, and hydration work with no extra configuration.
Framework integration
@eagami/ui is Angular-only, but its design tokens are framework-agnostic. Copy-and-paste guides for non-Angular targets:
- eagami-ui-flutter.md for Flutter projects
- eagami-ui-react.md for React projects
Stability and support
Eagami UI follows Semantic Versioning. Breaking changes ship only in major releases, are listed under a Breaking heading in the changelog, and are preceded by a deprecation period wherever practical. See SUPPORT.md for the versioning policy, supported versions, deprecation policy, and how to get help.
Compatibility
| | |
|---|---|
| Angular | ^21.0.0 (peer dep) |
| Node | >= 20 for build/dev tooling |
| Rendering | Browser, SSR / prerender (Angular Universal), hydration |
| Browsers | Last 2 stable versions of Chrome, Edge, Firefox (plus current ESR), Safari |
Upgrading from v0.x? See MIGRATION.md.
