@eagami/ui 2.2.0 → 2.3.0

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.
package/README.md CHANGED
@@ -74,6 +74,23 @@ See [icons](https://eagami.com/ui/icons) for the full set, per-brand guideline l
74
74
 
75
75
  Every visual property is a CSS custom property on `:root`, so overriding any token retunes the whole library. See [design tokens](https://eagami.com/ui/design-tokens) for the full reference and theming examples.
76
76
 
77
+ 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](https://www.w3.org/TR/css-color-4/#ok-lab) space:
78
+
79
+ ```ts
80
+ bootstrapApplication(AppComponent, {
81
+ providers: [
82
+ provideEagamiUi({
83
+ palette: {
84
+ primary: { base: '#2563eb' },
85
+ secondary: { base: '#f97316' },
86
+ },
87
+ }),
88
+ ],
89
+ });
90
+ ```
91
+
92
+ 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](https://eagami.com/ui/design-tokens) for the full API.
93
+
77
94
  ## Internationalization
78
95
 
79
96
  Built-in strings ship in English, French (France), Greek, Polish, and Spanish (Spain), with runtime switching via `EagamiI18nService`. See [internationalization](https://eagami.com/ui/i18n) for setup and per-string overrides.