@eagami/ui 5.2.0 → 5.2.1

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (2) hide show
  1. package/README.md +22 -8
  2. package/package.json +1 -1
package/README.md CHANGED
@@ -8,21 +8,31 @@
8
8
  <a href="https://www.npmjs.com/package/@eagami/ui"><img src="https://img.shields.io/npm/v/@eagami/ui.svg" alt="npm version" /></a>
9
9
  <a href="https://github.com/mwiraszka/eagami/blob/main/LICENSE"><img src="https://img.shields.io/npm/l/@eagami/ui.svg" alt="license" /></a>
10
10
  <a href="https://main--6a14a63d5cab2ebad17871ff.chromatic.com"><img src="https://img.shields.io/badge/Storybook-FF4785?logo=storybook&logoColor=white" alt="Storybook" /></a>
11
- <a href="https://eagami.com/ui/accessibility"><img src="https://img.shields.io/badge/WCAG%202.2%20AA-self--assessed-0b7261" alt="WCAG 2.2 AA (self-assessed)" /></a>
11
+ <a href="https://eagami.com/ui/accessibility"><img src="https://img.shields.io/badge/WCAG%202.2%20AA-axe--core%20tested-0b7261" alt="WCAG 2.2 AA, tested with axe-core" /></a>
12
12
  </p>
13
13
 
14
14
  `@eagami/ui` is a lightweight, accessible Angular component library. Sensible defaults out of the box, with a fully customizable design to fit any brand.
15
15
 
16
16
  **Live documentation:** [eagami.com/ui](https://eagami.com/ui)
17
17
 
18
- ## Design principles
18
+ ## Why Eagami UI
19
19
 
20
- - **Accessible.** Keyboard navigation, focus management, screen-reader support, and reduced-motion handling are built into every component.
21
- - **Lightweight.** Each component imports independently and the bundle only ships what you use.
22
- - **Themeable.** Fully customizable with [design tokens](https://eagami.com/ui/design-tokens) while maintaining a unified look across every page. Light and dark variants ship together and default to the user's system preference.
23
- - **Localized.** Built-in component text ships in 15 languages, with runtime switching and per-string overrides.
24
- - **Modern.** Regularly updated with the latest Angular features and modern web standards.
25
- - **Unlocked.** Every component is plain Angular and CSS with no vendor lock-in, so the source can be read, copied, or modified like any other code in your project.
20
+ Angular teams usually reach for [Angular Material](https://material.angular.io), [PrimeNG](https://primeng.org), or a Tailwind copy-paste kit like [Spartan](https://spartan.ng). Eagami UI is different where it counts:
21
+
22
+ - **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](https://eagami.com/ui/design-tokens)). Light and dark are built in and follow the system preference.
23
+ - **Lightweight.** One runtime dependency and no CSS framework to adopt. Components are standalone, so your app ships only what it imports.
24
+ - **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.
25
+ - **Yours to own.** Plain Angular and CSS with no lock-in: read, copy, or fork any component like the rest of your app.
26
+ - **Modern Angular.** Signals, native control flow, and SSR-safe rendering throughout.
27
+
28
+ | | Eagami UI | Angular Material | PrimeNG | Spartan |
29
+ |---|---|---|---|---|
30
+ | Styling model | CSS custom properties | Sass / Material 3 tokens | Design tokens + presets | Tailwind, copy-paste |
31
+ | Re-skin to any brand | First-class | Within Material Design | Preset-based | You own the markup |
32
+ | Built-in text i18n | 15 languages, runtime | Provide your own | Provide your own | Your markup |
33
+ | Per-component a11y tests | Yes (axe-core) | Backed by the CDK | Varies by component | Your responsibility |
34
+ | Requires a CSS framework | No | No | No | Tailwind |
35
+ | Runtime dependencies | 1 (`tslib`) | Angular CDK | multiple | Tailwind |
26
36
 
27
37
  ## Installation
28
38
 
@@ -121,6 +131,10 @@ The library is SSR-safe and renders on the server (Angular Universal / `@angular
121
131
  - **[eagami-ui-flutter.md](https://github.com/mwiraszka/eagami/blob/main/eagami-ui-flutter.md)** for Flutter projects
122
132
  - **[eagami-ui-react.md](https://github.com/mwiraszka/eagami/blob/main/eagami-ui-react.md)** for React projects
123
133
 
134
+ ## Stability and support
135
+
136
+ Eagami UI follows [Semantic Versioning](https://semver.org). Breaking changes ship only in major releases, are listed under a **Breaking** heading in the [changelog](CHANGELOG.md), and are preceded by a deprecation period wherever practical. See [SUPPORT.md](https://github.com/mwiraszka/eagami/blob/main/SUPPORT.md) for the versioning policy, supported versions, deprecation policy, and how to get help.
137
+
124
138
  ## Compatibility
125
139
 
126
140
  | | |
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@eagami/ui",
3
- "version": "5.2.0",
3
+ "version": "5.2.1",
4
4
  "description": "Lightweight, accessible, themeable Angular UI component library and icon set built on CSS custom properties",
5
5
  "author": "Michal Wiraszka <michal@eagami.com>",
6
6
  "license": "MIT",