@exhaustive-ui/mcp 22.0.0-rc.3 → 22.0.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.
@@ -10,33 +10,61 @@ Generated: 2026-11-22
10
10
 
11
11
  Setting up ExhaustiveUI in an Angular CLI project.
12
12
 
13
- ## Download
13
+ ## Prerequisites
14
14
 
15
- Prefer to wire things up yourself? Install the packages from the npm registry directly. The next section covers the provider setup that ng add would have written for you.
15
+ ExhaustiveUI v22 targets Angular v22. Any workspace created with the Angular CLI works, standalone or NgModule based.
16
16
 
17
- ## Examples
17
+ - Angular v22, including `@angular/cdk`, `@angular/forms` and `@angular/router`; the form components work with template-driven forms, reactive forms and Signal Forms (`@angular/forms/signals`)
18
+ - RxJS v7.8.1 or newer
19
+ - A package manager of your choice — npm, yarn or pnpm
18
20
 
19
- Every example in this documentation opens in StackBlitz from the code toolbar above each demo, already wired up with the current version. The source repository is the reference for how the library itself is built and consumed.
21
+ Already using PrimeNG? Do not follow this page. The [migration guide](https://v1.optimus.openng.org/migration/primeng) covers moving an existing PrimeNG v21
22
+ workspace, once updated to Angular v22, across with the `migrate-from-primeng` schematic, which is a separate command from the `ng add` below.
20
23
 
21
- ## Icons
24
+ ## Angular Version Compatibility
22
25
 
23
- ExhaustiveUI components accept any icon through templating, so an icon library is optional. That said, every example in this documentation uses the pi pi-{icon} classes from OpenNG Icons , and component defaults such as the DatePicker arrows reference them too. Install it if you want the demos to look the way they do here. Then import the stylesheet, either from your global stylesheet or from the styles array in angular.json .
26
+ Each ExhaustiveUI major targets a single Angular major. Install the version matching your workspace, and see the [update guide](https://exhaustive-ui.com/migration/update) when moving to a newer one.
24
27
 
25
- ## Nextsteps
28
+ ## Install
26
29
 
27
- Once you have ExhaustiveUI up and running, we recommend exploring the following resources to gain a deeper understanding of the library. Global configuration Styled mode and unstyled mode Tailwind CSS integration Pass Through for direct access to the underlying elements Philosophy — what this project promises, and what it does not FAQ
30
+ The recommended way to add ExhaustiveUI to an Angular CLI workspace is a single command.
28
31
 
29
- ## Ngadd
32
+ ```bash
33
+ ng add @exhaustive-ui/core
34
+ ```
30
35
 
31
- The recommended way to add ExhaustiveUI to an Angular CLI workspace is a single command. The schematic asks which theme preset you want and then does the rest: adds @exhaustive-ui/core and @exhaustive-ui/themes to your dependencies wires provideExhaustive into your root providers with the chosen preset, in app.config.ts or your root NgModule installs the packages Pass the preset up front to skip the prompt, or skip the install step if you want to run it yourself: If the schematic cannot find a providers array to update it prints the three manual steps instead of guessing, so nothing in your workspace is rewritten unexpectedly. If it detects an existing primeng dependency it changes nothing and fails with an error rather than reporting success, and points you at the migration guide , which covers the migrate-from-primeng schematic. It does not run that schematic for you. The Angular CLI installs @exhaustive-ui/core before the schematic runs, so the dependency stays in your package.json — the migration schematic needs it there.
36
+ The schematic asks which theme preset you want and then does the rest:
32
37
 
33
- ## Prerequisites
38
+ - adds `@exhaustive-ui/core` and `@exhaustive-ui/themes` to your dependencies
39
+ - wires `provideExhaustive` into your root providers with the chosen preset, in `app.config.ts` or your root NgModule
40
+ - installs the packages
41
+
42
+ Pass the preset up front to skip the prompt, or skip the install step if you want to run it yourself:
43
+
44
+ ```bash
45
+ # Choose the preset without the prompt — Aura, Lara, Material or Nora
46
+ ng add @exhaustive-ui/core --theme=Lara
34
47
 
35
- ExhaustiveUI v22 targets Angular v22. Any workspace created with the Angular CLI works, standalone or NgModule based. Angular v22, including @angular/cdk , @angular/forms and @angular/router ; the form components work with template-driven forms, reactive forms and Signal Forms ( @angular/forms/signals ) RxJS v7.8.1 or newer A package manager of your choice — npm, yarn or pnpm Already using PrimeNG? Do not follow this page. The migration guide covers moving an existing PrimeNG v21 workspace, once updated to Angular v22, across with the migrate-from-primeng schematic, which is a separate command from the ng add below.
48
+ # Wire everything up but do not run the package install
49
+ ng add @exhaustive-ui/core --skip-install
50
+
51
+ # Target a specific project in a multi-project workspace
52
+ ng add @exhaustive-ui/core --project=admin
53
+ ```
54
+
55
+ If the schematic cannot find a providers array to update it prints the three manual steps instead of guessing, so nothing in your workspace is rewritten unexpectedly. If it detects an existing `primeng` dependency it changes
56
+ nothing and fails with an error rather than reporting success, and points you at the [migration guide](https://v1.optimus.openng.org/migration/primeng), which
57
+ covers the `migrate-from-primeng` schematic. It does not run that schematic for you. The Angular CLI installs `@exhaustive-ui/core` before the schematic runs, so the dependency stays in your `package.json` — the
58
+ migration schematic needs it there.
59
+
60
+ ## Download
61
+
62
+ Prefer to wire things up yourself? Install the packages from the [npm registry](https://www.npmjs.com/package/@exhaustive-ui/core) directly. The next section covers the provider
63
+ setup that `ng add` would have written for you.
36
64
 
37
65
  ## Provider
38
66
 
39
- Add provideExhaustive to the list of providers in your app.config.ts and use the theme property to configure a theme such as Aura.
67
+ Add `provideExhaustive` to the list of providers in your `app.config.ts` and use the `theme` property to configure a theme such as Aura.
40
68
 
41
69
  ```typescript
42
70
  import { ApplicationConfig } from '@angular/core';
@@ -54,13 +82,41 @@ export const appConfig: ApplicationConfig = {
54
82
  };
55
83
  ```
56
84
 
85
+ ## Icons
86
+
87
+ ExhaustiveUI components accept any icon through templating, so an icon library is optional. That said, every example in this documentation uses the `pi pi-{icon}` classes from
88
+ [OpenNG Icons](https://exhaustive-ui.com/icons), and component defaults such as the DatePicker arrows reference them too. Install it if you want the demos to look the way they do here.
89
+
90
+ ```bash
91
+ npm install @openng/icons
92
+ ```
93
+
94
+ Then import the stylesheet, either from your global stylesheet or from the `styles` array in `angular.json`.
95
+
96
+ ```scss
97
+ @import "@openng/icons/openng-icons.css";
98
+ ```
99
+
57
100
  ## Verify
58
101
 
59
- Verify your setup by adding a component such as Button. Each component can be imported and registered individually so that you only include what you use for bundle optimization. Import path is available in the documentation of the corresponding component.
102
+ Verify your setup by adding a component such as Button. Each component can be imported and registered individually so that you only include what you use for bundle optimization. Import path is available in the documentation of the
103
+ corresponding component.
104
+
105
+ ## Examples
106
+
107
+ Every example in this documentation opens in StackBlitz from the code toolbar above each demo, already wired up with the current version. The
108
+ [source repository](https://github.com/e-xiste/exhaustive-ui) is the reference for how the library itself is built and consumed.
109
+
110
+ ## Next Steps
60
111
 
61
- ## Versioncompatibility
112
+ Once you have ExhaustiveUI up and running, we recommend exploring the following resources to gain a deeper understanding of the library.
62
113
 
63
- Each ExhaustiveUI major targets a single Angular major. Install the version matching your workspace, and see the update guide when moving to a newer one.
114
+ - [Global configuration](https://exhaustive-ui.com/configuration)
115
+ - [Styled mode](https://exhaustive-ui.com/theming/styled) and [unstyled mode](https://exhaustive-ui.com/theming/unstyled)
116
+ - [Tailwind CSS integration](https://exhaustive-ui.com/tailwind)
117
+ - [Pass Through](https://exhaustive-ui.com/passthrough) for direct access to the underlying elements
118
+ - [Philosophy](https://exhaustive-ui.com/philosophy) — what this project promises, and what it does not
119
+ - [FAQ](https://exhaustive-ui.com/faq)
64
120
 
65
121
  ---
66
122
 
@@ -68,21 +124,24 @@ Each ExhaustiveUI major targets a single Angular major. Install the version matc
68
124
 
69
125
  Application wide configuration for ExhaustiveUI.
70
126
 
71
- ## Csp
127
+ ## Provider
72
128
 
73
- The nonce value to use on dynamically generated style elements in core.
129
+ The initial configuration is defined by the `provideExhaustive` provider during application startup.
74
130
 
75
131
  ```typescript
76
- provideExhaustive({
77
- csp: {
78
- nonce: '...'
79
- }
80
- })
132
+ import { ApplicationConfig } from '@angular/core';
133
+ import { provideExhaustive } from '@exhaustive-ui/core/config';
134
+
135
+ export const appConfig: ApplicationConfig = {
136
+ providers: [
137
+ provideExhaustive({ /* options */ })
138
+ ]
139
+ };
81
140
  ```
82
141
 
83
142
  ## Dynamic
84
143
 
85
- Inject the Exhaustive to your application to update the initial configuration at runtime.
144
+ Inject the `Exhaustive` to your application to update the initial configuration at runtime.
86
145
 
87
146
  ```typescript
88
147
  import { Component, OnInit } from '@angular/core';
@@ -102,7 +161,92 @@ export class AppComponent implements OnInit {
102
161
  }
103
162
  ```
104
163
 
105
- ## Filtermode
164
+ ## Theme
165
+
166
+ ExhaustiveUI provides 4 predefined themes out of the box; Aura, Material, Lara and Nora. See the theming documentation for details.
167
+
168
+ ```typescript
169
+ import { ApplicationConfig } from '@angular/core';
170
+ import { provideExhaustive } from '@exhaustive-ui/core/config';
171
+
172
+ import Aura from '@exhaustive-ui/themes/aura';
173
+
174
+ export const appConfig: ApplicationConfig = {
175
+ providers: [
176
+ provideExhaustive({
177
+ theme: {
178
+ preset: Aura,
179
+ options: {
180
+ prefix: 'p',
181
+ darkModeSelector: 'system',
182
+ cssLayer: false
183
+ }
184
+ }
185
+ })
186
+ ]
187
+ };
188
+ ```
189
+
190
+ ## Ripple
191
+
192
+ Ripple is an optional animation for the supported components such as buttons. It is disabled by default.
193
+
194
+ ```typescript
195
+ provideExhaustive({
196
+ ripple: true
197
+ })
198
+ ```
199
+
200
+ ## InputVariant
201
+
202
+ Input fields come in two styles, default is `outlined` with borders around the field whereas `filled` alternative adds a background color to the field. A theme such as Material may add more additional design changes per each
203
+ variant.
204
+
205
+ ## OverlayAppendTo
206
+
207
+ Defines the default location of the overlays; `self` refers to the host element and `body` targets the document body. Defaults to `self`.
208
+
209
+ ## ZIndex
210
+
211
+ ZIndexes are managed automatically to make sure layering of overlay components work seamlessly when combining multiple components. Still there may be cases where you'd like to configure the configure default values such as a custom
212
+ layout where header section is fixed. In a case like this, dropdown needs to be displayed below the application header but a modal dialog should be displayed above. ExhaustiveUI configuration offers the `zIndex` property to
213
+ customize the default values for components categories. Default values are described below and can be customized when setting up ExhaustiveUI.
214
+
215
+ ```typescript
216
+ import { ExhaustiveConfig } from '@exhaustive-ui/core/api';
217
+
218
+ @Component({
219
+ selector: 'app-root',
220
+ templateUrl: './app.component.html'
221
+ })
222
+ export class AppComponent implements OnInit {
223
+
224
+ constructor(private exhaustiveConfig: ExhaustiveConfig) {}
225
+
226
+ ngOnInit() {
227
+ this.exhaustiveConfig.zIndex = {
228
+ modal: 1100, // dialog, sidebar
229
+ overlay: 1000, // dropdown, overlaypanel
230
+ menu: 1000, // overlay menus
231
+ tooltip: 1100 // tooltip
232
+ };
233
+ }
234
+ }
235
+ ```
236
+
237
+ ## Nonce
238
+
239
+ The `nonce` value to use on dynamically generated style elements in core.
240
+
241
+ ```typescript
242
+ provideExhaustive({
243
+ csp: {
244
+ nonce: '...'
245
+ }
246
+ })
247
+ ```
248
+
249
+ ## Filter Mode
106
250
 
107
251
  Default filter modes to display on DataTable filter menus.
108
252
 
@@ -127,23 +271,17 @@ export class AppComponent implements OnInit {
127
271
  }
128
272
  ```
129
273
 
130
- ## Inputvariant
131
-
132
- Input fields come in two styles, default is outlined with borders around the field whereas filled alternative adds a background color to the field. A theme such as Material may add more additional design changes per each variant.
133
-
134
- ## Api
135
-
136
- Locale Options
137
-
138
- ## Repository
274
+ ## Translation
139
275
 
140
- Ready to use settings for locales are available as the @exhaustive-ui/locale package, maintained in the ExhaustiveUI repository. We'd appreciate if you could contribute translations to the repository and share them with the rest of the community.
276
+ A translation is specified using the translation property during initialization.
141
277
 
142
278
  ```typescript
143
- import { de } from '@exhaustive-ui/locale/js/de.js';
144
-
145
279
  provideExhaustive({
146
- translation: de
280
+ translation: {
281
+ accept: 'Aceptar',
282
+ reject: 'Rechazar',
283
+ //translations
284
+ }
147
285
  })
148
286
  ```
149
287
 
@@ -175,146 +313,184 @@ export class AppComponent implements OnInit {
175
313
  }
176
314
  ```
177
315
 
178
- ## Translation
316
+ ## Repository
179
317
 
180
- A translation is specified using the translation property during initialization.
318
+ Ready to use settings for locales are available as the `@exhaustive-ui/locale` package, maintained in the
319
+ [ExhaustiveUI](https://github.com/e-xiste/exhaustive-ui/tree/main/packages/locale) repository. We'd appreciate if you could contribute translations to the repository and share them
320
+ with the rest of the community.
181
321
 
182
322
  ```typescript
323
+ import { de } from '@exhaustive-ui/locale/js/de.js';
324
+
183
325
  provideExhaustive({
184
- translation: {
185
- accept: 'Aceptar',
186
- reject: 'Rechazar',
187
- //translations
188
- }
326
+ translation: de
189
327
  })
190
328
  ```
191
329
 
192
- ## Overlayappendto
330
+ ## API
193
331
 
194
- Defines the default location of the overlays; self refers to the host element and body targets the document body. Defaults to self .
332
+ ### Locale Options
195
333
 
196
- ## Provider
334
+ ---
197
335
 
198
- The initial configuration is defined by the provideExhaustive provider during application startup.
336
+ # Styled Mode
199
337
 
200
- ```typescript
201
- import { ApplicationConfig } from '@angular/core';
202
- import { provideExhaustive } from '@exhaustive-ui/core/config';
338
+ Choose from a variety of pre-styled themes or develop your own.
203
339
 
204
- export const appConfig: ApplicationConfig = {
205
- providers: [
206
- provideExhaustive({ /* options */ })
207
- ]
208
- };
209
- ```
340
+ ## Architecture
210
341
 
211
- ## Ripple
342
+ ExhaustiveUI is a design agnostic library so unlike some other UI libraries it does not enforce a certain styling such as material design. Styling is decoupled from the components using the themes instead. A theme consists of two
343
+ parts;
344
+ `base` and `preset`. The base is the style rules with CSS variables as placeholders whereas the preset is a set of design tokens to feed a base by mapping the tokens to CSS variables. A base may be configured with different
345
+ presets, currently Aura, Material, Lara and Nora are the available built-in options.
212
346
 
213
- Ripple is an optional animation for the supported components such as buttons. It is disabled by default.
347
+ The core of the styled mode architecture is based on a concept named `design token`, a preset defines the token configuration in 3 tiers; `primitive`, `semantic` and `component`.
214
348
 
215
- ```typescript
216
- provideExhaustive({
217
- ripple: true
218
- })
219
- ```
349
+ ### Primitive Tokens
350
+
351
+ Primitive tokens have no context, a color palette is a good example for a primitive token such as `blue-50` to `blue-900`. A token named `blue-500` may be used as the primary color, the background of a message however
352
+ on its own, the name of the token does not indicate context. Usually they are utilized by the semantic tokens.
353
+
354
+ ### Semantic Tokens
355
+
356
+ Semantic tokens define content and their names indicate where they are utilized, a well known example of a semantic token is the `primary.color`. Semantic tokens map to primitive tokens or other semantic tokens. The
357
+ `colorScheme` token group is a special variable to define tokens based on the color scheme active in the application, this allows defining different tokens based on the color scheme like dark mode.
358
+
359
+ ### Component Tokens
360
+
361
+ Component tokens are isolated tokens per component such as `inputtext.background` or `button.color` that map to the semantic tokens. As an example, `button.background` component token maps to the
362
+ `primary.color` semantic token which maps to the `green.500` primitive token.
363
+
364
+ ### Best Practices
365
+
366
+ Use primitive tokens when defining the core color palette and semantic tokens to specify the common design elements such as focus ring, primary colors and surfaces. Components tokens should only be used when customizing a specific
367
+ component. By defining your own design tokens as a custom preset, you'll be able to define your own style without touching CSS. Overriding the ExhaustiveUI components using style classes is not a best practice and should be the last
368
+ resort, design tokens are the suggested approach.
220
369
 
221
370
  ## Theme
222
371
 
223
- ExhaustiveUI provides 4 predefined themes out of the box; Aura, Material, Lara and Nora. See the theming documentation for details.
372
+ The `theme` property is used to customize the initial theme.
224
373
 
225
374
  ```typescript
226
375
  import { ApplicationConfig } from '@angular/core';
227
376
  import { provideExhaustive } from '@exhaustive-ui/core/config';
228
-
229
377
  import Aura from '@exhaustive-ui/themes/aura';
230
378
 
231
379
  export const appConfig: ApplicationConfig = {
232
380
  providers: [
233
381
  provideExhaustive({
234
382
  theme: {
235
- preset: Aura,
236
- options: {
237
- prefix: 'p',
238
- darkModeSelector: 'system',
239
- cssLayer: false
240
- }
383
+ preset: Aura
241
384
  }
242
385
  })
243
386
  ]
244
387
  };
245
388
  ```
246
389
 
247
- ## Zindex
390
+ ## Options
248
391
 
249
- ZIndexes are managed automatically to make sure layering of overlay components work seamlessly when combining multiple components. Still there may be cases where you'd like to configure the configure default values such as a custom layout where header section is fixed. In a case like this, dropdown needs to be displayed below the application header but a modal dialog should be displayed above. ExhaustiveUI configuration offers the zIndex property to customize the default values for components categories. Default values are described below and can be customized when setting up ExhaustiveUI.
392
+ The `options` property defines the how the CSS would be generated from the design tokens of the preset.
250
393
 
251
- ```typescript
252
- import { ExhaustiveConfig } from '@exhaustive-ui/core/api';
394
+ prefix
253
395
 
254
- @Component({
255
- selector: 'app-root',
256
- templateUrl: './app.component.html'
257
- })
258
- export class AppComponent implements OnInit {
396
+ The prefix of the CSS variables, defaults to `p`. For instance, the `primary.color` design token would be `var(--p-primary-color)`.
259
397
 
260
- constructor(private exhaustiveConfig: ExhaustiveConfig) {}
398
+ darkModeSelector
261
399
 
262
- ngOnInit() {
263
- this.exhaustiveConfig.zIndex = {
264
- modal: 1100, // dialog, sidebar
265
- overlay: 1000, // dropdown, overlaypanel
266
- menu: 1000, // overlay menus
267
- tooltip: 1100 // tooltip
268
- };
269
- }
270
- }
271
- ```
400
+ The CSS rule to encapsulate the CSS variables of the dark mode, the default is the `system` to generate `{{ '@' }}media (prefers-color-scheme: dark)`. If you need to make the dark mode toggleable based on the user selection
401
+ define a class selector such as `.app-dark` and toggle this class at the document root. See the dark mode toggle section for an example.
272
402
 
273
- ---
403
+ cssLayer
274
404
 
275
- # Styled Mode
405
+ Defines whether the styles should be defined inside a
406
+ [CSS layer](https://developer.mozilla.org/en-US/docs/Web/CSS/@layer)
407
+ by default or not. A CSS layer would be handy to declare a custom cascade layer for easier customization if necessary. The default is `false`.
276
408
 
277
- Choose from a variety of pre-styled themes or develop your own.
409
+ ## Presets
278
410
 
279
- ## Architecture
411
+ Aura, Material, Lara and Nora are the available built-in options, created to demonstrate the power of the design-agnostic theming. Aura is PrimeTek's own vision, Material follows Google Material Design v2, Lara is based on Bootstrap
412
+ and Nora is inspired by enterprise applications. Visit the [source code](https://github.com/e-xiste/exhaustive-ui/tree/main/packages/themes/src/presets) to learn more about the
413
+ structure of presets. You may use them out of the box with modifications or utilize them as reference in case you need to build your own presets from scratch.
414
+
415
+ ## Colors
280
416
 
281
- ExhaustiveUI is a design agnostic library so unlike some other UI libraries it does not enforce a certain styling such as material design. Styling is decoupled from the components using the themes instead. A theme consists of two parts; base and preset . The base is the style rules with CSS variables as placeholders whereas the preset is a set of design tokens to feed a base by mapping the tokens to CSS variables. A base may be configured with different presets, currently Aura, Material, Lara and Nora are the available built-in options. The core of the styled mode architecture is based on a concept named design token , a preset defines the token configuration in 3 tiers; primitive , semantic and component . Primitive Tokens Primitive tokens have no context, a color palette is a good example for a primitive token such as blue-50 to blue-900 . A token named blue-500 may be used as the primary color, the background of a message however on its own, the name of the token does not indicate context. Usually they are utilized by the semantic tokens. Semantic Tokens Semantic tokens define content and their names indicate where they are utilized, a well known example of a semantic token is the primary.color . Semantic tokens map to primitive tokens or other semantic tokens. The colorScheme token group is a special variable to define tokens based on the color scheme active in the application, this allows defining different tokens based on the color scheme like dark mode. Component Tokens Component tokens are isolated tokens per component such as inputtext.background or button.color that map to the semantic tokens. As an example, button.background component token maps to the primary.color semantic token which maps to the green.500 primitive token. Best Practices Use primitive tokens when defining the core color palette and semantic tokens to specify the common design elements such as focus ring, primary colors and surfaces. Components tokens should only be used when customizing a specific component. By defining your own design tokens as a custom preset, you'll be able to define your own style without touching CSS. Overriding the ExhaustiveUI components using style classes is not a best practice and should be the last resort, design tokens are the suggested approach.
417
+ Color palette of a preset is defined by the `primitive` design token group. You can access colors using CSS variables or the `$dt` utility.
282
418
 
283
- ## Bootstrap
419
+ @for (color of colors; track color) {
420
+ - {{ color }} @for (shade of shades; track shade) { {{ shade }} }
421
+ }
284
422
 
285
- Bootstrap has a reboot utility to reset the CSS of the standard elements. If you are including this utility, you may give it a layer while importing it.
423
+ ## Dark Mode
286
424
 
287
- ## Colors
425
+ ExhaustiveUI uses the `system` as the default `darkModeSelector` in theme configuration. If you have a dark mode switch in your application, set the `darkModeSelector` to the selector you utilize such as
426
+ `.my-app-dark` so that ExhaustiveUI can fit in seamlessly with your color scheme.
427
+
428
+ ```typescript
429
+ provideExhaustive({
430
+ theme: {
431
+ preset: Aura,
432
+ options: {
433
+ darkModeSelector: '.my-app-dark'
434
+ }
435
+ }
436
+ })
437
+ ```
288
438
 
289
- Color palette of a preset is defined by the primitive design token group. You can access colors using CSS variables or the $dt utility. @for (color of colors; track color) { {{ color }} @for (shade of shades; track shade) { {{ shade }} } }
439
+ Following is a very basic example implementation of a dark mode switch, you may extend it further by involving
440
+ `prefers-color-scheme` to retrieve it from the system initially and use `localStorage` to make it stateful. See this
441
+ [article](https://dev.to/abbeyperini/dark-mode-toggle-and-prefers-color-scheme-4f3m)
442
+ for more information.
290
443
 
291
- ## Colorscheme
444
+ In case you prefer to use dark mode all the time, apply the `darkModeSelector` initially and never change it.
292
445
 
293
- A token can be defined per color scheme using light and dark properties of the colorScheme property. Each token can have specific values based on the current color scheme. Common Pitfall When customizing an existing preset, your token overrides may be ignored if you don't properly account for color scheme variations. If the original preset defines a token using the colorScheme property, but your customization only provides a direct value, your override will be ignored because the colorScheme property takes precedence over direct values and the system will continue using the preset's scheme-specific values. When customizing tokens that are not defined with colorScheme in the original preset, your customizations will be applied successfully regardless of how you structure them; whether direct or under colorScheme. Best Practices Check how tokens are defined in the preset before customizing from the source . Always maintain the same structure (direct value or colorScheme) as the original preset. Consider both light and dark mode values when overriding scheme-dependent tokens. This approach ensures your customizations will be applied correctly regardless of the user's selected color scheme.
446
+ It is also possible to disable dark mode completely using `false` or `none` as the value of the selector.
294
447
 
295
- ## Component
448
+ ```typescript
449
+ provideExhaustive({
450
+ theme: {
451
+ preset: Aura,
452
+ options: {
453
+ darkModeSelector: false || 'none'
454
+ }
455
+ }
456
+ })
457
+ ```
296
458
 
297
- The design tokens of a specific component is defined at components layer. Overriding components tokens is not the recommended approach if you are building your own style, building your own preset should be preferred instead. This configuration is global and applies to all card components, in case you need to customize a particular component on a page locally, view the Scoped CSS section for an example.
459
+ ## definePreset
298
460
 
299
- ## Darkmode
461
+ The `definePreset` utility is used to customize an existing preset during the ExhaustiveUI setup. The first parameter is the preset to customize and the second is the design tokens to override.
300
462
 
301
- ExhaustiveUI uses the system as the default darkModeSelector in theme configuration. If you have a dark mode switch in your application, set the darkModeSelector to the selector you utilize such as .my-app-dark so that ExhaustiveUI can fit in seamlessly with your color scheme. Following is a very basic example implementation of a dark mode switch, you may extend it further by involving prefers-color-scheme to retrieve it from the system initially and use localStorage to make it stateful. See this article for more information. In case you prefer to use dark mode all the time, apply the darkModeSelector initially and never change it. It is also possible to disable dark mode completely using false or none as the value of the selector.
463
+ ## Color Scheme
302
464
 
303
- ## Definepreset
465
+ A token can be defined per color scheme using `light` and `dark` properties of the `colorScheme` property. Each token can have specific values based on the current color scheme.
304
466
 
305
- The definePreset utility is used to customize an existing preset during the ExhaustiveUI setup. The first parameter is the preset to customize and the second is the design tokens to override.
467
+ Common Pitfall
306
468
 
307
- ## Dt
469
+ When customizing an existing preset, your token overrides may be ignored if you don't properly account for color scheme variations. If the original preset defines a token using the `colorScheme` property, but your customization
470
+ only provides a direct value, your override will be ignored because the `colorScheme` property takes precedence over direct values and the system will continue using the preset's scheme-specific values. When customizing tokens
471
+ that are not defined with `colorScheme` in the original preset, your customizations will be applied successfully regardless of how you structure them; whether direct or under colorScheme.
308
472
 
309
- The $dt function returns the information about a token like the full path and value. This would be useful if you need to access tokens programmatically.
473
+ Best Practices
310
474
 
311
- ## Extend
475
+ - Check how tokens are defined in the preset before customizing from the [source](https://github.com/e-xiste/exhaustive-ui/blob/main/packages/themes/src/presets).
476
+ - Always maintain the same structure (direct value or colorScheme) as the original preset.
477
+ - Consider both light and dark mode values when overriding scheme-dependent tokens.
478
+
479
+ This approach ensures your customizations will be applied correctly regardless of the user's selected color scheme.
312
480
 
313
- The theming system can be extended by adding custom design tokens and additional styles. This feature provides a high degree of customization, allowing you to adjust styles according to your needs, as you are not limited to the default tokens. The example preset configuration adds a new accent button with custom button.accent.color and button.accent.inverse.color tokens. It is also possible to add tokens globally to share them within the components.
481
+ ## Primary
314
482
 
315
- ## Focusring
483
+ The `primary` defines the main color palette, default value maps to the `emerald` primitive token. Let's setup to use `indigo` instead.
316
484
 
317
- Focus ring defines the outline width, style, color and offset. Let's use a thicker ring with the primary color for the outline.
485
+ ## Surface
486
+
487
+ The color scheme palette that varies between light and dark modes is specified with the surface tokens. Example below uses
488
+ `zinc` for light mode and `slategray` for dark mode. With this setting, light mode, would have a grayscale tone and dark mode would include bluish tone.
489
+
490
+ ## Noir
491
+
492
+ The `noir` mode is the nickname of a variant that uses surface tones as the primary and requires and additional `colorScheme` configuration to implement. A sample preset configuration with black and white variants as the
493
+ primary color;
318
494
 
319
495
  ## Font
320
496
 
@@ -322,105 +498,143 @@ There is no design for fonts as UI components inherit their font settings from t
322
498
 
323
499
  ## Forms
324
500
 
325
- The design tokens of the form input components are derived from the form.field token group. This customization example changes border color to primary on hover. Any component that depends on this semantic token such as dropdown.hover.border.color and textarea.hover.border.color would receive the change.
501
+ The design tokens of the form input components are derived from the `form.field` token group. This customization example changes border color to primary on hover. Any component that depends on this semantic token such as
502
+ `dropdown.hover.border.color` and `textarea.hover.border.color` would receive the change.
326
503
 
327
- ## Libraries
504
+ ## Focus Ring
328
505
 
329
- Example layer configuration for the popular CSS libraries.
506
+ Focus ring defines the outline width, style, color and offset. Let's use a thicker ring with the primary color for the outline.
330
507
 
331
- ## Noir
508
+ ## Component
332
509
 
333
- The noir mode is the nickname of a variant that uses surface tones as the primary and requires and additional colorScheme configuration to implement. A sample preset configuration with black and white variants as the primary color;
510
+ The design tokens of a specific component is defined at `components` layer. Overriding components tokens is not the recommended approach if you are building your own style, building your own preset should be preferred instead.
511
+ This configuration is global and applies to all card components, in case you need to customize a particular component on a page locally, view the Scoped CSS section for an example.
334
512
 
335
- ## Options
513
+ ## Extend
336
514
 
337
- The options property defines the how the CSS would be generated from the design tokens of the preset. prefix The prefix of the CSS variables, defaults to p . For instance, the primary.color design token would be var(--p-primary-color) . darkModeSelector The CSS rule to encapsulate the CSS variables of the dark mode, the default is the system to generate {{ '@' }}media (prefers-color-scheme: dark) . If you need to make the dark mode toggleable based on the user selection define a class selector such as .app-dark and toggle this class at the document root. See the dark mode toggle section for an example. cssLayer Defines whether the styles should be defined inside a CSS layer by default or not. A CSS layer would be handy to declare a custom cascade layer for easier customization if necessary. The default is false .
515
+ The theming system can be extended by adding custom design tokens and additional styles. This feature provides a high degree of customization, allowing you to adjust styles according to your needs, as you are not limited to the
516
+ default tokens.
338
517
 
339
- ## Palette
518
+ The example preset configuration adds a new `accent` button with custom `button.accent.color` and `button.accent.inverse.color` tokens. It is also possible to add tokens globally to share them within the components.
340
519
 
341
- Returns shades and tints of a given color from 50 to 950 as an array.
520
+ ## Scoped Tokens
342
521
 
343
- ## Presets
522
+ Design tokens can be scoped to a certain component using the `dt` property. In this example, first switch uses the global tokens whereas second one overrides the global with its own tokens.
344
523
 
345
- Aura, Material, Lara and Nora are the available built-in options, created to demonstrate the power of the design-agnostic theming. Aura is PrimeTek's own vision, Material follows Google Material Design v2, Lara is based on Bootstrap and Nora is inspired by enterprise applications. Visit the source code to learn more about the structure of presets. You may use them out of the box with modifications or utilize them as reference in case you need to build your own presets from scratch.
524
+ This approach is recommended over the `::ng-deep` as it offers a cleaner API while avoiding the hassle of CSS rule overrides.
346
525
 
347
- ## Primary
526
+ ## usePreset
527
+
528
+ Replaces the current presets entirely, common use case is changing the preset dynamically at runtime.
348
529
 
349
- The primary defines the main color palette, default value maps to the emerald primitive token. Let's setup to use indigo instead.
530
+ ## updatePreset
350
531
 
351
- ## Reset
532
+ Merges the provided tokens to the current preset, an example would be changing the primary color palette dynamically.
352
533
 
353
- In case ExhaustiveUI components have visual issues in your application, a Reset CSS may be the culprit. CSS layers would be an efficient solution that involves enabling the ExhaustiveUI layer, wrapping the Reset CSS in another layer and defining the layer order. This way, your Reset CSS does not get in the way of ExhaustiveUI components.
534
+ ## updatePrimaryPalette
354
535
 
355
- ## Scale
536
+ Updates the primary colors, this is a shorthand to do the same update using `updatePreset`.
356
537
 
357
- ExhaustiveUI UI component use rem units, 1rem equals to the font size of the html element which is 16px by default. Use the root font-size to adjust the size of the components globally. This website uses 14px as the base so it may differ from your application if your base font size is different.
538
+ ## updateSurfacePalette
358
539
 
359
- ## Scopedtokens
540
+ Updates the surface colors, this is a shorthand to do the same update using `updatePreset`.
360
541
 
361
- Design tokens can be scoped to a certain component using the dt property. In this example, first switch uses the global tokens whereas second one overrides the global with its own tokens. This approach is recommended over the ::ng-deep as it offers a cleaner API while avoiding the hassle of CSS rule overrides.
542
+ ## $dt
543
+
544
+ The `$dt` function returns the information about a token like the full path and value. This would be useful if you need to access tokens programmatically.
545
+
546
+ ## palette
547
+
548
+ Returns shades and tints of a given color from 50 to 950 as an array.
362
549
 
363
550
  ## Specificity
364
551
 
365
- The @layer is a standard CSS feature to define cascade layers for a customizable order of precedence. If you need to become more familiar with layers, visit the documentation at MDN to begin with. The cssLayer is disabled by default, when it is enabled at theme configuration, ExhaustiveUI wraps the built-in style classes under the exhaustive cascade layer to make the library styles easy to override. CSS in your app without a layer has the highest CSS specificity, so you'll be able to override styles regardless of the location or how strong a class is written.
552
+ The `@layer` is a standard CSS feature to define cascade layers for a customizable order of precedence. If you need to become more familiar with layers, visit the documentation at
553
+ [MDN](https://developer.mozilla.org/en-US/docs/Web/CSS/@layer) to begin with.
366
554
 
367
- ## Surface
555
+ The `cssLayer` is disabled by default, when it is enabled at theme configuration, ExhaustiveUI wraps the built-in style classes under the `exhaustive` cascade layer to make the library styles easy to override. CSS in your
556
+ app without a layer has the highest CSS specificity, so you'll be able to override styles regardless of the location or how strong a class is written.
368
557
 
369
- The color scheme palette that varies between light and dark modes is specified with the surface tokens. Example below uses zinc for light mode and slategray for dark mode. With this setting, light mode, would have a grayscale tone and dark mode would include bluish tone.
558
+ ## Reset
370
559
 
371
- ## Theme
560
+ In case ExhaustiveUI components have visual issues in your application, a Reset CSS may be the culprit. CSS layers would be an efficient solution that involves enabling the ExhaustiveUI layer, wrapping the Reset CSS in another layer
561
+ and defining the layer order. This way, your Reset CSS does not get in the way of ExhaustiveUI components.
372
562
 
373
- The theme property is used to customize the initial theme.
563
+ ## Scale
374
564
 
375
- ```typescript
376
- import { ApplicationConfig } from '@angular/core';
377
- import { provideExhaustive } from '@exhaustive-ui/core/config';
378
- import Aura from '@exhaustive-ui/themes/aura';
565
+ ExhaustiveUI UI component use `rem` units, 1rem equals to the font size of the `html` element which is `16px` by default. Use the root font-size to adjust the size of the components globally. This website uses
566
+ `14px` as the base so it may differ from your application if your base font size is different.
379
567
 
380
- export const appConfig: ApplicationConfig = {
381
- providers: [
382
- provideExhaustive({
383
- theme: {
384
- preset: Aura
385
- }
386
- })
387
- ]
388
- };
389
- ```
568
+ ## Bootstrap
390
569
 
391
- ## Updatepreset
570
+ Bootstrap has a `reboot` utility to reset the CSS of the standard elements. If you are including this utility, you may give it a layer while importing it.
392
571
 
393
- Merges the provided tokens to the current preset, an example would be changing the primary color palette dynamically.
572
+ ## Libraries
394
573
 
395
- ## Updateprimarypalette
574
+ Example layer configuration for the popular CSS libraries.
396
575
 
397
- Updates the primary colors, this is a shorthand to do the same update using updatePreset .
576
+ ---
398
577
 
399
- ## Updatesurfacepalette
578
+ # Unstyled Mode
400
579
 
401
- Updates the surface colors, this is a shorthand to do the same update using updatePreset .
580
+ Theming ExhaustiveUI with alternative styling approaches.
402
581
 
403
- ## Usepreset
582
+ ## Architecture
404
583
 
405
- Replaces the current presets entirely, common use case is changing the preset dynamically at runtime.
584
+ The term `unstyled` is used to define an alternative styling approach instead of the default theming with design tokens. In unstyled mode the css variables of the design tokens and the css rule sets that utilize them are not
585
+ included. Here is an example of an Unstyled Select, the core functionality and accessibility is provided whereas styling is not included.
406
586
 
407
- ---
587
+ ## Setup
408
588
 
409
- # Unstyled Mode
589
+ Unstyled mode is enabled for the whole suite by enabling `unstyled` option during ExhaustiveUI installation.
410
590
 
411
- Theming ExhaustiveUI with alternative styling approaches.
591
+ ```typescript
592
+ import { ApplicationConfig } from '@angular/core';
412
593
 
413
- ## Architecture
594
+ export const appConfig: ApplicationConfig = {
595
+ providers: [
596
+ provideExhaustive({
597
+ unstyled: true
598
+ })
599
+ ]
600
+ };
601
+ ```
602
+
603
+ Alternatively even in the default styled mode, a particular component can still be used as unstyled by adding the `unstyled` prop of the component.
414
604
 
415
- The term unstyled is used to define an alternative styling approach instead of the default theming with design tokens. In unstyled mode the css variables of the design tokens and the css rule sets that utilize them are not included. Here is an example of an Unstyled Select, the core functionality and accessibility is provided whereas styling is not included.
605
+ ```html
606
+ <div class="card flex justify-center items-center gap-2">
607
+ <p-button label="Styled" icon="pi pi-check" />
608
+ <p-button label="Unstyled" icon="pi pi-check" [unstyled]="true" />
609
+ </div>
610
+ ```
416
611
 
417
612
  ## Example
418
613
 
419
- Unstyled components require styling using your preferred approach. We recommend using Tailwind CSS with PassThrough attributes, a combination that works seamlessly together. The @exhaustive-ui/tailwindcss even provides special variants such as p-outlined: , p-vertical for the ExhaustiveUI components. The example below demonstrates how to style a button component with Tailwind CSS using PassThrough attributes. Before you begin, refer to the pass through section in the button documentation to familiarize yourself with the component's internal structure and PassThrough attributes. In this example, we'll target the root , label and icon elements to apply custom styles.
614
+ Unstyled components require styling using your preferred approach. We recommend using Tailwind CSS with PassThrough attributes, a combination that works seamlessly together. The `@exhaustive-ui/tailwindcss` even provides special
615
+ variants such as `p-outlined:`, `p-vertical` for the ExhaustiveUI components.
616
+
617
+ The example below demonstrates how to style a button component with Tailwind CSS using PassThrough attributes. Before you begin, refer to the
618
+ pass through section in the button documentation to familiarize yourself with the component's internal structure and PassThrough attributes. In this
619
+ example, we'll target the `root`, `label` and `icon` elements to apply custom styles.
620
+
621
+ ```html
622
+ <p-button
623
+ label="Search"
624
+ icon="pi pi-search"
625
+ [unstyled]="true"
626
+ [pt]="{
627
+ root: 'bg-teal-500 hover:bg-teal-700 active:bg-teal-900 cursor-pointer py-2 px-4 rounded-full border-0 flex gap-2',
628
+ label: 'text-white font-bold text-lg',
629
+ icon: 'text-white text-xl!'
630
+ }"
631
+ />
632
+ ```
420
633
 
421
634
  ## Global
422
635
 
423
- A global configuration can be created at application level to avoid repetition via the global pt option so that the styles can be shared from a single location. A particular component can still override a global configuration with its own pt property.
636
+ A global configuration can be created at application level to avoid repetition via the global `pt` option so that the styles can be shared from a single location. A particular component can still override a global configuration
637
+ with its own `pt` property.
424
638
 
425
639
  ```typescript
426
640
  import { ApplicationConfig } from '@angular/core';
@@ -441,23 +655,35 @@ export const appConfig: ApplicationConfig = {
441
655
  };
442
656
  ```
443
657
 
444
- ## Setup
445
-
446
- Unstyled mode is enabled for the whole suite by enabling unstyled option during ExhaustiveUI installation. Alternatively even in the default styled mode, a particular component can still be used as unstyled by adding the unstyled prop of the component.
447
-
448
658
  ---
449
659
 
450
660
  # Icons
451
661
 
452
662
  OpenNG Icons is the default icon library of ExhaustiveUI with over 250 open source icons.
453
663
 
664
+ ## Download
665
+
666
+ The icon library is available at npm, run the following command to download it to your project.
667
+
668
+ ## Import
669
+
670
+ CSS file of the icon library needs to be imported in `styles.scss` of your application.
671
+
454
672
  ## Basic
455
673
 
456
- OpenNG Icons use the pi pi-{icon} syntax such as pi pi-check . A standalone icon can be displayed using an element such as i or span
674
+ OpenNG Icons use the `pi pi-{icon}` syntax such as `pi pi-check`. A standalone icon can be displayed using an element such as `i` or `span`
675
+
676
+ ## Size
677
+
678
+ Size of an icon is controlled with the font-size property of the element.
457
679
 
458
680
  ## Color
459
681
 
460
- Icon color is defined with the color property which is inherited from parent by default.
682
+ Icon color is defined with the `color` property which is inherited from parent by default.
683
+
684
+ ## Spin
685
+
686
+ Special `pi-spin` class applies infinite rotation to an icon.
461
687
 
462
688
  ## Constants
463
689
 
@@ -489,25 +715,10 @@ export class OpenngIconsConstantsDemo {
489
715
  }
490
716
  ```
491
717
 
492
- ## Download
493
-
494
- The icon library is available at npm, run the following command to download it to your project.
495
-
496
- ## Import
497
-
498
- CSS file of the icon library needs to be imported in styles.scss of your application.
499
-
500
718
  ## List
501
719
 
502
- Here is the full list of icons. More icons will be added periodically and you may also request new icons at the issue tracker.
503
-
504
- ## Size
505
-
506
- Size of an icon is controlled with the font-size property of the element.
507
-
508
- ## Spin
509
-
510
- Special pi-spin class applies infinite rotation to an icon.
720
+ Here is the full list of icons. More icons will be added periodically and you may also
721
+ [request new icons](https://github.com/openng-org/icons/issues) at the issue tracker.
511
722
 
512
723
  ---
513
724
 
@@ -515,21 +726,21 @@ Special pi-spin class applies infinite rotation to an icon.
515
726
 
516
727
  Use custom icons with ExhaustiveUI components.
517
728
 
518
- ## Fontawesome
729
+ ## Material
519
730
 
520
- Font Awesome is a popular icon library with a wide range of icons.
731
+ [Material icons](https://fonts.google.com/icons) is the official icon library based on Google Material Design.
521
732
 
522
- ## Image
733
+ ## Font Awesome
523
734
 
524
- Any type of image can be used as an icon.
735
+ [Font Awesome](https://fontawesome.com/) is a popular icon library with a wide range of icons.
525
736
 
526
- ## Material
737
+ ## SVG
527
738
 
528
- Material icons is the official icon library based on Google Material Design.
739
+ Inline SVGs are embedded inside the dom.
529
740
 
530
- ## Svg
741
+ ## Image
531
742
 
532
- Inline SVGs are embedded inside the dom.
743
+ Any type of image can be used as an icon.
533
744
 
534
745
  ---
535
746
 
@@ -539,31 +750,120 @@ Pass Through Props allow direct access to the underlying elements for complete c
539
750
 
540
751
  ## Basic
541
752
 
542
- Each component has a special pt property to define an object with keys corresponding to the available DOM elements. Each value can either be a string, an object or a function that returns a string or an object to define the arbitrary properties to apply to the element such as styling, aria, data-* or custom attributes. If the value is a string or a function that returns a string, it is considered as a class definition and added to the class attribute of the element. Every component documentation has a dedicated section to document the available section names exposed via PT.
753
+ Each component has a special `pt` property to define an object with keys corresponding to the available DOM elements. Each value can either be a string, an object or a function that returns a string or an object to define the
754
+ arbitrary properties to apply to the element such as styling, aria, data-* or custom attributes. If the value is a string or a function that returns a string, it is considered as a class definition and added to the class attribute of
755
+ the element. Every component documentation has a dedicated section to document the available section names exposed via PT.
543
756
 
544
757
  ## Global
545
758
 
546
- PassThrough object can also be defined at a global level to apply all components in an application using the provideExhaustive provider. For example, with the configuration here all panel headers have the bg-primary style class and all autocomplete components have a fixed width. These settings can be overridden by a particular component as components pt property has higher precedence over global pt by default.
759
+ PassThrough object can also be defined at a global level to apply all components in an application using the `provideExhaustive` provider. For example, with the configuration here all panel headers have the
760
+ `bg-primary` style class and all autocomplete components have a fixed width. These settings can be overridden by a particular component as components `pt` property has higher precedence over global `pt` by default.
547
761
 
548
762
  ## Instance
549
763
 
550
- In cases where you need to access the UI Component instance, define a component passthrough type that exposes the component instance or a function that receives a PassThroughContext as parameter.
764
+ In cases where you need to access the UI Component instance, define a component passthrough type that exposes the component instance or a function that receives a `PassThroughContext` as parameter.
551
765
 
552
766
  ## Introduction
553
767
 
554
- In traditional 3rd party UI libraries, users are limited to the API provided by component author. This API commonly consists of inputs, outputs, and content projection. Whenever a requirement emerges for a new customization option in the API, the component author needs to develop and publish it with a new release. The pass through feature is a key element to implement this vision by exposing the component internals in order to apply arbitrary attributes and listeners to the DOM elements. The primary advantage of this approach is that it frees you from being restricted by the main component API. We recommend considering the pass-through feature whenever you need to tailor a component that lacks a built-in feature for your specific requirement. Each component has a special pt property to define an object with keys corresponding to the available DOM elements. A value of a key can either be a string, an object or a function to define the arbitrary properties such as styling, aria, data-* or custom attributes for the element. If the value is a string or a function that returns a string, it serves as a shorthand for a style class definition. Every component documentation has a dedicated segment to document the available section names in the interactive PT Viewer. Panel Example In this example, a Panel is customized with various options through pt . The styling is overriden with Tailwind CSS and header receives custom attributes along with a click event. The attributes passed to the header are not available in the component API, thanks to PassThrough feature, this is no longer an issue as you are not limited to the component api. Note that, you may avoid the ! based overrides in Tailwind classes if you setup CSS Layers with ExhaustiveUI. Visit the Override section at Tailwind integration for examples.
768
+ In traditional 3rd party UI libraries, users are limited to the API provided by component author. This API commonly consists of inputs, outputs, and content projection. Whenever a requirement emerges for a new customization option in
769
+ the API, the component author needs to develop and publish it with a new release.
770
+
771
+ The pass through feature is a key element to implement this vision by exposing the component internals in order to apply arbitrary attributes and listeners to the DOM elements. The primary advantage of this approach is that it frees
772
+ you from being restricted by the main component API. We recommend considering the pass-through feature whenever you need to tailor a component that lacks a built-in feature for your specific requirement.
773
+
774
+ Each component has a special `pt` property to define an object with keys corresponding to the available DOM elements. A value of a key can either be a string, an object or a function to define the arbitrary properties such as
775
+ styling, aria, data-* or custom attributes for the element. If the value is a string or a function that returns a string, it serves as a shorthand for a style class definition. Every component documentation has a dedicated segment to
776
+ document the available section names in the interactive PT Viewer.
777
+
778
+ ### Panel Example
779
+
780
+ In this example, a Panel is customized with various options through `pt`. The styling is overriden with Tailwind CSS and header receives custom attributes along with a click event. The attributes passed to the header are not
781
+ available in the component API, thanks to PassThrough feature, this is no longer an issue as you are not limited to the component api. Note that, you may avoid the `!` based overrides in Tailwind classes if you setup CSS Layers
782
+ with ExhaustiveUI. Visit the [Override](https://exhaustive-ui.com/tailwind) section at Tailwind integration for examples.
555
783
 
556
784
  ## Lifecycle
557
785
 
558
- Lifecycle hooks of components are exposed as pass through using the hooks property so that callback functions can be registered. Available callbacks are onBeforeInit , onInit , onChanges , onDoCheck , onAfterContentInit , onAfterContentChecked , onAfterViewInit , onAfterViewChecked and onDestroy . Refer to the Angular documentation for detailed information about lifecycle hooks.
786
+ Lifecycle hooks of components are exposed as pass through using the `hooks` property so that callback functions can be registered. Available callbacks are `onBeforeInit`, `onInit`, `onChanges`, `onDoCheck`,
787
+ `onAfterContentInit`, `onAfterContentChecked`, `onAfterViewInit`, `onAfterViewChecked` and `onDestroy`. Refer to the Angular documentation for detailed information about lifecycle hooks.
559
788
 
560
789
  ## Pcprefix
561
790
 
562
- A UI component may also use other UI components, in this case section names are prefixed with pc (Prime Component) to denote the ExhaustiveUI component begin used. This distinguishes components from standard DOM elements and indicating the necessity for a nested structure. For example, the badge section is identified as pcBadge because the button component incorporates the badge component internally.
791
+ A UI component may also use other UI components, in this case section names are prefixed with `pc` (Prime Component) to denote the ExhaustiveUI component begin used. This distinguishes components from standard DOM elements and
792
+ indicating the necessity for a nested structure. For example, the `badge` section is identified as `pcBadge` because the button component incorporates the badge component internally.
563
793
 
564
794
  ## Ptoptions
565
795
 
566
- The ⁠ptOptions property determines how a component's local PassThrough configuration merges with the global PT configuration, as demonstrated in the following examples using both global and component-level settings. The mergeSections defines whether the sections from the main configuration gets added and the mergeProps controls whether to override or merge the defined props. Defaults are true for mergeSections and false for mergeProps . Global Configuration mergeSections: true, mergeProps: false (default) mergeSections: true, mergeProps: true mergeSections: false, mergeProps: true mergeSections: false, mergeProps: false
796
+ The `⁠ptOptions` property determines how a component's local PassThrough configuration merges with the global PT configuration, as demonstrated in the following examples using both global and component-level settings.
797
+
798
+ The `mergeSections` defines whether the sections from the main configuration gets added and the `mergeProps` controls whether to override or merge the defined props. Defaults are `true` for `mergeSections` and
799
+ `false` for `mergeProps`.
800
+
801
+ ### Global Configuration
802
+
803
+ ```typescript
804
+ import { ApplicationConfig } from '@angular/core';
805
+ import { provideExhaustive } from '@exhaustive-ui/core/config';
806
+
807
+ export const appConfig: ApplicationConfig = {
808
+ providers: [
809
+ provideExhaustive({
810
+ pt: {
811
+ panel: {
812
+ header: {
813
+ 'data-custom': 'acme-panel',
814
+ class: 'bg-primary text-primary-contrast'
815
+ },
816
+ content: 'font-medium'
817
+ }
818
+ }
819
+ })
820
+ ]
821
+ };
822
+ ```
823
+
824
+ ### mergeSections: true, mergeProps: false (default)
825
+
826
+ ```typescript
827
+ import { Component } from '@angular/core';
828
+ import { Panel, PanelModule, PanelPassThrough } from '@exhaustive-ui/core/panel';
829
+
830
+ @Component({
831
+ selector: 'ptoptions-doc',
832
+ template: \
833
+ ```
834
+
835
+ ### mergeSections: true, mergeProps: true
836
+
837
+ ```typescript
838
+ import { Component } from '@angular/core';
839
+ import { Panel, PanelModule, PanelPassThrough } from '@exhaustive-ui/core/panel';
840
+
841
+ @Component({
842
+ selector: 'ptoptions-doc',
843
+ template: \
844
+ ```
845
+
846
+ ### mergeSections: false, mergeProps: true
847
+
848
+ ```typescript
849
+ import { Component } from '@angular/core';
850
+ import { Panel, PanelModule, PanelPassThrough } from '@exhaustive-ui/core/panel';
851
+
852
+ @Component({
853
+ selector: 'ptoptions-doc',
854
+ template: \
855
+ ```
856
+
857
+ ### mergeSections: false, mergeProps: false
858
+
859
+ ```typescript
860
+ import { Component } from '@angular/core';
861
+ import { Panel, PanelModule, PanelPassThrough } from '@exhaustive-ui/core/panel';
862
+
863
+ @Component({
864
+ selector: 'ptoptions-doc',
865
+ template: \
866
+ ```
567
867
 
568
868
  ---
569
869
 
@@ -571,33 +871,342 @@ The ⁠ptOptions property determines how a component's local PassThrough configu
571
871
 
572
872
  Integration between ExhaustiveUI and Tailwind CSS.
573
873
 
574
- ## Animations
874
+ ## Overview
575
875
 
576
- The plugin also adds extended animation utilities that can be used with the styleclass and animateonscroll directives.
876
+ Tailwind CSS is a popular CSS framework based on a utility-first design. The core provides flexible CSS classes with predefined CSS rules to build your own UI elements. For example, instead of an opinionated `btn` class as in
877
+ Bootstrap, Tailwind offers primitive classes like `bg-blue-500`, `rounded` and `p-4` to apply a button. A set of reusable classes can also be grouped as a Tailwind CSS component and there are even a couple of libraries
878
+ that take this approach to build components specifically for Tailwind.
879
+
880
+ Tailwind is an outstanding CSS library, however it lacks a true comprehensive UI suite when combined with Angular, this is where ExhaustiveUI comes in by providing a wide range of highly accessible and feature rich UI component
881
+ library. The core of ExhaustiveUI does not depend on Tailwind CSS.
882
+
883
+ ## Plugin
884
+
885
+ The [@exhaustive-ui/tailwindcss](https://www.npmjs.com/package/@exhaustive-ui/tailwindcss) is a plugin to provide first class integration between ExhaustiveUI and Tailwind CSS. It
886
+ is designed to work both in styled and unstyled modes. In styled mode, for instance the semantic colors such as primary and surfaces are provided as Tailwind utilities e.g. `bg-primary`, `text-surface-500`,
887
+ `text-muted-color`.
888
+
889
+ If you haven't already done so, start by integrating Tailwind into your project. Detailed steps for this process can be found in the Tailwind
890
+ [documentation](https://tailwindcss.com/). After successfully installing Tailwind, proceed with the installation of the ExhaustiveUiTailwind plugin. This single npm package comes
891
+ with two libraries: the CSS version is compatible with Tailwind v4, the recommended version, while the JS version is designed for Tailwind v3.
892
+
893
+ ### Tailwind v4
894
+
895
+ In the CSS file that contains the tailwindcss import, add the `@exhaustive-ui/tailwindcss` import as well.
896
+
897
+ For a comprehensive starter guide, review the [ExhaustiveUI](https://github.com/e-xiste/exhaustive-ui) repository which demonstrates the integration.
898
+
899
+ ### Tailwind v3
900
+
901
+ Use the plugins option in your Tailwind config file to configure the plugin.
902
+
903
+ ## Extensions
904
+
905
+ The plugin extends the default configuration with a new set of utilities. All variants and breakpoints are supported e.g.
906
+ `dark:sm:hover:bg-primary`.
907
+
908
+ ### Color Palette
909
+
910
+ Class
911
+ Property
912
+ primary-[50-950]
913
+ Primary color palette.
914
+ surface-[0-950]
915
+ Surface color palette.
916
+ primary
917
+ Default primary color.
918
+ primary-contrast
919
+ Default primary contrast color.
920
+ primary-emphasis
921
+ Default primary emphasis color.
922
+ border-surface
923
+ Default primary emphasis color.
924
+ bg-emphasis
925
+ Emphasis background e.g. hovered element.
926
+ bg-highlight
927
+ Highlight background.
928
+ bg-highlight-emphasis
929
+ Highlight background with emphasis.
930
+ rounded-border
931
+ Border radius.
932
+ text-color
933
+ Text color with emphasis.
934
+ text-color-emphasis
935
+ Default primary emphasis color.
936
+ text-muted-color
937
+ Secondary text color.
938
+ text-muted-color-emphasis
939
+ Secondary text color with emphasis.
940
+
941
+ ## Dark Mode
942
+
943
+ In styled mode, ExhaustiveUI uses the `system` as the default `darkModeSelector` in theme configuration. If you have a dark mode switch in your application, ensure that `darkModeSelector` is aligned with the Tailwind
944
+ dark variant for seamless integration. Note that, this particular configuration isn't required if you're utilizing the default system color scheme.
945
+
946
+ Suppose that, the darkModeSelector is set as `my-app-dark` in ExhaustiveUI.
947
+
948
+ ### Tailwind v4
949
+
950
+ Add a custom variant for dark with a custom selector.
951
+
952
+ ### Tailwind v3
953
+
954
+ Use the plugins option in your Tailwind config file to configure the plugin.
955
+
956
+ ## Override
957
+
958
+ Tailwind utilities may not be able to override the default styling of components due to css specificity, there are two possible solutions; Import and CSS Layer.
959
+
960
+ ### Important
961
+
962
+ Use the `!` important modifier to enforce the styling: Tailwind v4 places it at the end of the class name, Tailwind v3 at the start. This is not the recommend approach, and should be used as last resort to avoid adding
963
+ unnecessary style classes to your bundle.
964
+
965
+ Tailwind v4
966
+
967
+ Tailwind v3
968
+
969
+ ### CSS Layer
970
+
971
+ CSS Layer provides control over the css specificity so that Tailwind utilities can safely override components.
972
+
973
+ Tailwind v4
974
+
975
+ Ensure `exhaustive` layer is after `theme` and `base`, but before the other Tailwind layers such as `utilities`.
976
+
977
+ No change in the CSS configuration is required.
978
+
979
+ Tailwind v3
980
+
981
+ The `exhaustive` layer should be between base and utilities.
982
+
983
+ Tailwind v3 does not use native `layer` so needs to be defined with CSS.
984
+
985
+ ## Color Palette
986
+
987
+ ExhaustiveUI color palette as utility classes.
988
+
989
+ ```typescript
990
+ import { Component } from '@angular/core';
991
+
992
+ @Component({
993
+ template: `
994
+ <div class="card">
995
+ <div class="flex flex-col gap-12">
996
+ <ul class="p-0 m-0 list-none flex sm:flex-col gap-4 flex-wrap sm:flex-nowrap">
997
+ <li *ngFor="let color of colors; let i = index" [ngStyle]="{ 'min-width': '6rem' }" class="flex-auto">
998
+ <span class="font-medium capitalize block mb-2 text-center sm:text-left">{{ color }}</span>
999
+ <div class="flex gap-4 flex-auto flex-col sm:flex-row">
1000
+ <div *ngFor="let shade of shades" [ngClass]="{ invisible: color === 'primary' && shade === 0 }" class="flex flex-col items-center gap-1 flex-1">
1001
+ <div class="rounded-sm h-8 w-full" [ngStyle]="{ 'background-color': 'var(--p-' + color + '-' + shade + ')' }"></div>
1002
+ <span class="text-sm text-surface-500 dark:text-surface-400 font-medium">{{ shade }}</span>
1003
+ </div>
1004
+ </div>
1005
+ </li>
1006
+ </ul>
1007
+ <div class="flex gap-6 flex-wrap">
1008
+ <div class="rounded-border p-4 border border-transparent flex items-center justify-center bg-primary hover:bg-primary-emphasis text-primary-contrast font-medium flex-auto transition-colors">primary</div>
1009
+ <div class="rounded-border p-4 border border-transparent flex items-center justify-center bg-highlight hover:bg-highlight-emphasis font-medium flex-auto transition-colors">highlight</div>
1010
+ <div class="rounded-border p-4 border border-surface flex items-center justify-center text-muted-color hover:text-color hover:bg-emphasis font-medium flex-auto transition-colors">box</div>
1011
+ </div>
1012
+ </div>
1013
+ </div>
1014
+ `,
1015
+ standalone: true,
1016
+ imports: []
1017
+ })
1018
+ export class TailwindColorpaletteDemo {
1019
+ shades: number[] = [0, 50, 100, 200, 300, 400, 500, 600, 700, 800, 900, 950];
1020
+ colors: string[] = ['primary', 'surface'];
1021
+ }
1022
+ ```
1023
+
1024
+ ## Form
1025
+
1026
+ Using Tailwind utilities for the responsive layout of a form with ExhaustiveUI components.
577
1027
 
578
1028
  ```typescript
579
1029
  import { Component, OnInit } from '@angular/core';
580
1030
  import { FormsModule } from '@angular/forms';
1031
+ import { DatePickerModule } from '@exhaustive-ui/core/datepicker';
581
1032
  import { SelectModule } from '@exhaustive-ui/core/select';
1033
+ import { InputTextModule } from '@exhaustive-ui/core/inputtext';
1034
+ import { Country } from '@/domain/customer';
582
1035
 
583
1036
  @Component({
584
1037
  template: `
585
- <div class="card">
586
- <p-select [(ngModel)]="animation" [options]="animations" placeholder="Select One" class="w-full sm:w-44" />
587
- <div class="py-8 overflow-hidden">
588
- <div [ngClass]="dynamicAnimationClasses"></div>
1038
+ <div class="card flex sm:justify-center">
1039
+ <div class="flex flex-col gap-6 w-full sm:w-auto">
1040
+ <div class="flex flex-col sm:flex-row sm:items-center gap-6">
1041
+ <div class="flex-auto">
1042
+ <label for="firstname" class="block font-semibold mb-2">Firstname</label>
1043
+ <input type="text" pInputText id="firstname" class="w-full" />
1044
+ </div>
1045
+ <div class="flex-auto">
1046
+ <label for="lastname" class="block font-semibold mb-2">Lastname</label>
1047
+ <input type="text" pInputText id="lastname" class="w-full" />
1048
+ </div>
1049
+ </div>
1050
+ <div class="flex flex-col sm:flex-row sm:items-center gap-6">
1051
+ <div class="flex-1">
1052
+ <label for="date" class="block font-semibold mb-2">Date</label>
1053
+ <p-datepicker inputId="date" class="w-full" />
1054
+ </div>
1055
+ <div class="flex-1">
1056
+ <label for="country" class="block font-semibold mb-2">Country</label>
1057
+ <p-select [options]="countries" [(ngModel)]="selectedCountry" optionLabel="name" [showClear]="true" placeholder="Select a Country">
1058
+ <ng-template pTemplate="selectedItem">
1059
+ <div class="flex items-center gap-2" *ngIf="selectedCountry">
1060
+ <img src="https://exhaustive-ui.com/demo/flag/flag_placeholder.png" [class]="'flag flag-' + selectedCountry.code.toLowerCase()" style="width: 18px" />
1061
+ <div>{{ selectedCountry.name }}</div>
1062
+ </div>
1063
+ </ng-template>
1064
+ <ng-template let-country pTemplate="item">
1065
+ <div class="flex items-center gap-2">
1066
+ <img src="https://exhaustive-ui.com/demo/flag/flag_placeholder.png" [class]="'flag flag-' + country.code.toLowerCase()" style="width: 18px" />
1067
+ <div>{{ country.name }}</div>
1068
+ </div>
1069
+ </ng-template>
1070
+ </p-select>
1071
+ </div>
1072
+ </div>
1073
+ <div class="flex-auto">
1074
+ <label for="message" class="block font-semibold mb-2">Message</label>
1075
+ <textarea pTextarea id="message" class="w-full" rows="4"></textarea>
1076
+ </div>
589
1077
  </div>
590
1078
  </div>
591
- <h3>Animations</h3>
592
- <div class="doc-tablewrapper">
593
- <table class="doc-table">
594
- <thead>
595
- <tr>
596
- <th>Class</th>
597
- <th>Property</th>
598
- </tr>
599
- </thead>
600
- <tbody>
1079
+ `,
1080
+ standalone: true,
1081
+ imports: [DatePickerModule, SelectModule, InputTextModule, FormsModule]
1082
+ })
1083
+ export class TailwindFormDemo implements OnInit {
1084
+ countries: any[] | undefined;
1085
+ selectedCountry: string | undefined;
1086
+
1087
+ ngOnInit() {
1088
+ this.countries = [
1089
+ { name: 'Australia', code: 'AU' },
1090
+ { name: 'Brazil', code: 'BR' },
1091
+ { name: 'China', code: 'CN' },
1092
+ { name: 'Egypt', code: 'EG' },
1093
+ { name: 'France', code: 'FR' },
1094
+ { name: 'Germany', code: 'DE' },
1095
+ { name: 'India', code: 'IN' },
1096
+ { name: 'Japan', code: 'JP' },
1097
+ { name: 'Spain', code: 'ES' },
1098
+ { name: 'United States', code: 'US' }
1099
+ ];
1100
+ }
1101
+ }
1102
+ ```
1103
+
1104
+ ## Headless
1105
+
1106
+ A headless ExhaustiveUI dialog with a custom UI.
1107
+
1108
+ ```typescript
1109
+ import { Component } from '@angular/core';
1110
+ import { ButtonModule } from '@exhaustive-ui/core/button';
1111
+ import { DialogModule } from '@exhaustive-ui/core/dialog';
1112
+ import { InputTextModule } from '@exhaustive-ui/core/inputtext';
1113
+
1114
+ @Component({
1115
+ template: `
1116
+ <div class="card flex justify-center">
1117
+ <p-button (click)="showDialog()" icon="pi pi-user" label="Login" />
1118
+ <p-dialog maskStyleClass="backdrop-blur-xs" [(visible)]="visible" styleClass="border-0! bg-transparent!">
1119
+ <ng-template pTemplate="headless">
1120
+ <div class="flex flex-col px-8 py-8 gap-6 rounded-2xl" style="border-radius: 12px; background-image: radial-gradient(circle at left top, var(--p-primary-400), var(--p-primary-700))">
1121
+ <svg width="31" height="33" viewBox="0 0 31 33" fill="none" xmlns="http://www.w3.org/2000/svg" class="block mx-auto">
1122
+ <path d="M15.1934 0V0V0L0.0391235 5.38288L2.35052 25.3417L15.1934 32.427V32.427V32.427L28.0364 25.3417L30.3478 5.38288L15.1934 0Z" fill="var(--p-primary-color)" />
1123
+ <mask id="mask0_1_52" style="mask-type:luminance" maskUnits="userSpaceOnUse" x="0" y="0" width="31" height="33">
1124
+ <path d="M15.1934 0V0V0L0.0391235 5.38288L2.35052 25.3417L15.1934 32.427V32.427V32.427L28.0364 25.3417L30.3478 5.38288L15.1934 0Z" fill="var(--ground-background)" />
1125
+ </mask>
1126
+ <g mask="url(#mask0_1_52)">
1127
+ <path fill-rule="evenodd" clip-rule="evenodd" d="M15.1935 0V3.5994V3.58318V20.0075V20.0075V32.427V32.427L28.0364 25.3417L30.3478 5.38288L15.1935 0Z" fill="var(--p-primary-color)" />
1128
+ </g>
1129
+ <path d="M19.6399 15.3776L18.1861 15.0547L19.3169 16.6695V21.6755L23.1938 18.4458V12.9554L21.4169 13.6013L19.6399 15.3776Z" fill="var(--ground-background)" />
1130
+ <path d="M10.5936 15.3776L12.0474 15.0547L10.9166 16.6695V21.6755L7.03966 18.4458V12.9554L8.81661 13.6013L10.5936 15.3776Z" fill="var(--ground-background)" />
1131
+ <path
1132
+ fill-rule="evenodd"
1133
+ clip-rule="evenodd"
1134
+ d="M11.3853 16.9726L12.6739 15.0309L13.4793 15.5163H16.7008L17.5061 15.0309L18.7947 16.9726V24.254L17.8283 25.7103L16.7008 26.843H13.4793L12.3518 25.7103L11.3853 24.254V16.9726Z"
1135
+ fill="var(--ground-background)"
1136
+ />
1137
+ <path d="M19.3168 24.7437L21.4168 22.6444V20.5451L19.3168 22.3214V24.7437Z" fill="var(--ground-background)" />
1138
+ <path d="M10.9166 24.7437L8.81662 22.6444V20.5451L10.9166 22.3214V24.7437Z" fill="var(--ground-background)" />
1139
+ <path
1140
+ fill-rule="evenodd"
1141
+ clip-rule="evenodd"
1142
+ d="M13.0167 5.68861L11.7244 8.7568L13.8244 14.8932H14.7936V5.68861H13.0167ZM15.4397 5.68861V14.8932H16.5706L18.5091 8.7568L17.2167 5.68861H15.4397Z"
1143
+ fill="var(--ground-background)"
1144
+ />
1145
+ <path d="M13.8244 14.8932L6.87813 12.3094L5.90888 8.27235L11.8859 8.7568L13.9859 14.8932H13.8244Z" fill="var(--ground-background)" />
1146
+ <path d="M16.5706 14.8932L23.5169 12.3094L24.4861 8.27235L18.3476 8.7568L16.4091 14.8932H16.5706Z" fill="var(--ground-background)" />
1147
+ <path d="M18.8321 8.27235L22.2245 7.94938L19.9629 5.68861H17.7013L18.8321 8.27235Z" fill="var(--ground-background)" />
1148
+ <path d="M11.4013 8.27235L8.00893 7.94938L10.2705 5.68861H12.5321L11.4013 8.27235Z" fill="var(--ground-background)" />
1149
+ </svg>
1150
+ <div class="inline-flex flex-col gap-2">
1151
+ <label for="username" class="text-primary-50 font-semibold">Username</label>
1152
+ <input pInputText id="username" class="bg-white/20! border-0! p-4! text-primary-50! w-80" />
1153
+ </div>
1154
+ <div class="inline-flex flex-col gap-2">
1155
+ <label for="password" class="text-primary-50 font-semibold">Password</label>
1156
+ <input pInputText id="password" class="bg-white/20! border-0! p-4! text-primary-50! w-80" type="password" />
1157
+ </div>
1158
+ <div class="flex items-center gap-4">
1159
+ <p-button label="Cancel" (click)="closeDialog()" [text]="true" styleClass="p-4! w-full text-primary-50! border! border-white/30! hover:bg-white/10!" class="w-full" />
1160
+ <p-button label="Sign-In" (click)="closeDialog()" [text]="true" styleClass="p-4! w-full text-primary-50! border! border-white/30! hover:bg-white/10!" class="w-full" />
1161
+ </div>
1162
+ </div>
1163
+ </ng-template>
1164
+ </p-dialog>
1165
+ </div>
1166
+ `,
1167
+ standalone: true,
1168
+ imports: [ButtonModule, DialogModule, InputTextModule]
1169
+ })
1170
+ export class TailwindHeadlessDemo {
1171
+ visible: boolean = false;
1172
+
1173
+ showDialog() {
1174
+ this.visible = true;
1175
+ }
1176
+
1177
+ closeDialog() {
1178
+ this.visible = false;
1179
+ }
1180
+ }
1181
+ ```
1182
+
1183
+ ## Animations
1184
+
1185
+ The plugin also adds extended animation utilities that can be used with the styleclass and animateonscroll directives.
1186
+
1187
+ ```typescript
1188
+ import { Component, OnInit } from '@angular/core';
1189
+ import { FormsModule } from '@angular/forms';
1190
+ import { SelectModule } from '@exhaustive-ui/core/select';
1191
+
1192
+ @Component({
1193
+ template: `
1194
+ <div class="card">
1195
+ <p-select [(ngModel)]="animation" [options]="animations" placeholder="Select One" class="w-full sm:w-44" />
1196
+ <div class="py-8 overflow-hidden">
1197
+ <div [ngClass]="dynamicAnimationClasses"></div>
1198
+ </div>
1199
+ </div>
1200
+ <h3>Animations</h3>
1201
+ <div class="doc-tablewrapper">
1202
+ <table class="doc-table">
1203
+ <thead>
1204
+ <tr>
1205
+ <th>Class</th>
1206
+ <th>Property</th>
1207
+ </tr>
1208
+ </thead>
1209
+ <tbody>
601
1210
  <tr>
602
1211
  <td>animate-fadein</td>
603
1212
  <td>fadein 0.15s linear</td>
@@ -990,309 +1599,312 @@ export class TailwindAnimationsDemo implements OnInit {
990
1599
  }
991
1600
  ```
992
1601
 
993
- ## Colorpalette
1602
+ ---
994
1603
 
995
- ExhaustiveUI color palette as utility classes.
1604
+ # LLMs.txt
996
1605
 
997
- ```typescript
998
- import { Component } from '@angular/core';
1606
+ LLM-optimized documentation endpoints for ExhaustiveUI components.
999
1607
 
1000
- @Component({
1001
- template: `
1002
- <div class="card">
1003
- <div class="flex flex-col gap-12">
1004
- <ul class="p-0 m-0 list-none flex sm:flex-col gap-4 flex-wrap sm:flex-nowrap">
1005
- <li *ngFor="let color of colors; let i = index" [ngStyle]="{ 'min-width': '6rem' }" class="flex-auto">
1006
- <span class="font-medium capitalize block mb-2 text-center sm:text-left">{{ color }}</span>
1007
- <div class="flex gap-4 flex-auto flex-col sm:flex-row">
1008
- <div *ngFor="let shade of shades" [ngClass]="{ invisible: color === 'primary' && shade === 0 }" class="flex flex-col items-center gap-1 flex-1">
1009
- <div class="rounded-sm h-8 w-full" [ngStyle]="{ 'background-color': 'var(--p-' + color + '-' + shade + ')' }"></div>
1010
- <span class="text-sm text-surface-500 dark:text-surface-400 font-medium">{{ shade }}</span>
1011
- </div>
1012
- </div>
1013
- </li>
1014
- </ul>
1015
- <div class="flex gap-6 flex-wrap">
1016
- <div class="rounded-border p-4 border border-transparent flex items-center justify-center bg-primary hover:bg-primary-emphasis text-primary-contrast font-medium flex-auto transition-colors">primary</div>
1017
- <div class="rounded-border p-4 border border-transparent flex items-center justify-center bg-highlight hover:bg-highlight-emphasis font-medium flex-auto transition-colors">highlight</div>
1018
- <div class="rounded-border p-4 border border-surface flex items-center justify-center text-muted-color hover:text-color hover:bg-emphasis font-medium flex-auto transition-colors">box</div>
1019
- </div>
1020
- </div>
1021
- </div>
1022
- `,
1023
- standalone: true,
1024
- imports: []
1025
- })
1026
- export class TailwindColorpaletteDemo {
1027
- shades: number[] = [0, 50, 100, 200, 300, 400, 500, 600, 700, 800, 900, 950];
1028
- colors: string[] = ['primary', 'surface'];
1029
- }
1608
+ ## /llms.txt
1609
+
1610
+ The [llms.txt](https://llmstxt.org/) file is an industry standard that helps AI models better understand and navigate the ExhaustiveUI documentation. It lists key pages in a
1611
+ structured format, making it easier for LLMs to retrieve relevant information.
1612
+
1613
+ [
1614
+
1615
+ ](/llms/llms.txt)
1616
+
1617
+ ## /llms-full.txt
1618
+
1619
+ The `llms-full.txt` file is a complete list of all the pages in the ExhaustiveUI documentation. It is used to help AI models understand the entire documentation set.
1620
+
1621
+ [
1622
+
1623
+ ](/llms/llms-full.txt)
1624
+
1625
+ ## .md extension
1626
+
1627
+ Add a `.md` to a page's URL to display a Markdown version of that page.
1628
+
1629
+ [
1630
+
1631
+ ](/llms/components/button.md)
1632
+
1633
+ ## Agent Skill
1634
+
1635
+ The markdown files above are also bundled as an [Agent Skill](https://agentskills.io), the `SKILL.md` format supported by coding agents such as Claude Code,
1636
+ Codex, Cursor and OpenCode. Once installed, the agent reads the component docs, API tables and guides from disk whenever it works on ExhaustiveUI code, instead of fetching them from this site each time.
1637
+
1638
+ Install it with the [skills CLI](https://skills.sh/docs/cli), which asks which agents to set it up for.
1639
+
1640
+ ```bash
1641
+ npx skills add https://exhaustive-ui.com
1642
+
1643
+ # update to the latest docs
1644
+ npx skills update exhaustive-ui
1030
1645
  ```
1031
1646
 
1032
- ## Darkmode
1647
+ By default the skill is installed into the current project, so your team gets it too. Add `-g` to install it for your user instead. You can also download the zip and extract it into a folder named `exhaustive-ui` in your
1648
+ agent's skills directory.
1033
1649
 
1034
- In styled mode, ExhaustiveUI uses the system as the default darkModeSelector in theme configuration. If you have a dark mode switch in your application, ensure that darkModeSelector is aligned with the Tailwind dark variant for seamless integration. Note that, this particular configuration isn't required if you're utilizing the default system color scheme. Suppose that, the darkModeSelector is set as my-app-dark in ExhaustiveUI. Tailwind v4 Add a custom variant for dark with a custom selector. Tailwind v3 Use the plugins option in your Tailwind config file to configure the plugin.
1650
+ [
1035
1651
 
1036
- ## Extensions
1652
+ ](/llms/exhaustive-ui-skill.zip)
1037
1653
 
1038
- The plugin extends the default configuration with a new set of utilities. All variants and breakpoints are supported e.g. dark:sm:hover:bg-primary . Color Palette Class Property primary-[50-950] Primary color palette. surface-[0-950] Surface color palette. primary Default primary color. primary-contrast Default primary contrast color. primary-emphasis Default primary emphasis color. border-surface Default primary emphasis color. bg-emphasis Emphasis background e.g. hovered element. bg-highlight Highlight background. bg-highlight-emphasis Highlight background with emphasis. rounded-border Border radius. text-color Text color with emphasis. text-color-emphasis Default primary emphasis color. text-muted-color Secondary text color. text-muted-color-emphasis Secondary text color with emphasis.
1654
+ ## MCP Server
1039
1655
 
1040
- ## Form
1656
+ [@exhaustive-ui/mcp](https://www.npmjs.com/package/@exhaustive-ui/mcp) is a
1657
+ [Model Context Protocol](https://modelcontextprotocol.io) server that gives coding agents such as Claude Code, Cursor, Claude Desktop, VS Code Copilot and Codex
1658
+ tools to query this documentation instead of guessing from PrimeNG memory: list and search components, read a component's docs and API, fetch a complete code example, read the setup guides, and validate an Angular template against the
1659
+ compiled API (unknown inputs or outputs, invalid literal values, unsupported two-way bindings, deprecated inputs, PrimeNG imports and selectors).
1041
1660
 
1042
- Using Tailwind utilities for the responsive layout of a form with ExhaustiveUI components.
1661
+ The server reads the files described on this page from the live site, so it always reflects the deployed documentation without reinstalling the package, and keeps them in memory for 15 minutes. A snapshot of the same files is bundled
1662
+ in the package and used when the network is unavailable.
1043
1663
 
1044
- ```typescript
1045
- import { Component, OnInit } from '@angular/core';
1046
- import { FormsModule } from '@angular/forms';
1047
- import { DatePickerModule } from '@exhaustive-ui/core/datepicker';
1048
- import { SelectModule } from '@exhaustive-ui/core/select';
1049
- import { InputTextModule } from '@exhaustive-ui/core/inputtext';
1050
- import { Country } from '@/domain/customer';
1664
+ Register it with Claude Code:
1051
1665
 
1052
- @Component({
1053
- template: `
1054
- <div class="card flex sm:justify-center">
1055
- <div class="flex flex-col gap-6 w-full sm:w-auto">
1056
- <div class="flex flex-col sm:flex-row sm:items-center gap-6">
1057
- <div class="flex-auto">
1058
- <label for="firstname" class="block font-semibold mb-2">Firstname</label>
1059
- <input type="text" pInputText id="firstname" class="w-full" />
1060
- </div>
1061
- <div class="flex-auto">
1062
- <label for="lastname" class="block font-semibold mb-2">Lastname</label>
1063
- <input type="text" pInputText id="lastname" class="w-full" />
1064
- </div>
1065
- </div>
1066
- <div class="flex flex-col sm:flex-row sm:items-center gap-6">
1067
- <div class="flex-1">
1068
- <label for="date" class="block font-semibold mb-2">Date</label>
1069
- <p-datepicker inputId="date" class="w-full" />
1070
- </div>
1071
- <div class="flex-1">
1072
- <label for="country" class="block font-semibold mb-2">Country</label>
1073
- <p-select [options]="countries" [(ngModel)]="selectedCountry" optionLabel="name" [showClear]="true" placeholder="Select a Country">
1074
- <ng-template pTemplate="selectedItem">
1075
- <div class="flex items-center gap-2" *ngIf="selectedCountry">
1076
- <img src="https://exhaustive-ui.com/demo/flag/flag_placeholder.png" [class]="'flag flag-' + selectedCountry.code.toLowerCase()" style="width: 18px" />
1077
- <div>{{ selectedCountry.name }}</div>
1078
- </div>
1079
- </ng-template>
1080
- <ng-template let-country pTemplate="item">
1081
- <div class="flex items-center gap-2">
1082
- <img src="https://exhaustive-ui.com/demo/flag/flag_placeholder.png" [class]="'flag flag-' + country.code.toLowerCase()" style="width: 18px" />
1083
- <div>{{ country.name }}</div>
1084
- </div>
1085
- </ng-template>
1086
- </p-select>
1087
- </div>
1088
- </div>
1089
- <div class="flex-auto">
1090
- <label for="message" class="block font-semibold mb-2">Message</label>
1091
- <textarea pTextarea id="message" class="w-full" rows="4"></textarea>
1092
- </div>
1093
- </div>
1094
- </div>
1095
- `,
1096
- standalone: true,
1097
- imports: [DatePickerModule, SelectModule, InputTextModule, FormsModule]
1098
- })
1099
- export class TailwindFormDemo implements OnInit {
1100
- countries: any[] | undefined;
1101
- selectedCountry: string | undefined;
1666
+ ```bash
1667
+ claude mcp add exhaustive-ui -s user -- npx -y @exhaustive-ui/mcp
1668
+ ```
1102
1669
 
1103
- ngOnInit() {
1104
- this.countries = [
1105
- { name: 'Australia', code: 'AU' },
1106
- { name: 'Brazil', code: 'BR' },
1107
- { name: 'China', code: 'CN' },
1108
- { name: 'Egypt', code: 'EG' },
1109
- { name: 'France', code: 'FR' },
1110
- { name: 'Germany', code: 'DE' },
1111
- { name: 'India', code: 'IN' },
1112
- { name: 'Japan', code: 'JP' },
1113
- { name: 'Spain', code: 'ES' },
1114
- { name: 'United States', code: 'US' }
1115
- ];
1670
+ Or add it to the MCP configuration of your client (`.cursor/mcp.json`, `claude_desktop_config.json`, `.vscode/mcp.json` with a `servers` key, ...):
1671
+
1672
+ ```typescript
1673
+ {
1674
+ "mcpServers": {
1675
+ "exhaustive-ui": {
1676
+ "command": "npx",
1677
+ "args": ["-y", "@exhaustive-ui/mcp"]
1116
1678
  }
1679
+ }
1117
1680
  }
1118
1681
  ```
1119
1682
 
1120
- ## Headless
1683
+ The server exposes the `list`, `search`, `get_component`, `get_guide`, `get_example`, `get_setup`, `validate_usage` and `version` tools, the Markdown files of this page as MCP resources, and
1684
+ prompts for the usual tasks (use a component, build a form, theme a component, migrate from PrimeNG, audit usage). Set `EXHAUSTIVE_UI_DOCS_URL` to read another deployment of the docs, for instance a local `ng serve`, and
1685
+ `EXHAUSTIVE_UI_MCP_OFFLINE=1` to only use the bundled snapshot. The package README lists every option.
1121
1686
 
1122
- A headless ExhaustiveUI dialog with a custom UI.
1687
+ ## Manifest
1123
1688
 
1124
- ```typescript
1125
- import { Component } from '@angular/core';
1126
- import { ButtonModule } from '@exhaustive-ui/core/button';
1127
- import { DialogModule } from '@exhaustive-ui/core/dialog';
1128
- import { InputTextModule } from '@exhaustive-ui/core/inputtext';
1689
+ [/llms/manifest.json](/llms/manifest.json) describes every component, directive, NgModule, service and exported type as structured data, for tools that need exact facts rather than prose:
1690
+ MCP servers, code generators, linters and design tool integrations. It is generated from the Angular metadata in the compiled library, so selectors and inputs match what the compiler accepts.
1129
1691
 
1130
- @Component({
1131
- template: `
1132
- <div class="card flex justify-center">
1133
- <p-button (click)="showDialog()" icon="pi pi-user" label="Login" />
1134
- <p-dialog maskStyleClass="backdrop-blur-xs" [(visible)]="visible" styleClass="border-0! bg-transparent!">
1135
- <ng-template pTemplate="headless">
1136
- <div class="flex flex-col px-8 py-8 gap-6 rounded-2xl" style="border-radius: 12px; background-image: radial-gradient(circle at left top, var(--p-primary-400), var(--p-primary-700))">
1137
- <svg width="31" height="33" viewBox="0 0 31 33" fill="none" xmlns="http://www.w3.org/2000/svg" class="block mx-auto">
1138
- <path d="M15.1934 0V0V0L0.0391235 5.38288L2.35052 25.3417L15.1934 32.427V32.427V32.427L28.0364 25.3417L30.3478 5.38288L15.1934 0Z" fill="var(--p-primary-color)" />
1139
- <mask id="mask0_1_52" style="mask-type:luminance" maskUnits="userSpaceOnUse" x="0" y="0" width="31" height="33">
1140
- <path d="M15.1934 0V0V0L0.0391235 5.38288L2.35052 25.3417L15.1934 32.427V32.427V32.427L28.0364 25.3417L30.3478 5.38288L15.1934 0Z" fill="var(--ground-background)" />
1141
- </mask>
1142
- <g mask="url(#mask0_1_52)">
1143
- <path fill-rule="evenodd" clip-rule="evenodd" d="M15.1935 0V3.5994V3.58318V20.0075V20.0075V32.427V32.427L28.0364 25.3417L30.3478 5.38288L15.1935 0Z" fill="var(--p-primary-color)" />
1144
- </g>
1145
- <path d="M19.6399 15.3776L18.1861 15.0547L19.3169 16.6695V21.6755L23.1938 18.4458V12.9554L21.4169 13.6013L19.6399 15.3776Z" fill="var(--ground-background)" />
1146
- <path d="M10.5936 15.3776L12.0474 15.0547L10.9166 16.6695V21.6755L7.03966 18.4458V12.9554L8.81661 13.6013L10.5936 15.3776Z" fill="var(--ground-background)" />
1147
- <path
1148
- fill-rule="evenodd"
1149
- clip-rule="evenodd"
1150
- d="M11.3853 16.9726L12.6739 15.0309L13.4793 15.5163H16.7008L17.5061 15.0309L18.7947 16.9726V24.254L17.8283 25.7103L16.7008 26.843H13.4793L12.3518 25.7103L11.3853 24.254V16.9726Z"
1151
- fill="var(--ground-background)"
1152
- />
1153
- <path d="M19.3168 24.7437L21.4168 22.6444V20.5451L19.3168 22.3214V24.7437Z" fill="var(--ground-background)" />
1154
- <path d="M10.9166 24.7437L8.81662 22.6444V20.5451L10.9166 22.3214V24.7437Z" fill="var(--ground-background)" />
1155
- <path
1156
- fill-rule="evenodd"
1157
- clip-rule="evenodd"
1158
- d="M13.0167 5.68861L11.7244 8.7568L13.8244 14.8932H14.7936V5.68861H13.0167ZM15.4397 5.68861V14.8932H16.5706L18.5091 8.7568L17.2167 5.68861H15.4397Z"
1159
- fill="var(--ground-background)"
1160
- />
1161
- <path d="M13.8244 14.8932L6.87813 12.3094L5.90888 8.27235L11.8859 8.7568L13.9859 14.8932H13.8244Z" fill="var(--ground-background)" />
1162
- <path d="M16.5706 14.8932L23.5169 12.3094L24.4861 8.27235L18.3476 8.7568L16.4091 14.8932H16.5706Z" fill="var(--ground-background)" />
1163
- <path d="M18.8321 8.27235L22.2245 7.94938L19.9629 5.68861H17.7013L18.8321 8.27235Z" fill="var(--ground-background)" />
1164
- <path d="M11.4013 8.27235L8.00893 7.94938L10.2705 5.68861H12.5321L11.4013 8.27235Z" fill="var(--ground-background)" />
1165
- </svg>
1166
- <div class="inline-flex flex-col gap-2">
1167
- <label for="username" class="text-primary-50 font-semibold">Username</label>
1168
- <input pInputText id="username" class="bg-white/20! border-0! p-4! text-primary-50! w-80" />
1169
- </div>
1170
- <div class="inline-flex flex-col gap-2">
1171
- <label for="password" class="text-primary-50 font-semibold">Password</label>
1172
- <input pInputText id="password" class="bg-white/20! border-0! p-4! text-primary-50! w-80" type="password" />
1173
- </div>
1174
- <div class="flex items-center gap-4">
1175
- <p-button label="Cancel" (click)="closeDialog()" [text]="true" styleClass="p-4! w-full text-primary-50! border! border-white/30! hover:bg-white/10!" class="w-full" />
1176
- <p-button label="Sign-In" (click)="closeDialog()" [text]="true" styleClass="p-4! w-full text-primary-50! border! border-white/30! hover:bg-white/10!" class="w-full" />
1177
- </div>
1178
- </div>
1179
- </ng-template>
1180
- </p-dialog>
1181
- </div>
1182
- `,
1183
- standalone: true,
1184
- imports: [ButtonModule, DialogModule, InputTextModule]
1185
- })
1186
- export class TailwindHeadlessDemo {
1187
- visible: boolean = false;
1188
-
1189
- showDialog() {
1190
- this.visible = true;
1191
- }
1692
+ Each entry point lists its import path, NgModule, services and exported types. Each component or directive lists its selector, inputs with type, allowed values, default, transform and two-way binding, outputs with payload type,
1693
+ templates with their context type, methods, forms support and pass-through keys.
1192
1694
 
1193
- closeDialog() {
1194
- this.visible = false;
1695
+ ```typescript
1696
+ {
1697
+ "schemaVersion": 1,
1698
+ "entryPoints": [
1699
+ {
1700
+ "name": "button",
1701
+ "import": "@exhaustive-ui/core/button",
1702
+ "modules": ["ButtonModule"],
1703
+ "declarations": [
1704
+ {
1705
+ "kind": "component",
1706
+ "className": "Button",
1707
+ "selector": "p-button",
1708
+ "inputs": [
1709
+ { "name": "severity", "type": "ButtonSeverity", "values": ["success", "info", "warn", "danger", "secondary", "contrast", "help", "primary"] },
1710
+ { "name": "raised", "type": "boolean", "default": "false", "transform": "booleanAttribute" }
1711
+ ],
1712
+ "outputs": [{ "name": "onClick", "payload": "MouseEvent" }],
1713
+ "templates": [{ "name": "icon", "context": "ButtonIconTemplateContext" }]
1714
+ }
1715
+ ]
1195
1716
  }
1717
+ ]
1196
1718
  }
1197
1719
  ```
1198
1720
 
1199
- ## Override
1721
+ ---
1722
+
1723
+ # Accessibility
1724
+
1725
+ ExhaustiveUI has WCAG 2.1 AA level compliance.
1726
+
1727
+ ## Colors
1728
+
1729
+ Colors on a web page should aim a contrast ratio of at least **4.5:1** and consider a selection of colors that do not cause vibration.
1730
+
1731
+ ### Good Contrast
1732
+
1733
+ Color contrast between the background and the foreground content should be sufficient enough to ensure readability. Example below displays two cases with good and bad samples.
1734
+
1735
+ GOOD
1736
+ BAD
1737
+
1738
+ ### Vibration
1739
+
1740
+ Color vibration is leads to an illusion of motion due to choosing colors that have low visibility against each other. Color combinations need to be picked with caution to avoid vibration.
1741
+
1742
+ VIBRATE
1743
+
1744
+ ### Dark Mode
1745
+
1746
+ Highly saturated colors should be avoided when used within a dark design scheme as they cause eye strain. Instead desaturated colors should be preferred.
1747
+
1748
+ Indigo 500
1749
+ Indigo 200
1750
+
1751
+ ## Formcontrols
1752
+
1753
+ Native form elements should be preferred instead of elements that are meant for other purposes like presentation. As an example, button below is rendered as a form control by the browser, can receive focus via tabbing and can be used
1754
+ with space key as well to trigger.
1755
+
1756
+ ```html
1757
+ <button (click)="onButtonClick($event)">Click></button>
1758
+ ```
1759
+
1760
+ On the other hand, a fancy css based button using a div has no keyboard or screen reader support.
1761
+
1762
+ ```html
1763
+ <div class="fancy-button" (click)="onButtonClick($event)">Click</div>
1764
+ ```
1765
+
1766
+ `tabindex` is required to make a div element accessible in addition to use a keydown to bring the keyboard support back. To avoid the overload and implementing functionality that is already provided by the browser, native form
1767
+ controls should be preferred.
1768
+
1769
+ ```html
1770
+ <div class="fancy-button" (click)="onButtonClick($event)" (keydown)="onKeyDown($event)" tabIndex="0">Click</div>
1771
+ ```
1772
+
1773
+ ### Relations
1774
+
1775
+ Form components must be related to another element that describes what the form element is used for. This is usually achieved with the `label` element.
1776
+
1777
+ ```html
1778
+ <label for="myinput">Username:</label>
1779
+ <input id="myinput" type="text" name="username" />
1780
+ ```
1781
+
1782
+ ## Introduction
1200
1783
 
1201
- Tailwind utilities may not be able to override the default styling of components due to css specificity, there are two possible solutions; Import and CSS Layer. Important Use the ! important modifier to enforce the styling: Tailwind v4 places it at the end of the class name, Tailwind v3 at the start. This is not the recommend approach, and should be used as last resort to avoid adding unnecessary style classes to your bundle. Tailwind v4 Tailwind v3 CSS Layer CSS Layer provides control over the css specificity so that Tailwind utilities can safely override components. Tailwind v4 Ensure exhaustive layer is after theme and base , but before the other Tailwind layers such as utilities . No change in the CSS configuration is required. Tailwind v3 The exhaustive layer should be between base and utilities. Tailwind v3 does not use native layer so needs to be defined with CSS.
1784
+ According to the World Health Organization, 15% of the world population has a disability to some degree. As a result, accessibility features in any context such as a ramp for wheelchair users or a multimedia with captions are crucial
1785
+ to ensure content can be consumed by anyone.
1202
1786
 
1203
- ## Overview
1787
+ ### Disabilities
1204
1788
 
1205
- Tailwind CSS is a popular CSS framework based on a utility-first design. The core provides flexible CSS classes with predefined CSS rules to build your own UI elements. For example, instead of an opinionated btn class as in Bootstrap, Tailwind offers primitive classes like bg-blue-500 , rounded and p-4 to apply a button. A set of reusable classes can also be grouped as a Tailwind CSS component and there are even a couple of libraries that take this approach to build components specifically for Tailwind. Tailwind is an outstanding CSS library, however it lacks a true comprehensive UI suite when combined with Angular, this is where ExhaustiveUI comes in by providing a wide range of highly accessible and feature rich UI component library. The core of ExhaustiveUI does not depend on Tailwind CSS.
1789
+ Types of disabilities are diverse so you need to know your audience well and how they interact with the content created. There four main categories;
1206
1790
 
1207
- ## Plugin
1791
+ ### Visual Impairments
1208
1792
 
1209
- The @exhaustive-ui/tailwindcss is a plugin to provide first class integration between ExhaustiveUI and Tailwind CSS. It is designed to work both in styled and unstyled modes. In styled mode, for instance the semantic colors such as primary and surfaces are provided as Tailwind utilities e.g. bg-primary , text-surface-500 , text-muted-color . If you haven't already done so, start by integrating Tailwind into your project. Detailed steps for this process can be found in the Tailwind documentation . After successfully installing Tailwind, proceed with the installation of the ExhaustiveUiTailwind plugin. This single npm package comes with two libraries: the CSS version is compatible with Tailwind v4, the recommended version, while the JS version is designed for Tailwind v3. Tailwind v4 In the CSS file that contains the tailwindcss import, add the @exhaustive-ui/tailwindcss import as well. For a comprehensive starter guide, review the ExhaustiveUI repository which demonstrates the integration. Tailwind v3 Use the plugins option in your Tailwind config file to configure the plugin.
1793
+ Blindness, low-level vision or color blindness are the common types of visual impairments. Screen magnifiers and the color blind mode are usually built-in features of the browsers whereas for people who rely on screen readers, page
1794
+ developers are required to make sure content is readable by the readers. Popular readers are
1795
+ [NVDA](https://www.nvaccess.org), [JAWS](https://www.freedomscientific.com/Products/software/JAWS/) and
1796
+ [ChromeVox](https://www.chromevox.com).
1210
1797
 
1211
- ---
1798
+ ### Hearing Impairments
1212
1799
 
1213
- # LLMs.txt
1800
+ Deafness or hearing loss refers to the inability to hear sounds totally or partially. People with hearing impairments use assistive devices however it may not be enough when interacting with a web page. Common implementation is
1801
+ providing textual alternatives, transcripts and captions for content with audio.
1214
1802
 
1215
- LLM-optimized documentation endpoints for ExhaustiveUI components.
1803
+ ### Mobility Impairments
1216
1804
 
1217
- ## Agentskill
1805
+ People with mobility impairments have disabilities related to movement due to loss of a limb, paralysis or other varying reasons. Assistive technologies like a head pointer is a device to interact with a screen whereas keyboard or a
1806
+ trackpad remain as solutions for people who are not able to utilize a mouse.
1218
1807
 
1219
- The markdown files above are also bundled as an Agent Skill , the SKILL.md format supported by coding agents such as Claude Code, Codex, Cursor and OpenCode. Once installed, the agent reads the component docs, API tables and guides from disk whenever it works on ExhaustiveUI code, instead of fetching them from this site each time. Install it with the skills CLI , which asks which agents to set it up for. By default the skill is installed into the current project, so your team gets it too. Add -g to install it for your user instead. You can also download the zip and extract it into a folder named exhaustive-ui in your agent's skills directory.
1808
+ ### Cognitive Impairments
1220
1809
 
1221
- ## Llmsfulltxt
1810
+ Cognitive impairments have a wider range that includes people with learning disabilities, depression and dyslexia. A well designed content also leads to better user experience for people without disabilities so designing for cognitive
1811
+ impairments result in better design for any user.
1222
1812
 
1223
- The llms-full.txt file is a complete list of all the pages in the ExhaustiveUI documentation. It is used to help AI models understand the entire documentation set.
1813
+ ## Semantichtml
1224
1814
 
1225
- ## Llmstxt
1815
+ HTML offers various element to organize content on a web page that screen readers are aware of. Preferring Semantic HTML for good semantics provide out of the box support for reader which is not possible when regular
1816
+ `div` elements with classes are used. Consider the following example that do not mean too much for readers.
1226
1817
 
1227
- The llms.txt file is an industry standard that helps AI models better understand and navigate the ExhaustiveUI documentation. It lists key pages in a structured format, making it easier for LLMs to retrieve relevant information.
1818
+ ```html
1819
+ <div class="header"/>
1820
+ <div class="header-text">Header></div>
1821
+ </div>
1228
1822
 
1229
- ## Manifest
1823
+ <div class="nav"></div>
1230
1824
 
1231
- /llms/manifest.json describes every component, directive, NgModule, service and exported type as structured data, for tools that need exact facts rather than prose: MCP servers, code generators, linters and design tool integrations. It is generated from the Angular metadata in the compiled library, so selectors and inputs match what the compiler accepts. Each entry point lists its import path, NgModule, services and exported types. Each component or directive lists its selector, inputs with type, allowed values, default, transform and two-way binding, outputs with payload type, templates with their context type, methods, forms support and pass-through keys.
1825
+ <div class="main">
1826
+ <div class="content"></div>
1827
+ <div class="sidebar"></div>
1828
+ </div>
1232
1829
 
1233
- ```typescript
1234
- {
1235
- "schemaVersion": 1,
1236
- "entryPoints": [
1237
- {
1238
- "name": "button",
1239
- "import": "@exhaustive-ui/core/button",
1240
- "modules": ["ButtonModule"],
1241
- "declarations": [
1242
- {
1243
- "kind": "component",
1244
- "className": "Button",
1245
- "selector": "p-button",
1246
- "inputs": [
1247
- { "name": "severity", "type": "ButtonSeverity", "values": ["success", "info", "warn", "danger", "secondary", "contrast", "help", "primary"] },
1248
- { "name": "raised", "type": "boolean", "default": "false", "transform": "booleanAttribute" }
1249
- ],
1250
- "outputs": [{ "name": "onClick", "payload": "MouseEvent" }],
1251
- "templates": [{ "name": "icon", "context": "ButtonIconTemplateContext" }]
1252
- }
1253
- ]
1254
- }
1255
- ]
1256
- }
1830
+ <div class="footer"></div>
1257
1831
  ```
1258
1832
 
1259
- ## Markdownextension
1833
+ Same layout can be achieved using the semantic elements with screen reader support built-in.
1260
1834
 
1261
- Add a .md to a page's URL to display a Markdown version of that page.
1835
+ ```html
1836
+ <header>
1837
+ <h1>Header</h1>
1838
+ </header>
1262
1839
 
1263
- ## Mcp
1840
+ <nav></nav>
1264
1841
 
1265
- @exhaustive-ui/mcp is a Model Context Protocol server that gives coding agents such as Claude Code, Cursor, Claude Desktop, VS Code Copilot and Codex tools to query this documentation instead of guessing from PrimeNG memory: list and search components, read a component's docs and API, fetch a complete code example, read the setup guides, and validate an Angular template against the compiled API (unknown inputs or outputs, invalid literal values, unsupported two-way bindings, deprecated inputs, PrimeNG imports and selectors). The server reads the files described on this page from the live site, so it always reflects the deployed documentation without reinstalling the package, and keeps them in memory for 15 minutes. A snapshot of the same files is bundled in the package and used when the network is unavailable. Register it with Claude Code: Or add it to the MCP configuration of your client ( .cursor/mcp.json , claude_desktop_config.json , .vscode/mcp.json with a servers key, ...): The server exposes the list , search , get_component , get_guide , get_example , get_setup , validate_usage and version tools, the Markdown files of this page as MCP resources, and prompts for the usual tasks (use a component, build a form, theme a component, migrate from PrimeNG, audit usage). Set EXHAUSTIVE_UI_DOCS_URL to read another deployment of the docs, for instance a local ng serve , and EXHAUSTIVE_UI_MCP_OFFLINE=1 to only use the bundled snapshot. The package README lists every option.
1842
+ <main>
1843
+ <article></article>
1844
+ <aside></aside>
1845
+ </main>
1266
1846
 
1267
- ---
1847
+ <footer></footer>
1848
+ ```
1268
1849
 
1269
- # Accessibility
1850
+ ## Waiaria
1270
1851
 
1271
- ExhaustiveUI has WCAG 2.1 AA level compliance.
1852
+ ARIA refers to "Accessible Rich Internet Applications" is a suite to fill the gap where semantic HTML is inadequate. These cases are mainly related to rich UI components/widgets. Although browser support for rich UI components such as
1853
+ a datepicker or colorpicker has been improved over the past years many web developers still utilize UI components derived from standard HTML elements created by them or by other projects like ExhaustiveUI. These types of components
1854
+ must provide keyboard and screen reader support, the latter case is where the WAI-ARIA is utilized.
1272
1855
 
1273
- ## Colors
1856
+ ARIA consists of roles, properties and attributes. **Roles** define what the element is mainly used for e.g. `checkbox`, `dialog`, `tablist` whereas **States** and **Properties** define the metadata of the
1857
+ element like `aria-checked`, `aria-disabled`.
1274
1858
 
1275
- Colors on a web page should aim a contrast ratio of at least 4.5:1 and consider a selection of colors that do not cause vibration. Good Contrast Color contrast between the background and the foreground content should be sufficient enough to ensure readability. Example below displays two cases with good and bad samples. GOOD BAD Vibration Color vibration is leads to an illusion of motion due to choosing colors that have low visibility against each other. Color combinations need to be picked with caution to avoid vibration. VIBRATE Dark Mode Highly saturated colors should be avoided when used within a dark design scheme as they cause eye strain. Instead desaturated colors should be preferred. Indigo 500 Indigo 200
1859
+ Consider the following case of a native checkbox. It has built-in keyboard and screen reader support.
1276
1860
 
1277
- ## Formcontrols
1861
+ ```html
1862
+ <input type="checkbox" value="Prime" name="ui" checked/>
1863
+ ```
1278
1864
 
1279
- Native form elements should be preferred instead of elements that are meant for other purposes like presentation. As an example, button below is rendered as a form control by the browser, can receive focus via tabbing and can be used with space key as well to trigger. On the other hand, a fancy css based button using a div has no keyboard or screen reader support. tabindex is required to make a div element accessible in addition to use a keydown to bring the keyboard support back. To avoid the overload and implementing functionality that is already provided by the browser, native form controls should be preferred. Relations Form components must be related to another element that describes what the form element is used for. This is usually achieved with the label element.
1865
+ A fancy checkbox with css animations might look more appealing but accessibility might be lacking. Checkbox below may display a checked font icon with animations however it is not tabbable, cannot be checked with space key and cannot
1866
+ be read by a reader.
1280
1867
 
1281
- ## Introduction
1868
+ ```html
1869
+ <div class="fancy-checkbox">
1870
+ <i *ngIf="checked" class="checked-icon"></i>
1871
+ </div>
1872
+ ```
1282
1873
 
1283
- According to the World Health Organization, 15% of the world population has a disability to some degree. As a result, accessibility features in any context such as a ramp for wheelchair users or a multimedia with captions are crucial to ensure content can be consumed by anyone. Disabilities Types of disabilities are diverse so you need to know your audience well and how they interact with the content created. There four main categories; Visual Impairments Blindness, low-level vision or color blindness are the common types of visual impairments. Screen magnifiers and the color blind mode are usually built-in features of the browsers whereas for people who rely on screen readers, page developers are required to make sure content is readable by the readers. Popular readers are NVDA , JAWS and ChromeVox . Hearing Impairments Deafness or hearing loss refers to the inability to hear sounds totally or partially. People with hearing impairments use assistive devices however it may not be enough when interacting with a web page. Common implementation is providing textual alternatives, transcripts and captions for content with audio. Mobility Impairments People with mobility impairments have disabilities related to movement due to loss of a limb, paralysis or other varying reasons. Assistive technologies like a head pointer is a device to interact with a screen whereas keyboard or a trackpad remain as solutions for people who are not able to utilize a mouse. Cognitive Impairments Cognitive impairments have a wider range that includes people with learning disabilities, depression and dyslexia. A well designed content also leads to better user experience for people without disabilities so designing for cognitive impairments result in better design for any user.
1874
+ One alternative is using ARIA roles for readers and use javascript for keyboard support. Notice the usage of
1875
+ `aria-labelledby` as a replacement of the `label` tag with for.
1284
1876
 
1285
- ## Semantichtml
1877
+ ```html
1878
+ <span id="chk-label">Remember Me></span>
1879
+ <div class="fancy-checkbox" role="checkbox" aria-checked="false" tabindex="0" aria-labelledby="chk-label" (click)="toggle()" (keydown)="onKeyDown($event)">
1880
+ <i *ngIf="checked" class="checked-icon"></i>
1881
+ </div>
1882
+ ```
1286
1883
 
1287
- HTML offers various element to organize content on a web page that screen readers are aware of. Preferring Semantic HTML for good semantics provide out of the box support for reader which is not possible when regular div elements with classes are used. Consider the following example that do not mean too much for readers. Same layout can be achieved using the semantic elements with screen reader support built-in.
1884
+ However the best practice is combining semantic HTML for accessibility while keeping the design for UX. This approach involves hiding a native checkbox for accessibility and using javascript events to update its state. Notice the
1885
+ usage of
1886
+ `p-hidden-accessible`
1887
+ that hides the elements from the user but not from the screen reader.
1288
1888
 
1289
- ## Waiaria
1889
+ ```html
1890
+ <label for="chkbox">Remember Me></label>
1891
+ <div class="fancy-checkbox" (click)="toggle()">
1892
+ <input class="p-hidden-accessible" type="checkbox" id="chkbox" (focus)="updateParentVisuals()" (blur)="updateParentVisuals()" (keydown)="$event.keyCode === 32 && updateParentVisuals()">
1893
+ <i *ngIf="checked" class="checked-icon"></i>
1894
+ </div>
1895
+ ```
1896
+
1897
+ A working sample is the ExhaustiveUI checkbox that is tabbable, keyboard accessible and is compliant with a screen reader. Instead of ARIA roles it relies on a hidden native checkbox.
1290
1898
 
1291
- ARIA refers to "Accessible Rich Internet Applications" is a suite to fill the gap where semantic HTML is inadequate. These cases are mainly related to rich UI components/widgets. Although browser support for rich UI components such as a datepicker or colorpicker has been improved over the past years many web developers still utilize UI components derived from standard HTML elements created by them or by other projects like ExhaustiveUI. These types of components must provide keyboard and screen reader support, the latter case is where the WAI-ARIA is utilized. ARIA consists of roles, properties and attributes. Roles define what the element is mainly used for e.g. checkbox , dialog , tablist whereas States and Properties define the metadata of the element like aria-checked , aria-disabled . Consider the following case of a native checkbox. It has built-in keyboard and screen reader support. A fancy checkbox with css animations might look more appealing but accessibility might be lacking. Checkbox below may display a checked font icon with animations however it is not tabbable, cannot be checked with space key and cannot be read by a reader. One alternative is using ARIA roles for readers and use javascript for keyboard support. Notice the usage of aria-labelledby as a replacement of the label tag with for. However the best practice is combining semantic HTML for accessibility while keeping the design for UX. This approach involves hiding a native checkbox for accessibility and using javascript events to update its state. Notice the usage of p-hidden-accessible that hides the elements from the user but not from the screen reader. A working sample is the ExhaustiveUI checkbox that is tabbable, keyboard accessible and is compliant with a screen reader. Instead of ARIA roles it relies on a hidden native checkbox. Remember Me
1899
+ Remember Me
1292
1900
 
1293
1901
  ## Wcag
1294
1902
 
1295
- WCAG refers to Web Content Accessibility Guideline , a standard managed by the WAI (Web Accessibility Initiative) of W3C (World Wide Web Consortium). WCAG consists of recommendations for making the web content more accessible. ExhaustiveUI components aim high level of WCAG compliancy in the near future. Various countries around the globe have governmental policies regarding web accessibility as well. Most well known of these are Section 508 in the US and Web Accessibility Directive of the European Union.
1903
+ [WCAG](https://www.w3.org/WAI/standards-guidelines/wcag/) refers to **Web Content Accessibility Guideline**, a standard managed by the WAI (Web Accessibility Initiative) of W3C (World Wide
1904
+ Web Consortium). WCAG consists of recommendations for making the web content more accessible. ExhaustiveUI components aim high level of WCAG compliancy in the near future.
1905
+
1906
+ Various countries around the globe have governmental policies regarding web accessibility as well. Most well known of these are [Section 508](https://www.section508.gov/manage/laws-and-policies/) in the US and
1907
+ [Web Accessibility Directive](https://digital-strategy.ec.europa.eu/en/policies/web-accessibility) of the European Union.
1296
1908
 
1297
1909
  ---
1298
1910
 
@@ -1302,15 +1914,39 @@ Built-in CSS animations for ExhaustiveUI components.
1302
1914
 
1303
1915
  ## Anchoredoverlays
1304
1916
 
1305
- Anchored overlays are the components that have a floating ui positioned relatively to another element such as Select, Popover. The enter and leave animations are defined with the .p-anchored-overlay-enter-active and .p-anchored-overlay-leave-active classes.
1917
+ Anchored overlays are the components that have a floating ui positioned relatively to another element such as Select, Popover. The enter and leave animations are defined with the `.p-anchored-overlay-enter-active` and
1918
+ `.p-anchored-overlay-leave-active`
1919
+ classes.
1306
1920
 
1307
1921
  ## Collapsibles
1308
1922
 
1309
- Collapsible components have a content that is toggleable including Accordion, Panel, Fieldset, Stepper and PanelMenu. The enter and leave animations are defined with the .p-collapsible-enter-active and .p-collapsible-leave-active classes. Header I Lorem ipsum dolor sit amet, consectetur adipiscing elit, sed do eiusmod tempor incididunt ut labore et dolore magna aliqua. Ut enim ad minim veniam, quis nostrud exercitation ullamco laboris nisi ut aliquip ex ea commodo consequat. Duis aute irure dolor in reprehenderit in voluptate velit esse cillum dolore eu fugiat nulla pariatur. Excepteur sint occaecat cupidatat non proident, sunt in culpa qui officia deserunt mollit anim id est laborum. Header II Sed ut perspiciatis unde omnis iste natus error sit voluptatem accusantium doloremque laudantium, totam rem aperiam, eaque ipsa quae ab illo inventore veritatis et quasi architecto beatae vitae dicta sunt explicabo. Nemo enim ipsam voluptatem quia voluptas sit aspernatur aut odit aut fugit, sed quia consequuntur magni dolores eos qui ratione voluptatem sequi nesciunt. Consectetur, adipisci velit, sed quia non numquam eius modi. Header III Sed ut perspiciatis unde omnis iste natus error sit voluptatem accusantium doloremque laudantium, totam rem aperiam, eaque ipsa quae ab illo inventore veritatis et quasi architecto beatae vitae dicta sunt explicabo. Nemo enim ipsam voluptatem quia voluptas sit aspernatur aut odit aut fugit, sed quia consequuntur magni dolores eos qui ratione voluptatem sequi nesciunt. Consectetur, adipisci velit, sed quia non numquam eius modi.
1923
+ Collapsible components have a content that is toggleable including Accordion, Panel, Fieldset, Stepper and PanelMenu. The enter and leave animations are defined with the `.p-collapsible-enter-active` and
1924
+ `.p-collapsible-leave-active`
1925
+ classes.
1926
+
1927
+ Header I
1928
+
1929
+ Lorem ipsum dolor sit amet, consectetur adipiscing elit, sed do eiusmod tempor incididunt ut labore et dolore magna aliqua. Ut enim ad minim veniam, quis nostrud exercitation ullamco laboris nisi ut aliquip ex ea
1930
+ commodo consequat. Duis aute irure dolor in reprehenderit in voluptate velit esse cillum dolore eu fugiat nulla pariatur. Excepteur sint occaecat cupidatat non proident, sunt in culpa qui officia deserunt mollit anim
1931
+ id est laborum.
1932
+
1933
+ Header II
1934
+
1935
+ Sed ut perspiciatis unde omnis iste natus error sit voluptatem accusantium doloremque laudantium, totam rem aperiam, eaque ipsa quae ab illo inventore veritatis et quasi architecto beatae vitae dicta sunt explicabo.
1936
+ Nemo enim ipsam voluptatem quia voluptas sit aspernatur aut odit aut fugit, sed quia consequuntur magni dolores eos qui ratione voluptatem sequi nesciunt. Consectetur, adipisci velit, sed quia non numquam eius modi.
1937
+
1938
+ Header III
1939
+
1940
+ Sed ut perspiciatis unde omnis iste natus error sit voluptatem accusantium doloremque laudantium, totam rem aperiam, eaque ipsa quae ab illo inventore veritatis et quasi architecto beatae vitae dicta sunt explicabo.
1941
+ Nemo enim ipsam voluptatem quia voluptas sit aspernatur aut odit aut fugit, sed quia consequuntur magni dolores eos qui ratione voluptatem sequi nesciunt. Consectetur, adipisci velit, sed quia non numquam eius modi.
1310
1942
 
1311
1943
  ## Dialog
1312
1944
 
1313
- Overlays such as Dialog and Drawer are positioned relative to the viewport and have their own animations. Update your information. Username Email
1945
+ Overlays such as Dialog and Drawer are positioned relative to the viewport and have their own animations.
1946
+
1947
+ Update your information.
1948
+ Username
1949
+ Email
1314
1950
 
1315
1951
  ## Disable
1316
1952
 
@@ -1318,11 +1954,92 @@ Individual animations can be reduced and even disabled completely using the anim
1318
1954
 
1319
1955
  ## Introduction
1320
1956
 
1321
- Various ExhaustiveUI Components utilize native CSS animations to provide an enhanced user experience. The default animations are based on the best practices recommended by the usability experts. In case you need to customize the default animations, this documentation covers the entire set of built-in animations. Animations are defined using a combination of style classes and keyframes. The ⁠ .{classname}-enter-active and ⁠ .{classname}-leave-active classes specify the animation name, duration, and easing function. You can customize animations globally by overriding the default animation classes, affecting all components. Alternatively, you can apply scoped classes to individual components to modify their animations independently. For demo purposes, this second approach is used throughout the next sections.
1957
+ Various ExhaustiveUI Components utilize native CSS animations to provide an enhanced user experience. The default animations are based on the best practices recommended by the usability experts. In case you need to customize the
1958
+ default animations, this documentation covers the entire set of built-in animations.
1959
+
1960
+ Animations are defined using a combination of style classes and keyframes. The ⁠`.{classname}-enter-active` and ⁠`.{classname}-leave-active` classes specify the animation name, duration, and easing
1961
+ function. You can customize animations globally by overriding the default animation classes, affecting all components. Alternatively, you can apply scoped classes to individual components to modify their animations independently. For
1962
+ demo purposes, this second approach is used throughout the next sections.
1322
1963
 
1323
1964
  ## Reference
1324
1965
 
1325
- List of class names of the CSS animations used by the components. Component Enter Class Leave Class Accordion .p-collapsible-enter-active .p-collapsible-leave-active AutoComplete .p-anchored-overlay-enter-active .p-anchored-overlay-leave-active CascadeSelect .p-anchored-overlay-enter-active .p-anchored-overlay-leave-active ColorPicker .p-anchored-overlay-enter-active .p-anchored-overlay-leave-active ConfirmPopup .p-anchored-overlay-enter-active .p-anchored-overlay-leave-active ContextMenu .p-anchored-overlay-enter-active .p-anchored-overlay-leave-active DatePicker .p-anchored-overlay-enter-active .p-anchored-overlay-leave-active Dialog .p-dialog-enter-active .p-dialog-leave-active Drawer .p-drawer-enter-active .p-drawer-leave-active Fieldset .p-collapsible-enter-active .p-collapsible-leave-active Galleria .p-galleria-enter-active .p-galleria-leave-active Image .p-image-original-enter-active .p-image-original-leave-active Menu .p-anchored-overlay-enter-active .p-anchored-overlay-leave-active Message .p-message-enter-active .p-message-leave-active Modal Masks .p-overlay-mask-enter-active .p-overlay-mask-leave-active MultiSelect .p-anchored-overlay-enter-active .p-anchored-overlay-leave-active Panel .p-collapsible-enter-active .p-collapsible-leave-active PanelMenu .p-collapsible-enter-active .p-collapsible-leave-active Password .p-anchored-overlay-enter-active .p-anchored-overlay-leave-active Select .p-anchored-overlay-enter-active .p-anchored-overlay-leave-active Stepper .p-collapsible-enter-active .p-collapsible-leave-active TieredMenu .p-anchored-overlay-enter-active .p-anchored-overlay-leave-active Toast .p-toast-message-enter-active .p-toast-message-leave-active TreeSelect .p-anchored-overlay-enter-active .p-anchored-overlay-leave-active
1966
+ List of class names of the CSS animations used by the components.
1967
+
1968
+ Component
1969
+ Enter Class
1970
+ Leave Class
1971
+ `Accordion`
1972
+ .p-collapsible-enter-active
1973
+ .p-collapsible-leave-active
1974
+ `AutoComplete`
1975
+ .p-anchored-overlay-enter-active
1976
+ .p-anchored-overlay-leave-active
1977
+ `CascadeSelect`
1978
+ .p-anchored-overlay-enter-active
1979
+ .p-anchored-overlay-leave-active
1980
+ `ColorPicker`
1981
+ .p-anchored-overlay-enter-active
1982
+ .p-anchored-overlay-leave-active
1983
+ `ConfirmPopup`
1984
+ .p-anchored-overlay-enter-active
1985
+ .p-anchored-overlay-leave-active
1986
+ `ContextMenu`
1987
+ .p-anchored-overlay-enter-active
1988
+ .p-anchored-overlay-leave-active
1989
+ `DatePicker`
1990
+ .p-anchored-overlay-enter-active
1991
+ .p-anchored-overlay-leave-active
1992
+ `Dialog`
1993
+ .p-dialog-enter-active
1994
+ .p-dialog-leave-active
1995
+ `Drawer`
1996
+ .p-drawer-enter-active
1997
+ .p-drawer-leave-active
1998
+ `Fieldset`
1999
+ .p-collapsible-enter-active
2000
+ .p-collapsible-leave-active
2001
+ `Galleria`
2002
+ .p-galleria-enter-active
2003
+ .p-galleria-leave-active
2004
+ `Image`
2005
+ .p-image-original-enter-active
2006
+ .p-image-original-leave-active
2007
+ `Menu`
2008
+ .p-anchored-overlay-enter-active
2009
+ .p-anchored-overlay-leave-active
2010
+ `Message`
2011
+ .p-message-enter-active
2012
+ .p-message-leave-active
2013
+ `Modal Masks`
2014
+ .p-overlay-mask-enter-active
2015
+ .p-overlay-mask-leave-active
2016
+ `MultiSelect`
2017
+ .p-anchored-overlay-enter-active
2018
+ .p-anchored-overlay-leave-active
2019
+ `Panel`
2020
+ .p-collapsible-enter-active
2021
+ .p-collapsible-leave-active
2022
+ `PanelMenu`
2023
+ .p-collapsible-enter-active
2024
+ .p-collapsible-leave-active
2025
+ `Password`
2026
+ .p-anchored-overlay-enter-active
2027
+ .p-anchored-overlay-leave-active
2028
+ `Select`
2029
+ .p-anchored-overlay-enter-active
2030
+ .p-anchored-overlay-leave-active
2031
+ `Stepper`
2032
+ .p-collapsible-enter-active
2033
+ .p-collapsible-leave-active
2034
+ `TieredMenu`
2035
+ .p-anchored-overlay-enter-active
2036
+ .p-anchored-overlay-leave-active
2037
+ `Toast`
2038
+ .p-toast-message-enter-active
2039
+ .p-toast-message-leave-active
2040
+ `TreeSelect`
2041
+ .p-anchored-overlay-enter-active
2042
+ .p-anchored-overlay-leave-active
1326
2043
 
1327
2044
  ---
1328
2045
 
@@ -1332,7 +2049,10 @@ Right-to-left support for ExhaustiveUI components.
1332
2049
 
1333
2050
  ## Configuration
1334
2051
 
1335
- The ExhaustiveUI components natively support Right-to-Left (RTL) text direction through a modern CSS implementation utilizing FlexBox and classes like *-inline-start and *-block-end . Consequently, no JavaScript configuration is necessary; setting the document's text direction to RTL is sufficient to enable this feature. The RTL setting can either be set using the dir attribute or with the direction style property.
2052
+ The ExhaustiveUI components natively support Right-to-Left (RTL) text direction through a modern CSS implementation utilizing FlexBox and classes like `*-inline-start` and `*-block-end`. Consequently, no JavaScript
2053
+ configuration is necessary; setting the document's text direction to RTL is sufficient to enable this feature.
2054
+
2055
+ The RTL setting can either be set using the `dir` attribute or with the `direction` style property.
1336
2056
 
1337
2057
  ## Limitations
1338
2058
 
@@ -1346,19 +2066,56 @@ Moving from PrimeFlex to Tailwind CSS.
1346
2066
 
1347
2067
  ## Compatibility
1348
2068
 
1349
- If you are staying on PrimeFlex for now, ExhaustiveUI pairs with PrimeFlex v4 — the same combination that worked with PrimeNG v18 and newer, since the styling architecture is unchanged. PrimeFlex v3 targeted the older PrimeNG releases and is not a supported pairing here. Neither version is tested against ExhaustiveUI releases, so treat this as "should work", not as a supported configuration. The migration below is the path we actually maintain.
2069
+ If you are staying on PrimeFlex for now, ExhaustiveUI pairs with PrimeFlex v4 — the same combination that worked with PrimeNG v18 and newer, since the styling architecture is unchanged. PrimeFlex v3 targeted the older PrimeNG releases
2070
+ and is not a supported pairing here.
2071
+
2072
+ Neither version is tested against ExhaustiveUI releases, so treat this as "should work", not as a supported configuration. The migration below is the path we actually maintain.
1350
2073
 
1351
2074
  ## Migration
1352
2075
 
1353
- PrimeFlex class names map closely onto Tailwind's, so most of the work is mechanical. PrimeTek's primeclt ships a pf2tw command that does the conversion, and it works on any codebase — it rewrites class names and does not care which component library you use. Run pf2tw in a directory containing the files to convert. pf2tw was written for Tailwind v3. Tailwind v4 renamed a few of the utilities it produces, for example shadow-sm to shadow-xs , rounded to rounded-sm and flex-grow to grow . On Tailwind v4, check the converted classes against the renamed utilities list of the Tailwind upgrade guide. A handful of PrimeFlex classes have no Tailwind counterpart and are left alone. Replace them with flexbox or grid utilities by hand: formgrid formgroup formgroup-inline col col-fixed field field-checkbox field-radiobutton reset
2076
+ PrimeFlex class names map closely onto Tailwind's, so most of the work is mechanical. PrimeTek's
2077
+ [primeclt](https://www.npmjs.com/package/primeclt) ships a `pf2tw` command that does the conversion, and it works on any codebase — it rewrites class names and does not care
2078
+ which component library you use.
2079
+
2080
+ ```bash
2081
+ npm install -g primeclt
2082
+ ```
2083
+
2084
+ Run `pf2tw` in a directory containing the files to convert.
2085
+
2086
+ ```bash
2087
+ prime pf2tw
2088
+ ```
2089
+
2090
+ `pf2tw` was written for Tailwind v3. Tailwind v4 renamed a few of the utilities it produces, for example `shadow-sm` to `shadow-xs`, `rounded` to `rounded-sm` and `flex-grow` to `grow`. On Tailwind
2091
+ v4, check the converted classes against the [renamed utilities](https://tailwindcss.com/docs/upgrade-guide#renamed-utilities) list of the Tailwind upgrade guide.
2092
+
2093
+ A handful of PrimeFlex classes have no Tailwind counterpart and are left alone. Replace them with flexbox or grid utilities by hand:
2094
+
2095
+ - formgrid
2096
+ - formgroup
2097
+ - formgroup-inline
2098
+ - col
2099
+ - col-fixed
2100
+ - field
2101
+ - field-checkbox
2102
+ - field-radiobutton
2103
+ - reset
1354
2104
 
1355
2105
  ## Overview
1356
2106
 
1357
- PrimeFlex was PrimeTek's lightweight CSS utility library, designed to accompany PrimeNG. PrimeTek stopped maintaining it before the relicensing, on the grounds that most applications already bring their own utility layer — Tailwind, Bootstrap or something in-house — and a second one only overlaps with it. ExhaustiveUI does not maintain PrimeFlex either, and for the same reason. Nothing in this library depends on it, and no component requires it. If your application already uses PrimeFlex it will keep working, but it will not receive updates from us, and we suggest moving to Tailwind CSS.
2107
+ [PrimeFlex](https://primeflex.org) was PrimeTek's lightweight CSS utility library, designed to accompany PrimeNG. PrimeTek stopped maintaining it before the relicensing, on the
2108
+ grounds that most applications already bring their own utility layer — Tailwind, Bootstrap or something in-house — and a second one only overlaps with it.
2109
+
2110
+ ExhaustiveUI does not maintain PrimeFlex either, and for the same reason. Nothing in this library depends on it, and no component requires it. If your application already uses PrimeFlex it will keep working, but it will not receive
2111
+ updates from us, and we suggest moving to Tailwind CSS.
1358
2112
 
1359
2113
  ## Tailwindcss
1360
2114
 
1361
- Tailwind CSS is the replacement we suggest. This documentation site is itself built with it, and we publish @exhaustive-ui/tailwindcss for first-class integration — a plugin that teaches Tailwind about the theme's design tokens and puts the component styles in a cascade layer you can override cleanly. See the Tailwind CSS guide for setup with either Tailwind v3 or v4, and the next section for converting existing PrimeFlex classes.
2115
+ Tailwind CSS is the replacement we suggest. This documentation site is itself built with it, and we publish `@exhaustive-ui/tailwindcss` for first-class integration — a plugin that teaches Tailwind about the theme's design
2116
+ tokens and puts the component styles in a cascade layer you can override cleanly.
2117
+
2118
+ See the [Tailwind CSS guide](https://exhaustive-ui.com/tailwind) for setup with either Tailwind v3 or v4, and the next section for converting existing PrimeFlex classes.
1362
2119
 
1363
2120
  ---
1364
2121
 
@@ -1366,29 +2123,98 @@ Tailwind CSS is the replacement we suggest. This documentation site is itself bu
1366
2123
 
1367
2124
  Why ExhaustiveUI exists, what it commits to, and where it stops.
1368
2125
 
1369
- ## Governance
2126
+ ## Why This Fork Exists
2127
+
2128
+ In June 2026 PrimeTek archived the PrimeNG repository and moved future major versions, starting with v22, to a commercial license. They explained their reasoning in
2129
+ [their own announcement](https://primeui.dev/nextchapter), and it is worth reading. Maintaining a component library of this size for a decade, largely for free, is genuinely hard,
2130
+ and we do not think the decision was made lightly.
2131
+
2132
+ It did, however, leave a lot of applications on a library with no further open source releases. ExhaustiveUI exists for those applications. It is a community fork of the last MIT licensed version of PrimeNG, v21, and it stays MIT.
2133
+
2134
+ This is not an official fork and it is not endorsed by PrimeTek. It is a separate repository, seeded with PrimeNG's code and history, maintained by people who depend on it.
2135
+
2136
+ ## What We Commit To
2137
+
2138
+ Four commitments, in the order we would want to read them if we were choosing a dependency:
2139
+
2140
+ ### MIT, with no second tier
2141
+
2142
+ Every package we publish is MIT licensed. There is no paid edition, no enterprise build, no feature held back behind a subscription, and no plan to introduce one. If that ever changed, it would be a fork of this project rather than a
2143
+ relicensing of it, because the code we inherited is MIT and so is everything we add to it.
2144
+
2145
+ ### We track Angular
2146
+
2147
+ Our release cadence follows Angular's. When a new Angular major lands, the priority is a compatible ExhaustiveUI major — before new features, before refactors. Staying upgradeable is the single most valuable thing a component library
2148
+ can do for the applications built on it.
2149
+
2150
+ ### Bugs before features
2151
+
2152
+ We inherited a large backlog along with the code. Fixing what is broken ranks above adding what is missing. Feature requests are triaged and welcome, but they generally ship when someone in the community implements them.
2153
+
2154
+ ### No surprises in your bundle
2155
+
2156
+ The library sends no telemetry, phones no home, and requires no account or key to use. What you install is what runs.
2157
+
2158
+ ## What We Do Not Do
2159
+
2160
+ Naming the limits is what makes the commitments above worth anything. Here is what ExhaustiveUI is not.
2161
+
2162
+ ### There is no commercial support
2163
+
2164
+ No SLA, no support contract, no guaranteed response time. Issues and discussions are answered by volunteers when they have time. If your organisation needs contractual guarantees, this project cannot provide them and you should plan
2165
+ accordingly.
2166
+
2167
+ ### There are no premium templates, blocks or design tooling
2168
+
2169
+ PrimeTek's application templates, block library and visual theme designer are their commercial products. They are not part of what was MIT licensed, so they are not part of this fork and will not be reimplemented. Theming here means
2170
+ editing preset objects in code, which is documented in full.
2171
+
2172
+ ### We are not chasing feature parity with PrimeNG v22 and beyond
2173
+
2174
+ PrimeNG continues under its own license and its own roadmap. ExhaustiveUI diverges from v21 forward. Some things they add, we will not have. Some things we fix, they will not. Treat the two as separate libraries that share an
2175
+ ancestor, not as a free copy of a paid product.
1370
2176
 
1371
- Everything happens in the open, in the repository . There is no private roadmap and no internal issue tracker. What you see in the issues, the discussions and the roadmap is the whole plan. Contributors earn commit access by contributing — the contribution guide describes the Contributor and Committer roles and roughly what it takes to reach them. We would rather grow the number of people who can merge a fix than route everything through one person. Breaking changes are avoided within a major and documented when a major requires them. Where we inherited a name that no longer fits — the CSS cascade layer, the package scope, the icon library — we changed it once, at v1, with a migration schematic, rather than dripping renames across releases.
2177
+ ### The bus factor is real
1372
2178
 
1373
- ## Limits
2179
+ This is maintained by a small group of people in their own time. We would rather say that plainly than imply a larger organisation stands behind it. The best way to change that number is to
2180
+ [contribute](https://github.com/e-xiste/exhaustive-ui).
1374
2181
 
1375
- Naming the limits is what makes the commitments above worth anything. Here is what ExhaustiveUI is not. There is no commercial support No SLA, no support contract, no guaranteed response time. Issues and discussions are answered by volunteers when they have time. If your organisation needs contractual guarantees, this project cannot provide them and you should plan accordingly. There are no premium templates, blocks or design tooling PrimeTek's application templates, block library and visual theme designer are their commercial products. They are not part of what was MIT licensed, so they are not part of this fork and will not be reimplemented. Theming here means editing preset objects in code, which is documented in full. We are not chasing feature parity with PrimeNG v22 and beyond PrimeNG continues under its own license and its own roadmap. ExhaustiveUI diverges from v21 forward. Some things they add, we will not have. Some things we fix, they will not. Treat the two as separate libraries that share an ancestor, not as a free copy of a paid product. The bus factor is real This is maintained by a small group of people in their own time. We would rather say that plainly than imply a larger organisation stands behind it. The best way to change that number is to contribute .
2182
+ ## How Decisions Are Made
1376
2183
 
1377
- ## Origin
2184
+ Everything happens in the open, in the [repository](https://github.com/e-xiste/exhaustive-ui). There is no private roadmap and no internal issue tracker. What you see in the issues,
2185
+ the discussions and the [roadmap](https://exhaustive-ui.com/roadmap) is the whole plan.
1378
2186
 
1379
- In June 2026 PrimeTek archived the PrimeNG repository and moved future major versions, starting with v22, to a commercial license. They explained their reasoning in their own announcement , and it is worth reading. Maintaining a component library of this size for a decade, largely for free, is genuinely hard, and we do not think the decision was made lightly. It did, however, leave a lot of applications on a library with no further open source releases. ExhaustiveUI exists for those applications. It is a community fork of the last MIT licensed version of PrimeNG, v21, and it stays MIT. This is not an official fork and it is not endorsed by PrimeTek. It is a separate repository, seeded with PrimeNG's code and history, maintained by people who depend on it.
2187
+ Contributors earn commit access by contributing — the [contribution guide](https://exhaustive-ui.com/contribution) describes the Contributor and Committer roles and roughly what it takes to reach them. We would rather
2188
+ grow the number of people who can merge a fix than route everything through one person.
1380
2189
 
1381
- ## Promises
2190
+ Breaking changes are avoided within a major and documented when a major requires them. Where we inherited a name that no longer fits — the CSS cascade layer, the package scope, the icon library — we changed it once, at v1, with a
2191
+ migration schematic, rather than dripping renames across releases.
1382
2192
 
1383
- Four commitments, in the order we would want to read them if we were choosing a dependency: MIT, with no second tier Every package we publish is MIT licensed. There is no paid edition, no enterprise build, no feature held back behind a subscription, and no plan to introduce one. If that ever changed, it would be a fork of this project rather than a relicensing of it, because the code we inherited is MIT and so is everything we add to it. We track Angular Our release cadence follows Angular's. When a new Angular major lands, the priority is a compatible ExhaustiveUI major — before new features, before refactors. Staying upgradeable is the single most valuable thing a component library can do for the applications built on it. Bugs before features We inherited a large backlog along with the code. Fixing what is broken ranks above adding what is missing. Feature requests are triaged and welcome, but they generally ship when someone in the community implements them. No surprises in your bundle The library sends no telemetry, phones no home, and requires no account or key to use. What you install is what runs.
2193
+ ## PrimeNG and PrimeTek
2194
+
2195
+ ExhaustiveUI is not affiliated with, endorsed by, or sponsored by PrimeTek. PrimeNG, PrimeFaces, PrimeReact, PrimeVue and PrimeFlex are their trademarks. The rename from the inherited names — the packages, the CSS layer, the icon
2196
+ library — is a trademark matter, not a technical one, and it is why we ship a [migration schematic](https://v1.optimus.openng.org/migration/primeng) rather than
2197
+ asking you to rewrite imports by hand.
2198
+
2199
+ References to PrimeNG remain throughout this documentation and the source, and they are deliberate. Attribution is the point: this library is PrimeTek's decade of work plus whatever the community adds on top. Pretending otherwise
2200
+ would be both dishonest and useless to anyone trying to find their way around a familiar API.
2201
+
2202
+ The code we forked was published under the MIT license, and we distribute it under those same terms, with the original copyright notices intact.
1384
2203
 
1385
2204
  ## Sustainability
1386
2205
 
1387
- The honest answer to "how is this funded" is: it mostly is not. e-xiste covers the hosting and the domain; the work is volunteered. That is a fragile arrangement, and it is the main risk to this project — larger than any technical risk we can see today. The things that actually help, roughly in order of impact: Reproducing and triaging issues. A bug with a minimal reproduction is several times more likely to get fixed. Sending pull requests, especially for issues labelled help-needed . Answering questions in discussions, so the same answer is not written five times. Improving this documentation. Every page has a source file and every fix is welcome. Telling your employer you depend on it. Sponsored maintenance time is worth more than any one-off donation. The contribution guide covers how to get started.
2206
+ The honest answer to "how is this funded" is: it mostly is not. e-xiste covers the hosting and the domain; the work is volunteered. That is a fragile arrangement, and it is the main risk to this project — larger than any technical
2207
+ risk we can see today.
2208
+
2209
+ The things that actually help, roughly in order of impact:
1388
2210
 
1389
- ## Trademark
2211
+ - Reproducing and triaging issues. A bug with a minimal reproduction is several times more likely to get fixed.
2212
+ - Sending pull requests, especially for issues labelled `help-needed`.
2213
+ - Answering questions in discussions, so the same answer is not written five times.
2214
+ - Improving this documentation. Every page has a source file and every fix is welcome.
2215
+ - Telling your employer you depend on it. Sponsored maintenance time is worth more than any one-off donation.
1390
2216
 
1391
- ExhaustiveUI is not affiliated with, endorsed by, or sponsored by PrimeTek. PrimeNG, PrimeFaces, PrimeReact, PrimeVue and PrimeFlex are their trademarks. The rename from the inherited names — the packages, the CSS layer, the icon library — is a trademark matter, not a technical one, and it is why we ship a migration schematic rather than asking you to rewrite imports by hand. References to PrimeNG remain throughout this documentation and the source, and they are deliberate. Attribution is the point: this library is PrimeTek's decade of work plus whatever the community adds on top. Pretending otherwise would be both dishonest and useless to anyone trying to find their way around a familiar API. The code we forked was published under the MIT license, and we distribute it under those same terms, with the original copyright notices intact.
2217
+ The [contribution guide](https://exhaustive-ui.com/contribution) covers how to get started.
1392
2218
 
1393
2219
  ---
1394
2220
 
@@ -1396,47 +2222,401 @@ ExhaustiveUI is not affiliated with, endorsed by, or sponsored by PrimeTek. Prim
1396
2222
 
1397
2223
  Licensing, migration from PrimeNG, the ecosystem, and how support works.
1398
2224
 
1399
- ## Ecosystem
2225
+ ## The Project
1400
2226
 
1401
- Do the PrimeNG themes work? The built-in presets do — Aura, Material, Lara and Nora ship in @exhaustive-ui/themes and are configured the same way. A preset you wrote yourself against PrimeNG v21 will work after the import paths are updated, which the migration schematic handles. What about the Theme Designer, templates and blocks? Those are PrimeTek's commercial products. They were never MIT licensed, so they are not part of this fork and we will not be reimplementing them. Theming in ExhaustiveUI means editing preset objects in code, which is documented in full under styled mode . What replaced PrimeIcons? OpenNG Icons , installed as @openng/icons . The pi pi-{icon} class names are unchanged, so templates do not need editing — only the package name and the stylesheet import, both of which the migration schematic rewrites. What about PrimeFlex? PrimeFlex is not maintained here. We suggest Tailwind CSS instead, and ship @exhaustive-ui/tailwindcss for first-class integration — see the Tailwind guide . The PrimeFlex guide covers moving across. Does ExhaustiveUI work with SSR? This documentation site is itself an Angular SSR application built on ExhaustiveUI, prerendered at build time. So yes, and any regression there tends to be noticed quickly.
2227
+ ### Is ExhaustiveUI free? Will it stay free?
1402
2228
 
1403
- ## Migration
2229
+ Yes, and yes. Every package is MIT licensed, and the code we forked was MIT too, so relicensing it is not something we could do even if we wanted to. There is no paid tier and none is planned. The
2230
+ [philosophy page](https://exhaustive-ui.com/philosophy) goes into what that does and does not buy you.
2231
+
2232
+ ### Is this an official PrimeNG fork? Are you affiliated with PrimeTek?
2233
+
2234
+ No. ExhaustiveUI is an independent community fork, not affiliated with, endorsed by, or sponsored by PrimeTek. It is a fork of
2235
+ [Optimus UI](https://github.com/openng-org/optimus-ui) (OpenNG), itself a repository seeded with PrimeNG's MIT licensed code and history, not a fork of the archived
2236
+ `primefaces/primeng` repository.
2237
+
2238
+ ### Which PrimeNG version is this forked from?
2239
+
2240
+ PrimeNG v21, the last version published under the MIT license, by way of Optimus UI v2. ExhaustiveUI v22 is that codebase, rebranded and migrated to the Angular Signals API, with the fixes that have landed since; its major version
2241
+ number follows Angular's.
2242
+
2243
+ ### Who maintains it, and how is it funded?
2244
+
2245
+ A small group of volunteers, with e-xiste covering hosting and the domain. We are deliberate about not implying more than that — see
2246
+ [sustainability](https://exhaustive-ui.com/philosophy) for the honest version and the ways that can change.
2247
+
2248
+ ### Why did the name change?
2249
+
2250
+ Trademark, twice over. PrimeNG, PrimeFaces and PrimeFlex are PrimeTek's marks, and Optimus UI is OpenNG's, so the packages and the CSS cascade layer needed a name of their own. That is also why the rename from PrimeNG is handled by a
2251
+ schematic rather than by asking you to rewrite imports by hand.
2252
+
2253
+ ## Compatibility & Migration
2254
+
2255
+ ### Which Angular versions are supported?
2256
+
2257
+ Angular v22: ExhaustiveUI v22 requires Angular v22. Our majors follow Angular's — when a new Angular major ships, a compatible ExhaustiveUI major is the first thing we work on. See the
2258
+ [version compatibility table](https://exhaustive-ui.com/migration/update) in the update guide.
2259
+
2260
+ ### How do I migrate from PrimeNG? Is it automatic?
2261
+
2262
+ Mostly, but not through `ng add`, which only sets up new projects and fails without changing anything when it finds an existing `primeng` dependency. Install `@exhaustive-ui/core`, then run
2263
+ `ng generate @exhaustive-ui/core:migrate-from-primeng` in a PrimeNG v21 workspace updated to Angular v22: packages swapped, imports rewritten, dependencies installed. It then prints a report of anything it could not rewrite,
2264
+ with file and line numbers. The [migration guide](https://v1.optimus.openng.org/migration/primeng) covers the details and the manual cases.
2265
+
2266
+ ### I am on PrimeNG v20 or older. Can I migrate directly?
2267
+
2268
+ No. Upgrade to PrimeNG v21 first, using PrimeNG's own migration guides, then update Angular to v22 and run the schematic. The schematic checks the version and refuses rather than producing a half-migrated workspace.
2269
+
2270
+ ### What happens to my PrimeNG license?
2271
+
2272
+ Nothing — it is unrelated. A PrimeNG v22 commercial license covers PrimeNG. ExhaustiveUI needs no license at all. If you hold a PrimeTek subscription for their templates or theme designer, those remain their products and do not carry
2273
+ over here.
2274
+
2275
+ ### I had an open PR on primefaces/primeng. Can I bring it here?
2276
+
2277
+ Yes, and we would like you to. Append `.patch` to your original pull request URL and apply it with `git am` — the contributing guide in the repository walks through it, including what to do when the patch no longer applies
2278
+ cleanly.
2279
+
2280
+ ### Can I run PrimeNG and ExhaustiveUI side by side?
2281
+
2282
+ Technically yes, since the package names and the CSS cascade layer differ, but you will ship two copies of the same components and two theme runtimes. Treat it as a temporary state during migration rather than a supported
2283
+ configuration.
2284
+
2285
+ ## Themes, Icons & Ecosystem
2286
+
2287
+ ### Do the PrimeNG themes work?
2288
+
2289
+ The built-in presets do — Aura, Material, Lara and Nora ship in `@exhaustive-ui/themes` and are configured the same way. A preset you wrote yourself against PrimeNG v21 will work after the import paths are updated, which the
2290
+ migration schematic handles.
2291
+
2292
+ ### What about the Theme Designer, templates and blocks?
2293
+
2294
+ Those are PrimeTek's commercial products. They were never MIT licensed, so they are not part of this fork and we will not be reimplementing them. Theming in ExhaustiveUI means editing preset objects in code, which is documented in
2295
+ full under [styled mode](https://exhaustive-ui.com/theming/styled).
2296
+
2297
+ ### What replaced PrimeIcons?
1404
2298
 
1405
- Which Angular versions are supported? Angular v22: ExhaustiveUI v22 requires Angular v22. Our majors follow Angular's — when a new Angular major ships, a compatible ExhaustiveUI major is the first thing we work on. See the version compatibility table in the update guide. How do I migrate from PrimeNG? Is it automatic? Mostly, but not through ng add , which only sets up new projects and fails without changing anything when it finds an existing primeng dependency. Install @exhaustive-ui/core , then run ng generate @exhaustive-ui/core:migrate-from-primeng in a PrimeNG v21 workspace updated to Angular v22: packages swapped, imports rewritten, dependencies installed. It then prints a report of anything it could not rewrite, with file and line numbers. The migration guide covers the details and the manual cases. I am on PrimeNG v20 or older. Can I migrate directly? No. Upgrade to PrimeNG v21 first, using PrimeNG's own migration guides, then update Angular to v22 and run the schematic. The schematic checks the version and refuses rather than producing a half-migrated workspace. What happens to my PrimeNG license? Nothing — it is unrelated. A PrimeNG v22 commercial license covers PrimeNG. ExhaustiveUI needs no license at all. If you hold a PrimeTek subscription for their templates or theme designer, those remain their products and do not carry over here. I had an open PR on primefaces/primeng. Can I bring it here? Yes, and we would like you to. Append .patch to your original pull request URL and apply it with git am — the contributing guide in the repository walks through it, including what to do when the patch no longer applies cleanly. Can I run PrimeNG and ExhaustiveUI side by side? Technically yes, since the package names and the CSS cascade layer differ, but you will ship two copies of the same components and two theme runtimes. Treat it as a temporary state during migration rather than a supported configuration.
2299
+ [OpenNG Icons](https://exhaustive-ui.com/icons), installed as `@openng/icons`. The `pi pi-{icon}` class names are unchanged, so templates do not need editing — only the package name and the
2300
+ stylesheet import, both of which the migration schematic rewrites.
1406
2301
 
1407
- ## Project
2302
+ ### What about PrimeFlex?
1408
2303
 
1409
- Is ExhaustiveUI free? Will it stay free? Yes, and yes. Every package is MIT licensed, and the code we forked was MIT too, so relicensing it is not something we could do even if we wanted to. There is no paid tier and none is planned. The philosophy page goes into what that does and does not buy you. Is this an official PrimeNG fork? Are you affiliated with PrimeTek? No. ExhaustiveUI is an independent community fork, not affiliated with, endorsed by, or sponsored by PrimeTek. It is a fork of Optimus UI (OpenNG), itself a repository seeded with PrimeNG's MIT licensed code and history, not a fork of the archived primefaces/primeng repository. Which PrimeNG version is this forked from? PrimeNG v21, the last version published under the MIT license, by way of Optimus UI v2. ExhaustiveUI v22 is that codebase, rebranded and migrated to the Angular Signals API, with the fixes that have landed since; its major version number follows Angular's. Who maintains it, and how is it funded? A small group of volunteers, with e-xiste covering hosting and the domain. We are deliberate about not implying more than that — see sustainability for the honest version and the ways that can change. Why did the name change? Trademark, twice over. PrimeNG, PrimeFaces and PrimeFlex are PrimeTek's marks, and Optimus UI is OpenNG's, so the packages and the CSS cascade layer needed a name of their own. That is also why the rename from PrimeNG is handled by a schematic rather than by asking you to rewrite imports by hand.
2304
+ PrimeFlex is not maintained here. We suggest Tailwind CSS instead, and ship `@exhaustive-ui/tailwindcss` for first-class integration — see the [Tailwind guide](https://exhaustive-ui.com/tailwind). The
2305
+ [PrimeFlex guide](https://exhaustive-ui.com/guides/primeflex) covers moving across.
1410
2306
 
1411
- ## Support
2307
+ ### Does ExhaustiveUI work with SSR?
1412
2308
 
1413
- Is there commercial support? No. There is no SLA, no support contract and no guaranteed response time. Issues and discussions are answered by volunteers when they have time. If your organisation needs contractual guarantees, this project cannot offer them. How do I report a bug? Open an issue on GitHub with a minimal reproduction — a StackBlitz from any demo on this site is ideal — plus your ExhaustiveUI, Angular and browser versions. A reproduction is the difference between a bug that gets fixed and one that sits in the backlog. How do I request a feature? Open a discussion . Requests are triaged and welcome, but in practice they ship when someone implements them. If it matters to you, the contribution guide is the fastest route. Where do I ask questions? GitHub Discussions is the primary place. There is no chat server; a written question with a reproduction gets a better answer than a real-time one. How does versioning work? Semantic versioning, with majors tracking Angular majors. Breaking changes are confined to majors and documented in the GitHub releases .
2309
+ This documentation site is itself an Angular SSR application built on ExhaustiveUI, prerendered at build time. So yes, and any regression there tends to be noticed quickly.
2310
+
2311
+ ## Support & Contributing
2312
+
2313
+ ### Is there commercial support?
2314
+
2315
+ No. There is no SLA, no support contract and no guaranteed response time. Issues and discussions are answered by volunteers when they have time. If your organisation needs contractual guarantees, this project cannot offer them.
2316
+
2317
+ ### How do I report a bug?
2318
+
2319
+ Open an issue on [GitHub](https://github.com/e-xiste/exhaustive-ui/issues) with a minimal reproduction — a StackBlitz from any demo on this site is ideal — plus your ExhaustiveUI,
2320
+ Angular and browser versions. A reproduction is the difference between a bug that gets fixed and one that sits in the backlog.
2321
+
2322
+ ### How do I request a feature?
2323
+
2324
+ Open a [discussion](https://github.com/e-xiste/exhaustive-ui/discussions). Requests are triaged and welcome, but in practice they ship when someone implements them. If it matters to
2325
+ you, the [contribution guide](https://exhaustive-ui.com/contribution) is the fastest route.
2326
+
2327
+ ### Where do I ask questions?
2328
+
2329
+ GitHub Discussions is the primary place. There is no chat server; a written question with a reproduction gets a better answer than a real-time one.
2330
+
2331
+ ### How does versioning work?
2332
+
2333
+ Semantic versioning, with majors tracking Angular majors. Breaking changes are confined to majors and documented in the
2334
+ [GitHub releases](https://github.com/e-xiste/exhaustive-ui/releases).
1414
2335
 
1415
2336
  ---
1416
2337
 
1417
2338
  # Update ExhaustiveUI
1418
2339
 
1419
- Updating with ng update, Angular version compatibility, and what changes in v22 (Signals API, OnPush, automated migrations).
2340
+ Updating with ng update, Angular version compatibility, and a summary of what changes in v22.
2341
+
2342
+ ## Overview
2343
+
2344
+ All `@exhaustive-ui/core` packages — the components, themes, locale definitions, Tailwind CSS plugin and their internal dependencies — are versioned and released together, so an update always moves the whole suite to a single
2345
+ new version. ExhaustiveUI supports `ng update`, the Angular CLI's own update mechanism, which bumps every installed ExhaustiveUI package in one step and runs any automated code migrations shipped with the new version.
2346
+
2347
+ Major versions follow Angular's: when a new Angular major ships, a matching ExhaustiveUI major is released for it. Minor and patch releases stay within the same Angular major and are drop-in updates.
2348
+
2349
+ This page is about updating a project that already uses ExhaustiveUI. To move an existing PrimeNG workspace across, see the
2350
+ [migration guide](https://v1.optimus.openng.org/migration/primeng) instead.
2351
+
2352
+ ## Updating
2353
+
2354
+ Run `ng update` without arguments at any time to list the updates available in your workspace, ExhaustiveUI included.
2355
+
2356
+ ```bash
2357
+ ng update
2358
+ ```
2359
+
2360
+ To update within the current major, pass the main package. The Angular CLI resolves the rest: `@exhaustive-ui/core` declares all its companion packages as a group, so every installed `@exhaustive-ui/*` package —
2361
+ themes, locale, Tailwind CSS plugin and the internal runtime packages — is updated together and the suite cannot end up on mixed versions.
2362
+
2363
+ ```bash
2364
+ ng update @exhaustive-ui/core
2365
+ ```
2366
+
2367
+ Like any `ng update` run, the command expects a clean git working tree so its changes can be reviewed or reverted in isolation — commit or stash your work first.
2368
+
2369
+ ## Angular Version Compatibility
2370
+
2371
+ Each ExhaustiveUI major targets a single Angular major.
2372
+
2373
+ To move to a new major, update Angular first — the [Angular update guide](https://angular.dev/update-guide) covers that step — then update ExhaustiveUI to the matching major by
2374
+ passing the target version. For example, once Angular v23 and ExhaustiveUI v23 are out, from v22:
2375
+
2376
+ ```bash
2377
+ ng update @angular/core@23 @angular/cli@23
2378
+ ng update @exhaustive-ui/core@23
2379
+ ```
2380
+
2381
+ Review the release notes of the target version for breaking changes before you start.
2382
+
2383
+ ## Updating to v22
2384
+
2385
+ ExhaustiveUI v22 is the first major of the fork. It requires Angular 22 and moves the whole library to the Angular Signals API. Templates keep working as before; code that reaches into a component instance reads inputs with a call and
2386
+ writes two-way properties with `.set()`, and components use OnPush change detection. `ng update` applies nine migrations to templates and code and reports what it left for review.
1420
2387
 
1421
- ## Major-versions
2388
+ ```bash
2389
+ ng update @angular/core@22 @angular/cli@22
2390
+ ng update @exhaustive-ui/core@22
2391
+ ```
2392
+
2393
+ The [migration guide to v22](https://exhaustive-ui.com/migration/v22) covers the update steps from an ExhaustiveUI prerelease, PrimeNG v21 or Optimus UI, each migration and its report, the code changes, and the behavior
2394
+ and type changes.
2395
+
2396
+ ## Release Notes
2397
+
2398
+ Every version is published with its notes on the [GitHub releases page](https://github.com/e-xiste/exhaustive-ui/releases), covering new features, fixes and any breaking changes or
2399
+ manual steps a release requires. Check the notes for the target version before a major update.
1422
2400
 
1423
- Each ExhaustiveUI major targets a single Angular major. To move to a new major, update Angular first — the Angular update guide covers that step — then update ExhaustiveUI to the matching major by passing the target version. For example, once Angular v23 and ExhaustiveUI v23 are out, from v22: Review the release notes of the target version for breaking changes before you start.
2401
+ ---
1424
2402
 
1425
- ## Ng-update
2403
+ # Migrating to v22
1426
2404
 
1427
- Run ng update without arguments at any time to list the updates available in your workspace, ExhaustiveUI included. To update within the current major, pass the main package. The Angular CLI resolves the rest: @exhaustive-ui/core declares all its companion packages as a group, so every installed @exhaustive-ui/* package — themes, locale, Tailwind CSS plugin and the internal runtime packages — is updated together and the suite cannot end up on mixed versions. Like any ng update run, the command expects a clean git working tree so its changes can be reviewed or reverted in isolation — commit or stash your work first.
2405
+ Moving an application to ExhaustiveUI v22: update steps from an ExhaustiveUI prerelease, PrimeNG v21 or Optimus UI, the automated migrations and their report, the Signals API, OnPush, removed API, behavior and type changes.
1428
2406
 
1429
2407
  ## Overview
1430
2408
 
1431
- All @exhaustive-ui/core packages — the components, themes, locale definitions, Tailwind CSS plugin and their internal dependencies — are versioned and released together, so an update always moves the whole suite to a single new version. ExhaustiveUI supports ng update , the Angular CLI's own update mechanism, which bumps every installed ExhaustiveUI package in one step and runs any automated code migrations shipped with the new version. Major versions follow Angular's: when a new Angular major ships, a matching ExhaustiveUI major is released for it. Minor and patch releases stay within the same Angular major and are drop-in updates. This page is about updating a project that already uses ExhaustiveUI. To move an existing PrimeNG workspace across, see the migration guide instead.
2409
+ ExhaustiveUI v22 requires Angular 22 and moves every component and directive to the Angular Signals API. Templates bind as before: `[name]`, `[(name)]` and `(name)` keep working. Most of the work is done by
2410
+ `ng update`. What is left is code that reaches into a component instance, data mutated in place under OnPush components, and the few places the migrations report.
2411
+
2412
+ This guide covers three starting points:
2413
+
2414
+ - **A v22 alpha or release candidate** of ExhaustiveUI: update to 22.0.0 with `ng update`, which runs the migrations. They leave code that is already migrated as it is, so running them again is safe.
2415
+ - **PrimeNG v21**: switch to ExhaustiveUI with the `migrate-from-primeng` schematic, then run the v22 migrations explicitly.
2416
+ - **Optimus UI v2**, which shares the PrimeNG v21 API: swap the packages and imports, then run the v22 migrations explicitly.
2417
+
2418
+ Updating later within v22, or to a future major, is covered by the [update guide](https://exhaustive-ui.com/migration/update). Every breaking change below is also listed in the
2419
+ [changelog](https://github.com/e-xiste/exhaustive-ui/blob/main/CHANGELOG.md).
2420
+
2421
+ ## Before you start
2422
+
2423
+ - **Angular 22.** The peer dependencies are `^22.0.0`. Update Angular first with the [Angular update guide](https://angular.dev/update-guide), and use the Node.js and TypeScript versions it requires.
2424
+ - **A clean git working tree.** Commit or stash your work, so the changes made by the migrations can be reviewed, and reverted, on their own.
2425
+ - **A build and test run that passes** before you start, so anything that breaks afterwards comes from the update.
2426
+ - **PrimeFlex**, if the project uses it: it is not part of the update. The `migrate-from-primeflex` schematic translates its classes to Tailwind CSS, as a separate step.
2427
+
2428
+ ## Update steps
2429
+
2430
+ ### From an ExhaustiveUI alpha or release candidate
2431
+
2432
+ Update Angular, then ExhaustiveUI. Every installed `@exhaustive-ui/*` package moves to 22.0.0 together, and the migrations run.
2433
+
2434
+ ```bash
2435
+ ng update @angular/core@22 @angular/cli@22
2436
+ ng update @exhaustive-ui/core@22
2437
+ ```
2438
+
2439
+ ### From PrimeNG v21
2440
+
2441
+ Update Angular to 22, install ExhaustiveUI and run the `migrate-from-primeng` schematic. It swaps the `primeng`, `@primeuix/*` and PrimeIcons dependencies, rewrites the imports (`primeng/button` becomes
2442
+ `@exhaustive-ui/core/button`) and renames the configuration API (`providePrimeNG` becomes `provideExhaustive`). The workspace did not go through `ng update`, so run the v22 migrations explicitly afterwards.
2443
+
2444
+ ```bash
2445
+ ng update @angular/core@22 @angular/cli@22
2446
+ npm install @exhaustive-ui/core@22
2447
+ ng generate @exhaustive-ui/core:migrate-from-primeng
2448
+ ng update @exhaustive-ui/core --migrate-only --from=3.0.0
2449
+ ```
2450
+
2451
+ Projects on PrimeNG v20 or older upgrade to PrimeNG v21 first; the schematic checks the version and refuses otherwise.
2452
+
2453
+ ### From Optimus UI v2
2454
+
2455
+ Optimus UI v2 has the PrimeNG v21 API under other package names. Replace its packages with their `@exhaustive-ui/*` counterparts (`@exhaustive-ui/core`, `@exhaustive-ui/themes`...), update the import paths
2456
+ to match, then run the v22 migrations explicitly.
2457
+
2458
+ ```bash
2459
+ ng update @exhaustive-ui/core --migrate-only --from=3.0.0
2460
+ ```
2461
+
2462
+ ### Then
2463
+
2464
+ 1. Read the report the migrations printed, see `Reviewing the report` below.
2465
+ 2. Fix the TypeScript errors: most come from the Signals API and the removed TypeScript API.
2466
+ 3. Check the screens that mutate data bound to a component, which no longer refresh under OnPush.
2467
+ 4. Read the behavior changes, then build and run your tests.
2468
+
2469
+ ## Automated migrations
2470
+
2471
+ `ng update` applies nine migrations to the templates (inline and external) and the TypeScript code of every project in the workspace. Each one only touches the ExhaustiveUI elements and APIs it knows, and reports what it cannot
2472
+ rewrite safely.
2473
+
2474
+ - **styleclass-to-class**: `styleClass`/`[styleClass]` becomes `class`/`[class]` on the ~60 components whose deprecated `styleClass` input was removed, such as Tag, Card, Select, Table, DatePicker, Panel, AvatarGroup and InputGroupAddon.
2475
+ - **renamed-inputs**: Drawer `showCloseIcon` becomes `closable` and `ariaCloseLabel` becomes `closeAriaLabel`; Paginator `dropdownAppendTo` becomes `appendTo`; Password `maxLength` becomes `maxlength`; AutoComplete `minLength` becomes `minQueryLength`; TreeSelect `containerStyleClass`/`containerStyle` become `class`/`style`; TreeTable `virtualRowHeight` becomes `virtualScrollItemSize`; Listbox and MultiSelect `filterPlaceHolder` becomes `filterPlaceholder`; ImageCompare `ariaLabelledby` becomes `ariaLabelledBy`; Dialog `[content]`, which set the header template, becomes `[headerTemplate]`; the `pt*` pass-through aliases of pButton, pButtonLabel, pButtonIcon, pBadge, pInputText and pTooltip become `pButtonPT`, `pButtonLabelPT`, `pButtonIconPT`, `pBadgePT`, `pInputTextPT` and `pTooltipPT`; pBadge `size` on a plain element becomes `badgeSize`.
2476
+ - **renamed-outputs**: OrderList `onFilterEvent` becomes `onFilter`; Table `selectAllChange` becomes `onSelectAllChange`; MultiSelect `onPanelShow`/`onPanelHide` become `onShow`/`onHide`. The payloads are unchanged, so handlers reading `$event` keep working.
2477
+ - **renamed-templates**: the MultiSelect `removetokenicon` template becomes `chipicon`, with the same context.
2478
+ - **remove-dead-inputs**: removes the bindings of about eighty inputs that had already stopped doing anything, such as the `*TransitionOptions` inputs (replaced by `motionOptions`), `autoZIndex`/`baseZIndex` on sub menus, Table `frozenColumns`/`frozenWidth`, the ConfirmDialog aria labels and the `trackBy` inputs of DataView, OrderList and PickList.
2479
+ - **remove-dead-outputs**: removes Overlay `onAnimationStart`/`onAnimationDone` and MenubarSub `menuFocus`/`menuBlur`/`menuKeydown`.
2480
+ - **config-overlay-options-signal**: `Exhaustive.overlayOptions` is a signal. Assignments become `.set()` and reads become calls.
2481
+ - **config-input-style-to-variant**: the global `inputStyle` option becomes `inputVariant` (same values), in `provideExhaustive()`/`setConfig()` objects and on the `Exhaustive` service.
2482
+ - **removed-exports**: `Password_VALUE_ACCESSOR` becomes `PASSWORD_VALUE_ACCESSOR`; the removed `InplaceDisplay`/`InplaceContent` wrappers are dropped from imports and their elements become `<span>`.
2483
+
2484
+ ## Reviewing the report
2485
+
2486
+ Each migration prints the files it changed, then the places it left for you, with the file and line. These are the cases it reports and what to do with them.
2487
+
2488
+ - **Programmatic access to a removed or renamed name**, such as `drawer.showCloseIcon = true` or `table.selectAllChange.subscribe(...)`: use the new name, and the Signals API described below.
2489
+ - **A tag that binds both the old and the new name**: keep the new one and delete the old one, after checking which value you meant.
2490
+ - **A Table `[(selectAll)]` two-way binding**, which relied on the renamed `selectAllChange`: bind `[selectAll]="selectAll"` and `(onSelectAllChange)="selectAll = $event.checked"`.
2491
+ - **A MultiSelect that already projects a `chipicon` template** next to `removetokenicon`: keep one of them.
2492
+ - **A configuration object that sets both `inputStyle` and `inputVariant` , or a receiver the migration cannot prove to be the `Exhaustive` service: set `inputVariant` only.
2493
+ - Imports of rendering internals that are no longer exported**: the `SelectItem` option component of Select (the `SelectItem` interface of `@exhaustive-ui/core/api` is unchanged), Menu's `SafeHtmlPipe`, `MapperPipe`, `RadioControlRegistry` and `MenubarService`. Remove the import; the components no longer need them from you.
1432
2494
 
1433
- ## Release-notes
2495
+ Coding agents can check the result with the `validate_usage` tool of the `@exhaustive-ui/mcp` server, which names the replacement of every input removed or renamed in v22, and follow its `update_to_v22` prompt.
1434
2496
 
1435
- Every version is published with its notes on the GitHub releases page , covering new features, fixes and any breaking changes or manual steps a release requires. Check the notes for the target version before a major update.
2497
+ ## Code using a component instance
1436
2498
 
1437
- ## V22
2499
+ Every input is an `input()`, every two-way property a `model()`, every output an `output()` and every query a signal query. No `@Input`, `@Output`, `@ViewChild` or
2500
+ `@ContentChild` decorator is left. Templates are not affected, and the migrations do not rewrite this kind of code: the compiler points at each place.
1438
2501
 
1439
- ExhaustiveUI v22 is the first major of the fork. It requires Angular v22 and moves the whole library to the Angular Signals API. Templates keep working as before: inputs are still bound with [name] , two-way bindings with [(name)] , and outputs with (name) . What changes is code that reaches into a component instance. Inputs are signal inputs: read them as component.name() rather than component.name , and set them through a template binding rather than by assignment. Two-way properties such as visible , value or selection are model() signals; call .set() on them from code. Template and child queries are signal queries ( contentChild() , viewChild() , ...), read with a call as well. Components use OnPush change detection, except Table, TreeTable and DynamicDialog. State shared with them should be passed through inputs or signals rather than mutated in place. Templates use the built-in @if / @for control flow, and option lists, menus and paginators track rows by position, so replacing the model no longer recreates every row. Run the update with ng update ; it applies the automated migrations shipped with v22 to your templates and code: styleclass-to-class : styleClass becomes the native class attribute on the components that dropped the input. renamed-inputs : deprecated aliases are renamed to their replacement, e.g. showCloseIcon to closable on Drawer, minLength to minQueryLength on AutoComplete, virtualRowHeight to virtualScrollItemSize on TreeTable, filterPlaceHolder to filterPlaceholder on Listbox and MultiSelect. renamed-outputs : outputs are renamed to the name the other components use, with the same event payload: onFilterEvent to onFilter on OrderList, selectAllChange to onSelectAllChange on Table, onPanelShow / onPanelHide to onShow / onHide on MultiSelect. renamed-templates : the removetokenicon template of MultiSelect becomes chipicon . remove-dead-inputs and remove-dead-outputs : bindings of inputs and outputs that already had no effect are removed. config-overlay-options-signal : overlayOptions on the global configuration is a signal; assignments become .set() and reads become calls. removed-exports : Password_VALUE_ACCESSOR becomes PASSWORD_VALUE_ACCESSOR , and the removed p-inplacedisplay / p-inplacecontent wrappers become a span . config-input-style-to-variant : the global inputStyle option, deprecated since v20, becomes inputVariant in provideExhaustive() and on the configuration service. Each migration prints the files it changed and the places it left for you to review, with file and line numbers. A workspace that has just switched to ExhaustiveUI, from PrimeNG with the migrate-from-primeng schematic or from Optimus UI, did not go through ng update . Run the migrations explicitly:
2502
+ - Read an input by calling it: `table.first()`, not `table.first`.
2503
+ - Inputs can no longer be assigned from code. Bind them in the template to a field or a signal of your component, and change that instead.
2504
+ - Two-way properties are `model()` signals: write them with `.set()`, as in `drawer.visible.set(true)`. The value and change-event pairs became models, for example `first`, `rows` and `selection` on Table and TreeTable, and `visible` on Dialog, Drawer and Galleria. `[(x)]` bindings keep working.
2505
+ - Outputs are `OutputEmitterRef`s: `.subscribe()` still works, `.pipe()` and the other `EventEmitter` members do not. Use `outputToObservable()` when you need an observable.
2506
+ - Public child references of a component are signal queries too, and are read with a call.
2507
+ - The global configuration is a set of signals on the `Exhaustive` service: `config.ripple.set(true)`, `config.inputVariant()`.
2508
+
2509
+ ```typescript
2510
+ // Before
2511
+ @ViewChild(Table) table!: Table;
2512
+ @ViewChild(Drawer) drawer!: Drawer;
2513
+
2514
+ reset() {
2515
+ const first = this.table.first;
2516
+ this.table.selection = [];
2517
+ this.drawer.visible = false;
2518
+ this.config.ripple = true;
2519
+ }
2520
+
2521
+ // After
2522
+ table = viewChild.required(Table);
2523
+ drawer = viewChild.required(Drawer);
2524
+
2525
+ reset() {
2526
+ const first = this.table().first();
2527
+ this.table().selection.set([]);
2528
+ this.drawer().visible.set(false);
2529
+ this.config.ripple.set(true);
2530
+ }
2531
+ ```
2532
+
2533
+ ## OnPush change detection
2534
+
2535
+ Every component uses `OnPush` change detection, except Table, TreeTable and DynamicDialog, which stay Eager on purpose because they render objects that applications commonly mutate in place. An OnPush component refreshes when one
2536
+ of its inputs gets a new value, when it handles an event, or when a signal it reads changes. It does not see a change made inside an array or an object it already holds.
2537
+
2538
+ The symptom is a component that does not update: options added with `push()` that do not appear in a Select, a Tree node renamed in place, a chart that keeps its old data. Give the component a new array or object, or keep the
2539
+ data in a signal.
2540
+
2541
+ ```typescript
2542
+ // Before: the Select does not show the new option under OnPush
2543
+ this.cities.push({ name: 'Paris', code: 'PRS' });
2544
+
2545
+ // After: a new array
2546
+ this.cities = [...this.cities, { name: 'Paris', code: 'PRS' }];
2547
+
2548
+ // Or a signal, bound with [options]="cities()"
2549
+ cities = signal<City[]>([]);
2550
+ this.cities.update((cities) => [...cities, { name: 'Paris', code: 'PRS' }]);
2551
+ ```
2552
+
2553
+ Templates use the built-in `@if`, `@for` and `@switch` control flow, and option lists, menus, Paginator and DatePicker reuse their rows when the data is replaced instead of recreating them. Replacing the
2554
+ array is therefore cheap, and no NG0955 or NG0956 warning comes from the library.
2555
+
2556
+ ## Removed TypeScript API
2557
+
2558
+ These removals have no migration: they only appear in TypeScript code, and the compiler points at each use.
2559
+
2560
+ - `OverlayOptions.showTransitionOptions`/`hideTransitionOptions` and `DynamicDialogConfig.rtl`/`transitionOptions`: nothing read them. Use `motionOptions`.
2561
+ - `@exhaustive-ui/utils`: `classNames` becomes `cn`, `createStyleAsString` becomes `createStyleMarkup`, `createStyleTag` becomes `createStyleElement`, `mergeKeys` becomes `deepMerge`.
2562
+ - `@exhaustive-ui/styled`: `getDirective` on the theme service becomes `getComponent`.
2563
+ - Sub components that render the inside of a component (`ContextMenuSub`, `TieredMenuSub`, `MenuItemContent`, `MultiSelectItem`, `ToastItem`, `TableBody`, `TTBody`, `UITreeNode`, the Galleria parts...), `PARENT_INSTANCE` and the pre-signals helpers of `@exhaustive-ui/core/utils` are still exported in v22 but tagged `@internal`. They are not public API and can change in a minor release.
2564
+
2565
+ ## Behavior changes
2566
+
2567
+ These changes compile without error but can change what users see, or what a test asserts. Most come from fixes of bugs inherited from PrimeNG and Optimus UI. The issue numbers in the changelog are Optimus UI's.
2568
+
2569
+ ### Forms
2570
+
2571
+ - InputText: when `[invalid]` is bound, it alone decides the invalid style; the automatic `ng-invalid ng-dirty` border no longer applies on top of it.
2572
+ - InputNumber: a keystroke that would make the formatted value longer than `maxlength` is rejected instead of truncating the text. The native `min`/`max` attributes are gone; the bounds stay in `aria-valuemin`/`aria-valuemax`.
2573
+ - Select: a Select inside a disabled `<fieldset>` is disabled, except inside the fieldset's first `<legend>`, as for native controls.
2574
+ - Select, MultiSelect and CascadeSelect use the SVG spinner of Button as their default loading icon, instead of the `pi-spin` icon class.
2575
+ - PickList: moving items sets `source` and `target` to new arrays and emits `sourceChange`/`targetChange`, so `[(source)]`/`[(target)]` bindings follow.
2576
+ - TreeTable: the selection change can fire once per intermediate step while a checkbox propagates.
2577
+ - DatePicker: the `data-date` attribute of day cells uses a 1-based month.
2578
+ - AutoFocus: the native `autofocus` attribute is only rendered when autofocus is on; Button and the other components no longer carry it by default.
2579
+
2580
+ ### Overlays and menus
2581
+
2582
+ - Overlays are placed against the viewport without its scrollbars, so an overlay at the right edge no longer goes under the vertical scrollbar.
2583
+ - Tooltip honours the global `overlayAppendTo` option.
2584
+ - TieredMenu: with `autoDisplay`, submenus open on hover from the start, without a first click. A popup TieredMenu gives the focus back to its trigger when an item is picked.
2585
+ - ContextMenu: showing a context menu closes any other one that is open.
2586
+ - ConfirmPopup: an `accepticon`/`rejecticon` template replaces the `acceptIcon`/`rejectIcon` class instead of rendering next to it, as in ConfirmDialog.
2587
+
2588
+ ### Accessibility markup
2589
+
2590
+ - Stepper: the `tablist` role is on `p-step-list`. Splitter: the `separator` role is on the focusable gutter handle.
2591
+ - FocusTrap sentinels are no longer `aria-hidden`. ConfirmDialog no longer puts a `role` on the `p-dialog` host.
2592
+ - Table announces keyboard column and row moves through the new `aria.columnMoved` and `aria.rowMoved` translation keys. A custom `aria` translation without them falls back to English.
2593
+
2594
+ ### Theming and display
2595
+
2596
+ - A token overridden under `colorScheme.light` wins over the preset's top-level token, as it already did in dark mode. A top-level override passed to `definePreset`, `updatePreset` or `usePreset` still wins.
2597
+ - MeterGroup: meter widths use the exact percentage; labels keep the rounded value.
2598
+ - ToggleSwitch has no `size` input any more: it had no effect.
2599
+
2600
+ ## Type changes
2601
+
2602
+ Some types now describe what the components actually emit or accept. Code that relied on the old types may need a cast or a narrower check.
2603
+
2604
+ - Table `onFilter`: `filters` is typed `FilterMetadata | FilterMetadata[]`.
2605
+ - TreeTable `TreeTableLazyLoadEvent`: `first` is a `number` and `last` an optional `number`, as in `TableLazyLoadEvent`.
2606
+ - CascadeSelect: `options` is typed as an array, and the value accepts an object.
2607
+ - Dialog and ConfirmDialog: `pt.root` is typed as the options of the root element.
2608
+ - Chart `onDataSelect` emits the new exported `ChartDataSelectEvent` type.
2609
+ - `Confirmation` accepts `draggable`, and DatePicker `hourFormat` also accepts a number.
2610
+
2611
+ ## Checklist
2612
+
2613
+ - Angular 22 installed, and `ng update` (or `--migrate-only --from=3.0.0`) run on a clean working tree.
2614
+ - Every place listed in the migration report handled.
2615
+ - The project compiles: inputs are read with a call, two-way properties written with `.set()`, removed TypeScript API replaced.
2616
+ - No `styleClass`, removed input or `pt*` alias left in templates: `validate_usage` of the MCP server can check this.
2617
+ - Screens that change data bound to a component show the change: new arrays and objects, or signals, rather than in-place mutation.
2618
+ - Behavior changes reviewed against your tests and screenshots.
2619
+ - Signal Forms, if you adopt them: a required field shows as invalid before any interaction, because `[invalid]` cannot be bound next to `[formField]`. A fix is planned in a v22 minor release.
1440
2620
 
1441
2621
  ---
1442
2622
 
@@ -1444,21 +2624,82 @@ ExhaustiveUI v22 is the first major of the fork. It requires Angular v22 and mov
1444
2624
 
1445
2625
  How to contribute to ExhaustiveUI.
1446
2626
 
1447
- ## Benefits
2627
+ ## Introduction
1448
2628
 
1449
- Contributing to ExhaustiveUI comes with several benefits. Being part of an open-source project will enhance your career and open up exciting opportunities. You'll gain significant visibility in the developer community while improving yourself as a professional.
2629
+ ExhaustiveUI is a community-maintained Angular UI library, stewarded by e-xiste and dedicated to providing high-quality, versatile and accessible UI components that help developers build better applications faster.
1450
2630
 
1451
- ## Helpneeded
2631
+ ### Development Setup
1452
2632
 
1453
- ExhaustiveUI is a community-driven project stewarded by e-xiste, and we appreciate any help you can provide. Here are some areas where you can contribute: Issue Triage Help us manage issues by; Reproducing reported bugs Clarifying issue descriptions Tagging issues with appropriate labels Sending Pull Requests We encourage you to send pull requests, especially for issues tagged with the help-needed label. Community Support Assist other users by participating in the issue tracker and GitHub discussions . Your expertise can help others solve problems and improve their experience with ExhaustiveUI.
2633
+ To begin with, clone the ExhaustiveUI repository from GitHub:
1454
2634
 
1455
- ## Introduction
2635
+ ```typescript
2636
+ git clone https://github.com/e-xiste/exhaustive-ui.git
2637
+ cd exhaustive-ui
2638
+ ```
2639
+
2640
+ Then run the documentation app in your local environment at `http://localhost:4200/`.
2641
+
2642
+ ```typescript
2643
+ pnpm install
2644
+ pnpm run dev
2645
+ ```
2646
+
2647
+ ### Project Structure
2648
+
2649
+ ExhaustiveUI's project structure is organized as follows:
2650
+
2651
+ ```typescript
2652
+ - apps
2653
+ - docs // this documentation website
2654
+ - tailwind-playgrounds // Tailwind integration sandboxes
2655
+ - packages
2656
+ - core // components, directives and services
2657
+ - themes // built-in theme presets
2658
+ - styled // styled-mode theming engine
2659
+ - styles // base styles
2660
+ - tailwindcss // Tailwind CSS plugin
2661
+ - locale // i18n locales
2662
+ - motion // animation utilities
2663
+ - utils // shared helpers
2664
+ ```
2665
+
2666
+ ## Help Needed
2667
+
2668
+ ExhaustiveUI is a community-driven project stewarded by e-xiste, and we appreciate any help you can provide. Here are some areas where you can contribute:
2669
+
2670
+ ### Issue Triage
2671
+
2672
+ Help us manage issues by;
2673
+
2674
+ - Reproducing reported bugs
2675
+ - Clarifying issue descriptions
2676
+ - Tagging issues with appropriate labels
2677
+
2678
+ ### Sending Pull Requests
2679
+
2680
+ We encourage you to send pull requests, especially for issues tagged with the `help-needed` label.
1456
2681
 
1457
- ExhaustiveUI is a community-maintained Angular UI library, stewarded by e-xiste and dedicated to providing high-quality, versatile and accessible UI components that help developers build better applications faster. Development Setup To begin with, clone the ExhaustiveUI repository from GitHub: Then run the documentation app in your local environment at http://localhost:4200/ . Project Structure ExhaustiveUI's project structure is organized as follows:
2682
+ ### Community Support
2683
+
2684
+ Assist other users by participating in the issue tracker and [GitHub discussions](https://github.com/e-xiste/exhaustive-ui/discussions). Your expertise can help others solve
2685
+ problems and improve their experience with ExhaustiveUI.
1458
2686
 
1459
2687
  ## Pathway
1460
2688
 
1461
- ExhaustiveUI offers an organization structure involving contributors and the core team: Contributor Role After a certain period of frequent contributions, a community member is offered the Contributor role. On average, it may take about three months, but the exact duration can vary depending on the individual commitment. Committer Role If a contributor actively participates in the codebase and PRs, their role may be upgraded to a Committer level, providing direct commit access to the ExhaustiveUI codebase.
2689
+ ExhaustiveUI offers an organization structure involving contributors and the core team:
2690
+
2691
+ ### Contributor Role
2692
+
2693
+ After a certain period of frequent contributions, a community member is offered the Contributor role. On average, it may take about three months, but the exact duration can vary depending on the individual commitment.
2694
+
2695
+ ### Committer Role
2696
+
2697
+ If a contributor actively participates in the codebase and PRs, their role may be upgraded to a Committer level, providing direct commit access to the ExhaustiveUI codebase.
2698
+
2699
+ ## Benefits
2700
+
2701
+ Contributing to ExhaustiveUI comes with several benefits. Being part of an open-source project will enhance your career and open up exciting opportunities. You'll gain significant visibility in the developer community while improving
2702
+ yourself as a professional.
1462
2703
 
1463
2704
  ---
1464
2705