@exhaustive-ui/mcp 22.0.0-alpha.2 → 22.0.0-alpha.4
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/README.md +18 -18
- package/data/components/accordion.md +1 -1
- package/data/components/autocomplete.md +1 -1
- package/data/components/datepicker.md +1 -1
- package/data/components/listbox.md +1 -1
- package/data/components/llms.md +1 -1
- package/data/components/orderlist.md +1 -1
- package/data/components/picklist.md +1 -1
- package/data/components/styleclass.md +1 -1
- package/data/components/tabs.md +1 -1
- package/data/components.json +306 -256
- package/data/llms-full.txt +763 -136
- package/data/llms.txt +1 -0
- package/data/manifest.json +3 -3
- package/data/pages/accessibility.md +6 -6
- package/data/pages/animations.md +7 -7
- package/data/pages/configuration.md +10 -10
- package/data/pages/contribution.md +4 -4
- package/data/pages/customicons.md +4 -4
- package/data/pages/faq.md +6 -6
- package/data/pages/icons.md +9 -9
- package/data/pages/installation.md +12 -12
- package/data/pages/llms.md +7 -7
- package/data/pages/passthrough.md +7 -7
- package/data/pages/philosophy.md +6 -6
- package/data/pages/primeflex.md +5 -5
- package/data/pages/rtl.md +2 -2
- package/data/pages/styled.md +29 -29
- package/data/pages/tailwind.md +610 -9
- package/data/pages/unstyled.md +4 -4
- package/data/pages/update.md +34 -0
- package/data/snapshot.json +3 -3
- package/dist/index.d.mts +1 -1
- package/dist/index.mjs +124 -10
- package/dist/index.mjs.map +1 -1
- package/package.json +1 -1
package/data/llms-full.txt
CHANGED
|
@@ -10,31 +10,31 @@ Generated: 2026-11-20
|
|
|
10
10
|
|
|
11
11
|
Setting up ExhaustiveUI in an Angular CLI project.
|
|
12
12
|
|
|
13
|
-
## Download
|
|
13
|
+
## Download
|
|
14
14
|
|
|
15
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.
|
|
16
16
|
|
|
17
|
-
## Examples
|
|
17
|
+
## Examples
|
|
18
18
|
|
|
19
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.
|
|
20
20
|
|
|
21
|
-
## Icons
|
|
21
|
+
## Icons
|
|
22
22
|
|
|
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
|
|
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 .
|
|
24
24
|
|
|
25
|
-
## Nextsteps
|
|
25
|
+
## Nextsteps
|
|
26
26
|
|
|
27
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
|
|
28
28
|
|
|
29
|
-
## Ngadd
|
|
29
|
+
## Ngadd
|
|
30
30
|
|
|
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
|
|
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.
|
|
32
32
|
|
|
33
|
-
## Prerequisites
|
|
33
|
+
## Prerequisites
|
|
34
34
|
|
|
35
|
-
ExhaustiveUI targets Angular
|
|
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 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.
|
|
36
36
|
|
|
37
|
-
## Provider
|
|
37
|
+
## Provider
|
|
38
38
|
|
|
39
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.
|
|
40
40
|
|
|
@@ -54,11 +54,11 @@ export const appConfig: ApplicationConfig = {
|
|
|
54
54
|
};
|
|
55
55
|
```
|
|
56
56
|
|
|
57
|
-
## Verify
|
|
57
|
+
## Verify
|
|
58
58
|
|
|
59
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.
|
|
60
60
|
|
|
61
|
-
## Versioncompatibility
|
|
61
|
+
## Versioncompatibility
|
|
62
62
|
|
|
63
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.
|
|
64
64
|
|
|
@@ -68,7 +68,7 @@ Each ExhaustiveUI major targets a single Angular major. Install the version matc
|
|
|
68
68
|
|
|
69
69
|
Application wide configuration for ExhaustiveUI.
|
|
70
70
|
|
|
71
|
-
## Csp
|
|
71
|
+
## Csp
|
|
72
72
|
|
|
73
73
|
The nonce value to use on dynamically generated style elements in core.
|
|
74
74
|
|
|
@@ -80,7 +80,7 @@ provideExhaustive({
|
|
|
80
80
|
})
|
|
81
81
|
```
|
|
82
82
|
|
|
83
|
-
## Dynamic
|
|
83
|
+
## Dynamic
|
|
84
84
|
|
|
85
85
|
Inject the Exhaustive to your application to update the initial configuration at runtime.
|
|
86
86
|
|
|
@@ -102,7 +102,7 @@ export class AppComponent implements OnInit {
|
|
|
102
102
|
}
|
|
103
103
|
```
|
|
104
104
|
|
|
105
|
-
## Filtermode
|
|
105
|
+
## Filtermode
|
|
106
106
|
|
|
107
107
|
Default filter modes to display on DataTable filter menus.
|
|
108
108
|
|
|
@@ -127,7 +127,7 @@ export class AppComponent implements OnInit {
|
|
|
127
127
|
}
|
|
128
128
|
```
|
|
129
129
|
|
|
130
|
-
## Inputvariant
|
|
130
|
+
## Inputvariant
|
|
131
131
|
|
|
132
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
133
|
|
|
@@ -137,7 +137,7 @@ Locale Options
|
|
|
137
137
|
|
|
138
138
|
## Repository
|
|
139
139
|
|
|
140
|
-
Ready to use settings for locales are available as the
|
|
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.
|
|
141
141
|
|
|
142
142
|
```typescript
|
|
143
143
|
import { de } from '@exhaustive-ui/locale/js/de.js';
|
|
@@ -189,11 +189,11 @@ provideExhaustive({
|
|
|
189
189
|
})
|
|
190
190
|
```
|
|
191
191
|
|
|
192
|
-
## Overlayappendto
|
|
192
|
+
## Overlayappendto
|
|
193
193
|
|
|
194
194
|
Defines the default location of the overlays; self refers to the host element and body targets the document body. Defaults to self .
|
|
195
195
|
|
|
196
|
-
## Provider
|
|
196
|
+
## Provider
|
|
197
197
|
|
|
198
198
|
The initial configuration is defined by the provideExhaustive provider during application startup.
|
|
199
199
|
|
|
@@ -210,7 +210,7 @@ export const appConfig: ApplicationConfig = {
|
|
|
210
210
|
};
|
|
211
211
|
```
|
|
212
212
|
|
|
213
|
-
## Ripple
|
|
213
|
+
## Ripple
|
|
214
214
|
|
|
215
215
|
Ripple is an optional animation for the supported components such as buttons. It is disabled by default.
|
|
216
216
|
|
|
@@ -220,7 +220,7 @@ provideExhaustive({
|
|
|
220
220
|
})
|
|
221
221
|
```
|
|
222
222
|
|
|
223
|
-
## Theme
|
|
223
|
+
## Theme
|
|
224
224
|
|
|
225
225
|
ExhaustiveUI provides 4 predefined themes out of the box; Aura, Material, Lara and Nora. See the theming documentation for details.
|
|
226
226
|
|
|
@@ -248,7 +248,7 @@ export const appConfig: ApplicationConfig = {
|
|
|
248
248
|
};
|
|
249
249
|
```
|
|
250
250
|
|
|
251
|
-
## Zindex
|
|
251
|
+
## Zindex
|
|
252
252
|
|
|
253
253
|
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.
|
|
254
254
|
|
|
@@ -280,99 +280,99 @@ export class AppComponent implements OnInit {
|
|
|
280
280
|
|
|
281
281
|
Choose from a variety of pre-styled themes or develop your own.
|
|
282
282
|
|
|
283
|
-
## Architecture
|
|
283
|
+
## Architecture
|
|
284
284
|
|
|
285
285
|
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.
|
|
286
286
|
|
|
287
|
-
## Bootstrap
|
|
287
|
+
## Bootstrap
|
|
288
288
|
|
|
289
289
|
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.
|
|
290
290
|
|
|
291
|
-
## Colors
|
|
291
|
+
## Colors
|
|
292
292
|
|
|
293
293
|
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 }} } }
|
|
294
294
|
|
|
295
|
-
## Colorscheme
|
|
295
|
+
## Colorscheme
|
|
296
296
|
|
|
297
297
|
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.
|
|
298
298
|
|
|
299
|
-
## Component
|
|
299
|
+
## Component
|
|
300
300
|
|
|
301
301
|
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.
|
|
302
302
|
|
|
303
|
-
## Darkmode
|
|
303
|
+
## Darkmode
|
|
304
304
|
|
|
305
305
|
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.
|
|
306
306
|
|
|
307
|
-
## Definepreset
|
|
307
|
+
## Definepreset
|
|
308
308
|
|
|
309
309
|
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.
|
|
310
310
|
|
|
311
|
-
## Dt
|
|
311
|
+
## Dt
|
|
312
312
|
|
|
313
313
|
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.
|
|
314
314
|
|
|
315
|
-
## Extend
|
|
315
|
+
## Extend
|
|
316
316
|
|
|
317
317
|
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.
|
|
318
318
|
|
|
319
|
-
## Focusring
|
|
319
|
+
## Focusring
|
|
320
320
|
|
|
321
321
|
Focus ring defines the outline width, style, color and offset. Let's use a thicker ring with the primary color for the outline.
|
|
322
322
|
|
|
323
|
-
## Font
|
|
323
|
+
## Font
|
|
324
324
|
|
|
325
325
|
There is no design for fonts as UI components inherit their font settings from the application.
|
|
326
326
|
|
|
327
|
-
## Forms
|
|
327
|
+
## Forms
|
|
328
328
|
|
|
329
329
|
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.
|
|
330
330
|
|
|
331
|
-
## Libraries
|
|
331
|
+
## Libraries
|
|
332
332
|
|
|
333
333
|
Example layer configuration for the popular CSS libraries.
|
|
334
334
|
|
|
335
|
-
## Noir
|
|
335
|
+
## Noir
|
|
336
336
|
|
|
337
337
|
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;
|
|
338
338
|
|
|
339
|
-
## Options
|
|
339
|
+
## Options
|
|
340
340
|
|
|
341
341
|
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 .
|
|
342
342
|
|
|
343
|
-
## Palette
|
|
343
|
+
## Palette
|
|
344
344
|
|
|
345
345
|
Returns shades and tints of a given color from 50 to 950 as an array.
|
|
346
346
|
|
|
347
|
-
## Presets
|
|
347
|
+
## Presets
|
|
348
348
|
|
|
349
349
|
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.
|
|
350
350
|
|
|
351
|
-
## Primary
|
|
351
|
+
## Primary
|
|
352
352
|
|
|
353
353
|
The primary defines the main color palette, default value maps to the emerald primitive token. Let's setup to use indigo instead.
|
|
354
354
|
|
|
355
|
-
## Reset
|
|
355
|
+
## Reset
|
|
356
356
|
|
|
357
357
|
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.
|
|
358
358
|
|
|
359
|
-
## Scale
|
|
359
|
+
## Scale
|
|
360
360
|
|
|
361
361
|
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.
|
|
362
362
|
|
|
363
|
-
## Scopedtokens
|
|
363
|
+
## Scopedtokens
|
|
364
364
|
|
|
365
365
|
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.
|
|
366
366
|
|
|
367
|
-
## Specificity
|
|
367
|
+
## Specificity
|
|
368
368
|
|
|
369
|
-
The
|
|
369
|
+
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.
|
|
370
370
|
|
|
371
|
-
## Surface
|
|
371
|
+
## Surface
|
|
372
372
|
|
|
373
373
|
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.
|
|
374
374
|
|
|
375
|
-
## Theme
|
|
375
|
+
## Theme
|
|
376
376
|
|
|
377
377
|
The theme property is used to customize the initial theme.
|
|
378
378
|
|
|
@@ -392,19 +392,19 @@ export const appConfig: ApplicationConfig = {
|
|
|
392
392
|
};
|
|
393
393
|
```
|
|
394
394
|
|
|
395
|
-
## Updatepreset
|
|
395
|
+
## Updatepreset
|
|
396
396
|
|
|
397
397
|
Merges the provided tokens to the current preset, an example would be changing the primary color palette dynamically.
|
|
398
398
|
|
|
399
|
-
## Updateprimarypalette
|
|
399
|
+
## Updateprimarypalette
|
|
400
400
|
|
|
401
401
|
Updates the primary colors, this is a shorthand to do the same update using updatePreset .
|
|
402
402
|
|
|
403
|
-
## Updatesurfacepalette
|
|
403
|
+
## Updatesurfacepalette
|
|
404
404
|
|
|
405
405
|
Updates the surface colors, this is a shorthand to do the same update using updatePreset .
|
|
406
406
|
|
|
407
|
-
## Usepreset
|
|
407
|
+
## Usepreset
|
|
408
408
|
|
|
409
409
|
Replaces the current presets entirely, common use case is changing the preset dynamically at runtime.
|
|
410
410
|
|
|
@@ -414,15 +414,15 @@ Replaces the current presets entirely, common use case is changing the preset dy
|
|
|
414
414
|
|
|
415
415
|
Theming ExhaustiveUI with alternative styling approaches.
|
|
416
416
|
|
|
417
|
-
## Architecture
|
|
417
|
+
## Architecture
|
|
418
418
|
|
|
419
419
|
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.
|
|
420
420
|
|
|
421
|
-
## Example
|
|
421
|
+
## Example
|
|
422
422
|
|
|
423
423
|
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.
|
|
424
424
|
|
|
425
|
-
## Global
|
|
425
|
+
## Global
|
|
426
426
|
|
|
427
427
|
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.
|
|
428
428
|
|
|
@@ -445,7 +445,7 @@ export const appConfig: ApplicationConfig = {
|
|
|
445
445
|
};
|
|
446
446
|
```
|
|
447
447
|
|
|
448
|
-
## Setup
|
|
448
|
+
## Setup
|
|
449
449
|
|
|
450
450
|
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.
|
|
451
451
|
|
|
@@ -455,15 +455,15 @@ Unstyled mode is enabled for the whole suite by enabling unstyled option during
|
|
|
455
455
|
|
|
456
456
|
OpenNG Icons is the default icon library of ExhaustiveUI with over 250 open source icons.
|
|
457
457
|
|
|
458
|
-
## Basic
|
|
458
|
+
## Basic
|
|
459
459
|
|
|
460
|
-
OpenNG Icons use the pi pi
|
|
460
|
+
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
|
|
461
461
|
|
|
462
|
-
## Color
|
|
462
|
+
## Color
|
|
463
463
|
|
|
464
464
|
Icon color is defined with the color property which is inherited from parent by default.
|
|
465
465
|
|
|
466
|
-
## Constants
|
|
466
|
+
## Constants
|
|
467
467
|
|
|
468
468
|
Constants API is available to reference icons easily when used programmatically.
|
|
469
469
|
|
|
@@ -493,23 +493,23 @@ export class OpenngIconsConstantsDemo {
|
|
|
493
493
|
}
|
|
494
494
|
```
|
|
495
495
|
|
|
496
|
-
## Download
|
|
496
|
+
## Download
|
|
497
497
|
|
|
498
498
|
The icon library is available at npm, run the following command to download it to your project.
|
|
499
499
|
|
|
500
|
-
## Import
|
|
500
|
+
## Import
|
|
501
501
|
|
|
502
502
|
CSS file of the icon library needs to be imported in styles.scss of your application.
|
|
503
503
|
|
|
504
|
-
## List
|
|
504
|
+
## List
|
|
505
505
|
|
|
506
506
|
Here is the full list of icons. More icons will be added periodically and you may also request new icons at the issue tracker.
|
|
507
507
|
|
|
508
|
-
## Size
|
|
508
|
+
## Size
|
|
509
509
|
|
|
510
510
|
Size of an icon is controlled with the font-size property of the element.
|
|
511
511
|
|
|
512
|
-
## Spin
|
|
512
|
+
## Spin
|
|
513
513
|
|
|
514
514
|
Special pi-spin class applies infinite rotation to an icon.
|
|
515
515
|
|
|
@@ -519,19 +519,19 @@ Special pi-spin class applies infinite rotation to an icon.
|
|
|
519
519
|
|
|
520
520
|
Use custom icons with ExhaustiveUI components.
|
|
521
521
|
|
|
522
|
-
## Fontawesome
|
|
522
|
+
## Fontawesome
|
|
523
523
|
|
|
524
524
|
Font Awesome is a popular icon library with a wide range of icons.
|
|
525
525
|
|
|
526
|
-
## Image
|
|
526
|
+
## Image
|
|
527
527
|
|
|
528
528
|
Any type of image can be used as an icon.
|
|
529
529
|
|
|
530
|
-
## Material
|
|
530
|
+
## Material
|
|
531
531
|
|
|
532
532
|
Material icons is the official icon library based on Google Material Design.
|
|
533
533
|
|
|
534
|
-
## Svg
|
|
534
|
+
## Svg
|
|
535
535
|
|
|
536
536
|
Inline SVGs are embedded inside the dom.
|
|
537
537
|
|
|
@@ -541,31 +541,31 @@ Inline SVGs are embedded inside the dom.
|
|
|
541
541
|
|
|
542
542
|
Pass Through Props allow direct access to the underlying elements for complete customization.
|
|
543
543
|
|
|
544
|
-
## Basic
|
|
544
|
+
## Basic
|
|
545
545
|
|
|
546
546
|
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.
|
|
547
547
|
|
|
548
|
-
## Global
|
|
548
|
+
## Global
|
|
549
549
|
|
|
550
550
|
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.
|
|
551
551
|
|
|
552
|
-
## Instance
|
|
552
|
+
## Instance
|
|
553
553
|
|
|
554
554
|
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.
|
|
555
555
|
|
|
556
|
-
## Introduction
|
|
556
|
+
## Introduction
|
|
557
557
|
|
|
558
558
|
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.
|
|
559
559
|
|
|
560
|
-
## Lifecycle
|
|
560
|
+
## Lifecycle
|
|
561
561
|
|
|
562
562
|
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.
|
|
563
563
|
|
|
564
|
-
## Pcprefix
|
|
564
|
+
## Pcprefix
|
|
565
565
|
|
|
566
566
|
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.
|
|
567
567
|
|
|
568
|
-
## Ptoptions
|
|
568
|
+
## Ptoptions
|
|
569
569
|
|
|
570
570
|
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
|
|
571
571
|
|
|
@@ -575,39 +575,640 @@ The ptOptions property determines how a component's local PassThrough configu
|
|
|
575
575
|
|
|
576
576
|
Integration between ExhaustiveUI and Tailwind CSS.
|
|
577
577
|
|
|
578
|
-
## Animations
|
|
578
|
+
## Animations
|
|
579
579
|
|
|
580
580
|
The plugin also adds extended animation utilities that can be used with the styleclass and animateonscroll directives.
|
|
581
581
|
|
|
582
|
-
|
|
582
|
+
```typescript
|
|
583
|
+
import { Component, OnInit } from '@angular/core';
|
|
584
|
+
import { FormsModule } from '@angular/forms';
|
|
585
|
+
import { SelectModule } from '@exhaustive-ui/core/select';
|
|
586
|
+
|
|
587
|
+
@Component({
|
|
588
|
+
template: `
|
|
589
|
+
<div class="card">
|
|
590
|
+
<p-select [(ngModel)]="animation" [options]="animations" placeholder="Select One" class="w-full sm:w-44" />
|
|
591
|
+
<div class="py-8 overflow-hidden">
|
|
592
|
+
<div [ngClass]="dynamicAnimationClasses"></div>
|
|
593
|
+
</div>
|
|
594
|
+
</div>
|
|
595
|
+
<h3>Animations</h3>
|
|
596
|
+
<div class="doc-tablewrapper">
|
|
597
|
+
<table class="doc-table">
|
|
598
|
+
<thead>
|
|
599
|
+
<tr>
|
|
600
|
+
<th>Class</th>
|
|
601
|
+
<th>Property</th>
|
|
602
|
+
</tr>
|
|
603
|
+
</thead>
|
|
604
|
+
<tbody>
|
|
605
|
+
<tr>
|
|
606
|
+
<td>animate-fadein</td>
|
|
607
|
+
<td>fadein 0.15s linear</td>
|
|
608
|
+
</tr>
|
|
609
|
+
<tr>
|
|
610
|
+
<td>animate-fadeout</td>
|
|
611
|
+
<td>fadeout 0.15s linear</td>
|
|
612
|
+
</tr>
|
|
613
|
+
<tr>
|
|
614
|
+
<td>animate-slidedown</td>
|
|
615
|
+
<td>slidedown 0.45s ease-in-out</td>
|
|
616
|
+
</tr>
|
|
617
|
+
<tr>
|
|
618
|
+
<td>animate-slideup</td>
|
|
619
|
+
<td>slideup 0.45s cubic-bezier(0, 1, 0, 1)</td>
|
|
620
|
+
</tr>
|
|
621
|
+
<tr>
|
|
622
|
+
<td>animate-scalein</td>
|
|
623
|
+
<td>scalein 0.15s linear</td>
|
|
624
|
+
</tr>
|
|
625
|
+
<tr>
|
|
626
|
+
<td>animate-fadeinleft</td>
|
|
627
|
+
<td>fadeinleft 0.15s linear</td>
|
|
628
|
+
</tr>
|
|
629
|
+
<tr>
|
|
630
|
+
<td>animate-fadeoutleft</td>
|
|
631
|
+
<td>fadeoutleft 0.15s linear</td>
|
|
632
|
+
</tr>
|
|
633
|
+
<tr>
|
|
634
|
+
<td>animate-fadeinright</td>
|
|
635
|
+
<td>fadeinright 0.15s linear</td>
|
|
636
|
+
</tr>
|
|
637
|
+
<tr>
|
|
638
|
+
<td>animate-fadeoutright</td>
|
|
639
|
+
<td>fadeoutright 0.15s linear</td>
|
|
640
|
+
</tr>
|
|
641
|
+
<tr>
|
|
642
|
+
<td>animate-fadeinup</td>
|
|
643
|
+
<td>fadeinup 0.15s linear</td>
|
|
644
|
+
</tr>
|
|
645
|
+
<tr>
|
|
646
|
+
<td>animate-fadeoutup</td>
|
|
647
|
+
<td>fadeoutup 0.15s linear</td>
|
|
648
|
+
</tr>
|
|
649
|
+
<tr>
|
|
650
|
+
<td>animate-fadeindown</td>
|
|
651
|
+
<td>fadeindown 0.15s linear</td>
|
|
652
|
+
</tr>
|
|
653
|
+
<tr>
|
|
654
|
+
<td>animate-fadeoutup</td>
|
|
655
|
+
<td>fadeoutup 0.15s linear</td>
|
|
656
|
+
</tr>
|
|
657
|
+
<tr>
|
|
658
|
+
<td>animate-width</td>
|
|
659
|
+
<td>width 0.15s linear</td>
|
|
660
|
+
</tr>
|
|
661
|
+
<tr>
|
|
662
|
+
<td>animate-flip</td>
|
|
663
|
+
<td>flip 0.15s linear</td>
|
|
664
|
+
</tr>
|
|
665
|
+
<tr>
|
|
666
|
+
<td>animate-flipup</td>
|
|
667
|
+
<td>flipup 0.15s linear</td>
|
|
668
|
+
</tr>
|
|
669
|
+
<tr>
|
|
670
|
+
<td>animate-flipleft</td>
|
|
671
|
+
<td>fadein 0.15s linear</td>
|
|
672
|
+
</tr>
|
|
673
|
+
<tr>
|
|
674
|
+
<td>animate-flipright</td>
|
|
675
|
+
<td>flipright 0.15s linear</td>
|
|
676
|
+
</tr>
|
|
677
|
+
<tr>
|
|
678
|
+
<td>animate-zoomin</td>
|
|
679
|
+
<td>zoomin 0.15s linear</td>
|
|
680
|
+
</tr>
|
|
681
|
+
<tr>
|
|
682
|
+
<td>animate-zoomindown</td>
|
|
683
|
+
<td>zoomindown 0.15s linear</td>
|
|
684
|
+
</tr>
|
|
685
|
+
<tr>
|
|
686
|
+
<td>animate-zoominleft</td>
|
|
687
|
+
<td>zoominleft 0.15s linear</td>
|
|
688
|
+
</tr>
|
|
689
|
+
<tr>
|
|
690
|
+
<td>animate-zoominright</td>
|
|
691
|
+
<td>zoominright 0.15s linear</td>
|
|
692
|
+
</tr>
|
|
693
|
+
<tr>
|
|
694
|
+
<td>animate-zoominup</td>
|
|
695
|
+
<td>zoominup 0.15s linear</td>
|
|
696
|
+
</tr>
|
|
697
|
+
</tbody>
|
|
698
|
+
</table>
|
|
699
|
+
</div>
|
|
700
|
+
<h3>Animation Duration</h3>
|
|
701
|
+
<div class="doc-tablewrapper">
|
|
702
|
+
<table class="doc-table">
|
|
703
|
+
<thead>
|
|
704
|
+
<tr>
|
|
705
|
+
<th>Class</th>
|
|
706
|
+
<th>Property</th>
|
|
707
|
+
</tr>
|
|
708
|
+
</thead>
|
|
709
|
+
<tbody>
|
|
710
|
+
<tr>
|
|
711
|
+
<td>animate-duration-0</td>
|
|
712
|
+
<td>animation-duration: 0s</td>
|
|
713
|
+
</tr>
|
|
714
|
+
<tr>
|
|
715
|
+
<td>animate-duration-75</td>
|
|
716
|
+
<td>animation-duration: 75ms</td>
|
|
717
|
+
</tr>
|
|
718
|
+
<tr>
|
|
719
|
+
<td>animate-duration-100</td>
|
|
720
|
+
<td>animation-duration: 100ms</td>
|
|
721
|
+
</tr>
|
|
722
|
+
<tr>
|
|
723
|
+
<td>animate-duration-200</td>
|
|
724
|
+
<td>animation-duration: 200ms</td>
|
|
725
|
+
</tr>
|
|
726
|
+
<tr>
|
|
727
|
+
<td>animate-duration-300</td>
|
|
728
|
+
<td>animation-duration: 300ms</td>
|
|
729
|
+
</tr>
|
|
730
|
+
<tr>
|
|
731
|
+
<td>animate-duration-400</td>
|
|
732
|
+
<td>animation-duration: 400ms</td>
|
|
733
|
+
</tr>
|
|
734
|
+
<tr>
|
|
735
|
+
<td>animate-duration-500</td>
|
|
736
|
+
<td>animation-duration: 500ms</td>
|
|
737
|
+
</tr>
|
|
738
|
+
<tr>
|
|
739
|
+
<td>animate-duration-700</td>
|
|
740
|
+
<td>animation-duration: 700ms</td>
|
|
741
|
+
</tr>
|
|
742
|
+
<tr>
|
|
743
|
+
<td>animate-duration-1000</td>
|
|
744
|
+
<td>animation-duration: 1000ms</td>
|
|
745
|
+
</tr>
|
|
746
|
+
<tr>
|
|
747
|
+
<td>animate-duration-2000</td>
|
|
748
|
+
<td>animation-duration: 2000ms</td>
|
|
749
|
+
</tr>
|
|
750
|
+
<tr>
|
|
751
|
+
<td>animate-duration-3000</td>
|
|
752
|
+
<td>animation-duration: 300ms</td>
|
|
753
|
+
</tr>
|
|
754
|
+
</tbody>
|
|
755
|
+
</table>
|
|
756
|
+
</div>
|
|
757
|
+
<h3>Animation Delay</h3>
|
|
758
|
+
<div class="doc-tablewrapper">
|
|
759
|
+
<table class="doc-table">
|
|
760
|
+
<thead>
|
|
761
|
+
<tr>
|
|
762
|
+
<th>Class</th>
|
|
763
|
+
<th>Property</th>
|
|
764
|
+
</tr>
|
|
765
|
+
</thead>
|
|
766
|
+
<tbody>
|
|
767
|
+
<tr>
|
|
768
|
+
<td>animate-delay-none</td>
|
|
769
|
+
<td>animation-duration: 0s</td>
|
|
770
|
+
</tr>
|
|
771
|
+
<tr>
|
|
772
|
+
<td>animate-delay-75</td>
|
|
773
|
+
<td>animation-delay: 75ms</td>
|
|
774
|
+
</tr>
|
|
775
|
+
<tr>
|
|
776
|
+
<td>animate-delay-100</td>
|
|
777
|
+
<td>animation-delay: 100ms</td>
|
|
778
|
+
</tr>
|
|
779
|
+
<tr>
|
|
780
|
+
<td>animate-delay-150</td>
|
|
781
|
+
<td>animation-delay: 150ms</td>
|
|
782
|
+
</tr>
|
|
783
|
+
<tr>
|
|
784
|
+
<td>animate-delay-200</td>
|
|
785
|
+
<td>animation-delay: 200ms</td>
|
|
786
|
+
</tr>
|
|
787
|
+
<tr>
|
|
788
|
+
<td>animate-delay-300</td>
|
|
789
|
+
<td>animation-delay: 300ms</td>
|
|
790
|
+
</tr>
|
|
791
|
+
<tr>
|
|
792
|
+
<td>animate-delay-400</td>
|
|
793
|
+
<td>animation-delay: 400ms</td>
|
|
794
|
+
</tr>
|
|
795
|
+
<tr>
|
|
796
|
+
<td>animate-delay-500</td>
|
|
797
|
+
<td>animation-delay: 500ms</td>
|
|
798
|
+
</tr>
|
|
799
|
+
<tr>
|
|
800
|
+
<td>animate-delay-700</td>
|
|
801
|
+
<td>animation-delay: 700ms</td>
|
|
802
|
+
</tr>
|
|
803
|
+
<tr>
|
|
804
|
+
<td>animate-delay-1000</td>
|
|
805
|
+
<td>animation-delay: 1000ms</td>
|
|
806
|
+
</tr>
|
|
807
|
+
</tbody>
|
|
808
|
+
</table>
|
|
809
|
+
</div>
|
|
810
|
+
<h3>Iteration Count</h3>
|
|
811
|
+
<div class="doc-tablewrapper">
|
|
812
|
+
<table class="doc-table">
|
|
813
|
+
<thead>
|
|
814
|
+
<tr>
|
|
815
|
+
<th>Class</th>
|
|
816
|
+
<th>Property</th>
|
|
817
|
+
</tr>
|
|
818
|
+
</thead>
|
|
819
|
+
<tbody>
|
|
820
|
+
<tr>
|
|
821
|
+
<td>animate-infinite</td>
|
|
822
|
+
<td>animation-iteration-count: infinite</td>
|
|
823
|
+
</tr>
|
|
824
|
+
<tr>
|
|
825
|
+
<td>animate-once</td>
|
|
826
|
+
<td>animation-iteration-count: 1</td>
|
|
827
|
+
</tr>
|
|
828
|
+
<tr>
|
|
829
|
+
<td>animate-twice</td>
|
|
830
|
+
<td>animation-iteration-count: 2</td>
|
|
831
|
+
</tr>
|
|
832
|
+
</tbody>
|
|
833
|
+
</table>
|
|
834
|
+
</div>
|
|
835
|
+
<h3>Direction</h3>
|
|
836
|
+
<div class="doc-tablewrapper">
|
|
837
|
+
<table class="doc-table">
|
|
838
|
+
<thead>
|
|
839
|
+
<tr>
|
|
840
|
+
<th>Class</th>
|
|
841
|
+
<th>Property</th>
|
|
842
|
+
</tr>
|
|
843
|
+
</thead>
|
|
844
|
+
<tbody>
|
|
845
|
+
<tr>
|
|
846
|
+
<td>animate-normal</td>
|
|
847
|
+
<td>animation-direction: normal</td>
|
|
848
|
+
</tr>
|
|
849
|
+
<tr>
|
|
850
|
+
<td>animate-reverse</td>
|
|
851
|
+
<td>animation-direction: reverse</td>
|
|
852
|
+
</tr>
|
|
853
|
+
<tr>
|
|
854
|
+
<td>animate-alternate</td>
|
|
855
|
+
<td>animation-direction: alternate</td>
|
|
856
|
+
</tr>
|
|
857
|
+
<tr>
|
|
858
|
+
<td>animate-alternate-reverse</td>
|
|
859
|
+
<td>animation-direction: alternate-reverse</td>
|
|
860
|
+
</tr>
|
|
861
|
+
</tbody>
|
|
862
|
+
</table>
|
|
863
|
+
</div>
|
|
864
|
+
<h3>Timing Function</h3>
|
|
865
|
+
<div class="doc-tablewrapper">
|
|
866
|
+
<table class="doc-table">
|
|
867
|
+
<thead>
|
|
868
|
+
<tr>
|
|
869
|
+
<th>Class</th>
|
|
870
|
+
<th>Property</th>
|
|
871
|
+
</tr>
|
|
872
|
+
</thead>
|
|
873
|
+
<tbody>
|
|
874
|
+
<tr>
|
|
875
|
+
<td>animate-ease-linear</td>
|
|
876
|
+
<td>animation-timing-function: linear</td>
|
|
877
|
+
</tr>
|
|
878
|
+
<tr>
|
|
879
|
+
<td>animate-ease-in</td>
|
|
880
|
+
<td>animation-timing-function: cubic-bezier(0.4, 0, 1, 1)</td>
|
|
881
|
+
</tr>
|
|
882
|
+
<tr>
|
|
883
|
+
<td>animate-ease-out</td>
|
|
884
|
+
<td>animation-timing-function: cubic-bezier(0, 0, 0.2, 1)</td>
|
|
885
|
+
</tr>
|
|
886
|
+
<tr>
|
|
887
|
+
<td>animate-ease-in-out</td>
|
|
888
|
+
<td>animation-timing-function: cubic-bezier(0.4, 0, 0.2, 1)</td>
|
|
889
|
+
</tr>
|
|
890
|
+
</tbody>
|
|
891
|
+
</table>
|
|
892
|
+
</div>
|
|
893
|
+
<h3>Fill Mode</h3>
|
|
894
|
+
<div class="doc-tablewrapper">
|
|
895
|
+
<table class="doc-table">
|
|
896
|
+
<thead>
|
|
897
|
+
<tr>
|
|
898
|
+
<th>Class</th>
|
|
899
|
+
<th>Property</th>
|
|
900
|
+
</tr>
|
|
901
|
+
</thead>
|
|
902
|
+
<tbody>
|
|
903
|
+
<tr>
|
|
904
|
+
<td>animate-fill-none</td>
|
|
905
|
+
<td>animation-fill-mode: normal</td>
|
|
906
|
+
</tr>
|
|
907
|
+
<tr>
|
|
908
|
+
<td>animate-fill-forwards</td>
|
|
909
|
+
<td>animation-fill-mode: forwards</td>
|
|
910
|
+
</tr>
|
|
911
|
+
<tr>
|
|
912
|
+
<td>animate-fill-backwards</td>
|
|
913
|
+
<td>animation-fill-mode: backwards</td>
|
|
914
|
+
</tr>
|
|
915
|
+
<tr>
|
|
916
|
+
<td>animate-fill-both</td>
|
|
917
|
+
<td>animation-fill-mode: both</td>
|
|
918
|
+
</tr>
|
|
919
|
+
</tbody>
|
|
920
|
+
</table>
|
|
921
|
+
</div>
|
|
922
|
+
<h3>Play State</h3>
|
|
923
|
+
<div class="doc-tablewrapper">
|
|
924
|
+
<table class="doc-table">
|
|
925
|
+
<thead>
|
|
926
|
+
<tr>
|
|
927
|
+
<th>Class</th>
|
|
928
|
+
<th>Property</th>
|
|
929
|
+
</tr>
|
|
930
|
+
</thead>
|
|
931
|
+
<tbody>
|
|
932
|
+
<tr>
|
|
933
|
+
<td>animate-running</td>
|
|
934
|
+
<td>animation-play-state: running</td>
|
|
935
|
+
</tr>
|
|
936
|
+
<tr>
|
|
937
|
+
<td>animate-paused</td>
|
|
938
|
+
<td>animation-play-state: paused</td>
|
|
939
|
+
</tr>
|
|
940
|
+
</tbody>
|
|
941
|
+
</table>
|
|
942
|
+
</div>
|
|
943
|
+
<h3>Backface Visibility State</h3>
|
|
944
|
+
<div class="doc-tablewrapper">
|
|
945
|
+
<table class="doc-table">
|
|
946
|
+
<thead>
|
|
947
|
+
<tr>
|
|
948
|
+
<th>Class</th>
|
|
949
|
+
<th>Property</th>
|
|
950
|
+
</tr>
|
|
951
|
+
</thead>
|
|
952
|
+
<tbody>
|
|
953
|
+
<tr>
|
|
954
|
+
<td>backface-visible</td>
|
|
955
|
+
<td>backface-visibility: visible</td>
|
|
956
|
+
</tr>
|
|
957
|
+
<tr>
|
|
958
|
+
<td>backface-hidden</td>
|
|
959
|
+
<td>backface-visibility: hidden</td>
|
|
960
|
+
</tr>
|
|
961
|
+
</tbody>
|
|
962
|
+
</table>
|
|
963
|
+
</div>
|
|
964
|
+
`,
|
|
965
|
+
standalone: true,
|
|
966
|
+
imports: [SelectModule, FormsModule]
|
|
967
|
+
})
|
|
968
|
+
export class TailwindAnimationsDemo implements OnInit {
|
|
969
|
+
animation: any = null;
|
|
970
|
+
|
|
971
|
+
ngOnInit() {
|
|
972
|
+
this.animations = [
|
|
973
|
+
'fadein',
|
|
974
|
+
'fadeout',
|
|
975
|
+
'slideup',
|
|
976
|
+
'scalein',
|
|
977
|
+
'fadeinleft',
|
|
978
|
+
'fadeoutleft',
|
|
979
|
+
'fadeinright',
|
|
980
|
+
'fadeoutright',
|
|
981
|
+
'fadeinup',
|
|
982
|
+
'fadeoutup',
|
|
983
|
+
'width',
|
|
984
|
+
'flipup',
|
|
985
|
+
'flipleft',
|
|
986
|
+
'flipright',
|
|
987
|
+
'zoomin',
|
|
988
|
+
'zoomindown',
|
|
989
|
+
'zoominleft',
|
|
990
|
+
'zoominright',
|
|
991
|
+
'zoominup'
|
|
992
|
+
];
|
|
993
|
+
}
|
|
994
|
+
}
|
|
995
|
+
```
|
|
996
|
+
|
|
997
|
+
## Colorpalette
|
|
583
998
|
|
|
584
999
|
ExhaustiveUI color palette as utility classes.
|
|
585
1000
|
|
|
586
|
-
|
|
1001
|
+
```typescript
|
|
1002
|
+
import { Component } from '@angular/core';
|
|
1003
|
+
|
|
1004
|
+
@Component({
|
|
1005
|
+
template: `
|
|
1006
|
+
<div class="card">
|
|
1007
|
+
<div class="flex flex-col gap-12">
|
|
1008
|
+
<ul class="p-0 m-0 list-none flex sm:flex-col gap-4 flex-wrap sm:flex-nowrap">
|
|
1009
|
+
<li *ngFor="let color of colors; let i = index" [ngStyle]="{ 'min-width': '6rem' }" class="flex-auto">
|
|
1010
|
+
<span class="font-medium capitalize block mb-2 text-center sm:text-left">{{ color }}</span>
|
|
1011
|
+
<div class="flex gap-4 flex-auto flex-col sm:flex-row">
|
|
1012
|
+
<div *ngFor="let shade of shades" [ngClass]="{ invisible: color === 'primary' && shade === 0 }" class="flex flex-col items-center gap-1 flex-1">
|
|
1013
|
+
<div class="rounded h-8 w-full" [ngStyle]="{ 'background-color': 'var(--p-' + color + '-' + shade + ')' }"></div>
|
|
1014
|
+
<span class="text-sm text-surface-500 dark:text-surface-400 font-medium">{{ shade }}</span>
|
|
1015
|
+
</div>
|
|
1016
|
+
</div>
|
|
1017
|
+
</li>
|
|
1018
|
+
</ul>
|
|
1019
|
+
<div class="flex gap-6 flex-wrap">
|
|
1020
|
+
<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>
|
|
1021
|
+
<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>
|
|
1022
|
+
<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>
|
|
1023
|
+
</div>
|
|
1024
|
+
</div>
|
|
1025
|
+
</div>
|
|
1026
|
+
`,
|
|
1027
|
+
standalone: true,
|
|
1028
|
+
imports: []
|
|
1029
|
+
})
|
|
1030
|
+
export class TailwindColorpaletteDemo {
|
|
1031
|
+
shades: number[] = [0, 50, 100, 200, 300, 400, 500, 600, 700, 800, 900, 950];
|
|
1032
|
+
colors: string[] = ['primary', 'surface'];
|
|
1033
|
+
}
|
|
1034
|
+
```
|
|
1035
|
+
|
|
1036
|
+
## Darkmode
|
|
587
1037
|
|
|
588
1038
|
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.
|
|
589
1039
|
|
|
590
|
-
## Extensions
|
|
1040
|
+
## Extensions
|
|
591
1041
|
|
|
592
1042
|
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.
|
|
593
1043
|
|
|
594
|
-
## Form
|
|
1044
|
+
## Form
|
|
595
1045
|
|
|
596
1046
|
Using Tailwind utilities for the responsive layout of a form with ExhaustiveUI components.
|
|
597
1047
|
|
|
598
|
-
|
|
1048
|
+
```typescript
|
|
1049
|
+
import { Component, OnInit } from '@angular/core';
|
|
1050
|
+
import { FormsModule } from '@angular/forms';
|
|
1051
|
+
import { DatePickerModule } from '@exhaustive-ui/core/datepicker';
|
|
1052
|
+
import { SelectModule } from '@exhaustive-ui/core/select';
|
|
1053
|
+
import { InputTextModule } from '@exhaustive-ui/core/inputtext';
|
|
1054
|
+
import { Country } from '@/domain/customer';
|
|
1055
|
+
|
|
1056
|
+
@Component({
|
|
1057
|
+
template: `
|
|
1058
|
+
<div class="card flex sm:justify-center">
|
|
1059
|
+
<div class="flex flex-col gap-6 w-full sm:w-auto">
|
|
1060
|
+
<div class="flex flex-col sm:flex-row sm:items-center gap-6">
|
|
1061
|
+
<div class="flex-auto">
|
|
1062
|
+
<label for="firstname" class="block font-semibold mb-2">Firstname</label>
|
|
1063
|
+
<input type="text" pInputText id="firstname" class="w-full" />
|
|
1064
|
+
</div>
|
|
1065
|
+
<div class="flex-auto">
|
|
1066
|
+
<label for="lastname" class="block font-semibold mb-2">Lastname</label>
|
|
1067
|
+
<input type="text" pInputText id="lastname" class="w-full" />
|
|
1068
|
+
</div>
|
|
1069
|
+
</div>
|
|
1070
|
+
<div class="flex flex-col sm:flex-row sm:items-center gap-6">
|
|
1071
|
+
<div class="flex-1">
|
|
1072
|
+
<label for="date" class="block font-semibold mb-2">Date</label>
|
|
1073
|
+
<p-datepicker inputId="date" class="w-full" />
|
|
1074
|
+
</div>
|
|
1075
|
+
<div class="flex-1">
|
|
1076
|
+
<label for="country" class="block font-semibold mb-2">Country</label>
|
|
1077
|
+
<p-select [options]="countries" [(ngModel)]="selectedCountry" optionLabel="name" [showClear]="true" placeholder="Select a Country">
|
|
1078
|
+
<ng-template pTemplate="selectedItem">
|
|
1079
|
+
<div class="flex items-center gap-2" *ngIf="selectedCountry">
|
|
1080
|
+
<img src="https://exhaustive-ui.com/demo/flag/flag_placeholder.png" [class]="'flag flag-' + selectedCountry.code.toLowerCase()" style="width: 18px" />
|
|
1081
|
+
<div>{{ selectedCountry.name }}</div>
|
|
1082
|
+
</div>
|
|
1083
|
+
</ng-template>
|
|
1084
|
+
<ng-template let-country pTemplate="item">
|
|
1085
|
+
<div class="flex items-center gap-2">
|
|
1086
|
+
<img src="https://exhaustive-ui.com/demo/flag/flag_placeholder.png" [class]="'flag flag-' + country.code.toLowerCase()" style="width: 18px" />
|
|
1087
|
+
<div>{{ country.name }}</div>
|
|
1088
|
+
</div>
|
|
1089
|
+
</ng-template>
|
|
1090
|
+
</p-select>
|
|
1091
|
+
</div>
|
|
1092
|
+
</div>
|
|
1093
|
+
<div class="flex-auto">
|
|
1094
|
+
<label for="message" class="block font-semibold mb-2">Message</label>
|
|
1095
|
+
<textarea pTextarea id="message" class="w-full" rows="4"></textarea>
|
|
1096
|
+
</div>
|
|
1097
|
+
</div>
|
|
1098
|
+
</div>
|
|
1099
|
+
`,
|
|
1100
|
+
standalone: true,
|
|
1101
|
+
imports: [DatePickerModule, SelectModule, InputTextModule, FormsModule]
|
|
1102
|
+
})
|
|
1103
|
+
export class TailwindFormDemo implements OnInit {
|
|
1104
|
+
countries: any[] | undefined;
|
|
1105
|
+
selectedCountry: string | undefined;
|
|
1106
|
+
|
|
1107
|
+
ngOnInit() {
|
|
1108
|
+
this.countries = [
|
|
1109
|
+
{ name: 'Australia', code: 'AU' },
|
|
1110
|
+
{ name: 'Brazil', code: 'BR' },
|
|
1111
|
+
{ name: 'China', code: 'CN' },
|
|
1112
|
+
{ name: 'Egypt', code: 'EG' },
|
|
1113
|
+
{ name: 'France', code: 'FR' },
|
|
1114
|
+
{ name: 'Germany', code: 'DE' },
|
|
1115
|
+
{ name: 'India', code: 'IN' },
|
|
1116
|
+
{ name: 'Japan', code: 'JP' },
|
|
1117
|
+
{ name: 'Spain', code: 'ES' },
|
|
1118
|
+
{ name: 'United States', code: 'US' }
|
|
1119
|
+
];
|
|
1120
|
+
}
|
|
1121
|
+
}
|
|
1122
|
+
```
|
|
1123
|
+
|
|
1124
|
+
## Headless
|
|
599
1125
|
|
|
600
1126
|
A headless ExhaustiveUI dialog with a custom UI.
|
|
601
1127
|
|
|
602
|
-
|
|
1128
|
+
```typescript
|
|
1129
|
+
import { Component } from '@angular/core';
|
|
1130
|
+
import { ButtonModule } from '@exhaustive-ui/core/button';
|
|
1131
|
+
import { DialogModule } from '@exhaustive-ui/core/dialog';
|
|
1132
|
+
import { InputTextModule } from '@exhaustive-ui/core/inputtext';
|
|
1133
|
+
|
|
1134
|
+
@Component({
|
|
1135
|
+
template: `
|
|
1136
|
+
<div class="card flex justify-center">
|
|
1137
|
+
<p-button (click)="showDialog()" icon="pi pi-user" label="Login" />
|
|
1138
|
+
<p-dialog maskStyleClass="backdrop-blur-sm" [(visible)]="visible" styleClass="!border-0 !bg-transparent">
|
|
1139
|
+
<ng-template pTemplate="headless">
|
|
1140
|
+
<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))">
|
|
1141
|
+
<svg width="31" height="33" viewBox="0 0 31 33" fill="none" xmlns="http://www.w3.org/2000/svg" class="block mx-auto">
|
|
1142
|
+
<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)" />
|
|
1143
|
+
<mask id="mask0_1_52" style="mask-type:luminance" maskUnits="userSpaceOnUse" x="0" y="0" width="31" height="33">
|
|
1144
|
+
<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)" />
|
|
1145
|
+
</mask>
|
|
1146
|
+
<g mask="url(#mask0_1_52)">
|
|
1147
|
+
<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)" />
|
|
1148
|
+
</g>
|
|
1149
|
+
<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)" />
|
|
1150
|
+
<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)" />
|
|
1151
|
+
<path
|
|
1152
|
+
fill-rule="evenodd"
|
|
1153
|
+
clip-rule="evenodd"
|
|
1154
|
+
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"
|
|
1155
|
+
fill="var(--ground-background)"
|
|
1156
|
+
/>
|
|
1157
|
+
<path d="M19.3168 24.7437L21.4168 22.6444V20.5451L19.3168 22.3214V24.7437Z" fill="var(--ground-background)" />
|
|
1158
|
+
<path d="M10.9166 24.7437L8.81662 22.6444V20.5451L10.9166 22.3214V24.7437Z" fill="var(--ground-background)" />
|
|
1159
|
+
<path
|
|
1160
|
+
fill-rule="evenodd"
|
|
1161
|
+
clip-rule="evenodd"
|
|
1162
|
+
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"
|
|
1163
|
+
fill="var(--ground-background)"
|
|
1164
|
+
/>
|
|
1165
|
+
<path d="M13.8244 14.8932L6.87813 12.3094L5.90888 8.27235L11.8859 8.7568L13.9859 14.8932H13.8244Z" fill="var(--ground-background)" />
|
|
1166
|
+
<path d="M16.5706 14.8932L23.5169 12.3094L24.4861 8.27235L18.3476 8.7568L16.4091 14.8932H16.5706Z" fill="var(--ground-background)" />
|
|
1167
|
+
<path d="M18.8321 8.27235L22.2245 7.94938L19.9629 5.68861H17.7013L18.8321 8.27235Z" fill="var(--ground-background)" />
|
|
1168
|
+
<path d="M11.4013 8.27235L8.00893 7.94938L10.2705 5.68861H12.5321L11.4013 8.27235Z" fill="var(--ground-background)" />
|
|
1169
|
+
</svg>
|
|
1170
|
+
<div class="inline-flex flex-col gap-2">
|
|
1171
|
+
<label for="username" class="text-primary-50 font-semibold">Username</label>
|
|
1172
|
+
<input pInputText id="username" class="!bg-white/20 !border-0 !p-4 !text-primary-50 w-80" />
|
|
1173
|
+
</div>
|
|
1174
|
+
<div class="inline-flex flex-col gap-2">
|
|
1175
|
+
<label for="password" class="text-primary-50 font-semibold">Password</label>
|
|
1176
|
+
<input pInputText id="password" class="!bg-white/20 !border-0 !p-4 !text-primary-50 w-80" type="password" />
|
|
1177
|
+
</div>
|
|
1178
|
+
<div class="flex items-center gap-4">
|
|
1179
|
+
<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" />
|
|
1180
|
+
<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" />
|
|
1181
|
+
</div>
|
|
1182
|
+
</div>
|
|
1183
|
+
</ng-template>
|
|
1184
|
+
</p-dialog>
|
|
1185
|
+
</div>
|
|
1186
|
+
`,
|
|
1187
|
+
standalone: true,
|
|
1188
|
+
imports: [ButtonModule, DialogModule, InputTextModule]
|
|
1189
|
+
})
|
|
1190
|
+
export class TailwindHeadlessDemo {
|
|
1191
|
+
visible: boolean = false;
|
|
1192
|
+
|
|
1193
|
+
showDialog() {
|
|
1194
|
+
this.visible = true;
|
|
1195
|
+
}
|
|
1196
|
+
|
|
1197
|
+
closeDialog() {
|
|
1198
|
+
this.visible = false;
|
|
1199
|
+
}
|
|
1200
|
+
}
|
|
1201
|
+
```
|
|
1202
|
+
|
|
1203
|
+
## Override
|
|
603
1204
|
|
|
604
1205
|
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 ! as a prefix to enforce the styling. 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.
|
|
605
1206
|
|
|
606
|
-
## Overview
|
|
1207
|
+
## Overview
|
|
607
1208
|
|
|
608
1209
|
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.
|
|
609
1210
|
|
|
610
|
-
## Plugin
|
|
1211
|
+
## Plugin
|
|
611
1212
|
|
|
612
1213
|
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, 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.
|
|
613
1214
|
|
|
@@ -617,19 +1218,19 @@ The @exhaustive-ui/tailwindcss is a plugin to provide first class integration be
|
|
|
617
1218
|
|
|
618
1219
|
LLM-optimized documentation endpoints for ExhaustiveUI components.
|
|
619
1220
|
|
|
620
|
-
## Agentskill
|
|
1221
|
+
## Agentskill
|
|
621
1222
|
|
|
622
1223
|
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.
|
|
623
1224
|
|
|
624
|
-
## Llmsfulltxt
|
|
1225
|
+
## Llmsfulltxt
|
|
625
1226
|
|
|
626
1227
|
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.
|
|
627
1228
|
|
|
628
|
-
## Llmstxt
|
|
1229
|
+
## Llmstxt
|
|
629
1230
|
|
|
630
1231
|
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.
|
|
631
1232
|
|
|
632
|
-
## Manifest
|
|
1233
|
+
## Manifest
|
|
633
1234
|
|
|
634
1235
|
/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.
|
|
635
1236
|
|
|
@@ -659,13 +1260,13 @@ The llms.txt file is an industry standard that helps AI models better understand
|
|
|
659
1260
|
}
|
|
660
1261
|
```
|
|
661
1262
|
|
|
662
|
-
## Markdownextension
|
|
1263
|
+
## Markdownextension
|
|
663
1264
|
|
|
664
1265
|
Add a .md to a page's URL to display a Markdown version of that page.
|
|
665
1266
|
|
|
666
|
-
## Mcp
|
|
1267
|
+
## Mcp
|
|
667
1268
|
|
|
668
|
-
|
|
1269
|
+
@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.
|
|
669
1270
|
|
|
670
1271
|
---
|
|
671
1272
|
|
|
@@ -673,27 +1274,27 @@ Add a .md to a page's URL to display a Markdown version of that page.
|
|
|
673
1274
|
|
|
674
1275
|
ExhaustiveUI has WCAG 2.1 AA level compliance.
|
|
675
1276
|
|
|
676
|
-
## Colors
|
|
1277
|
+
## Colors
|
|
677
1278
|
|
|
678
1279
|
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
|
|
679
1280
|
|
|
680
|
-
## Formcontrols
|
|
1281
|
+
## Formcontrols
|
|
681
1282
|
|
|
682
1283
|
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.
|
|
683
1284
|
|
|
684
|
-
## Introduction
|
|
1285
|
+
## Introduction
|
|
685
1286
|
|
|
686
1287
|
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.
|
|
687
1288
|
|
|
688
|
-
## Semantichtml
|
|
1289
|
+
## Semantichtml
|
|
689
1290
|
|
|
690
1291
|
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.
|
|
691
1292
|
|
|
692
|
-
## Waiaria
|
|
1293
|
+
## Waiaria
|
|
693
1294
|
|
|
694
1295
|
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-sr-only 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
|
|
695
1296
|
|
|
696
|
-
## Wcag
|
|
1297
|
+
## Wcag
|
|
697
1298
|
|
|
698
1299
|
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.
|
|
699
1300
|
|
|
@@ -703,27 +1304,27 @@ WCAG refers to Web Content Accessibility Guideline , a standard managed by the W
|
|
|
703
1304
|
|
|
704
1305
|
Built-in CSS animations for ExhaustiveUI components.
|
|
705
1306
|
|
|
706
|
-
## Anchoredoverlays
|
|
1307
|
+
## Anchoredoverlays
|
|
707
1308
|
|
|
708
1309
|
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.
|
|
709
1310
|
|
|
710
|
-
## Collapsibles
|
|
1311
|
+
## Collapsibles
|
|
711
1312
|
|
|
712
1313
|
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.
|
|
713
1314
|
|
|
714
|
-
## Dialog
|
|
1315
|
+
## Dialog
|
|
715
1316
|
|
|
716
1317
|
Overlays such as Dialog and Drawer are positioned relative to the viewport and have their own animations. Update your information. Username Email
|
|
717
1318
|
|
|
718
|
-
## Disable
|
|
1319
|
+
## Disable
|
|
719
1320
|
|
|
720
1321
|
Individual animations can be reduced and even disabled completely using the animation duration.
|
|
721
1322
|
|
|
722
|
-
## Introduction
|
|
1323
|
+
## Introduction
|
|
723
1324
|
|
|
724
|
-
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
|
|
1325
|
+
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.
|
|
725
1326
|
|
|
726
|
-
## Reference
|
|
1327
|
+
## Reference
|
|
727
1328
|
|
|
728
1329
|
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
|
|
729
1330
|
|
|
@@ -733,11 +1334,11 @@ List of class names of the CSS animations used by the components. Component Ente
|
|
|
733
1334
|
|
|
734
1335
|
Right-to-left support for ExhaustiveUI components.
|
|
735
1336
|
|
|
736
|
-
## Configuration
|
|
1337
|
+
## Configuration
|
|
737
1338
|
|
|
738
1339
|
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.
|
|
739
1340
|
|
|
740
|
-
## Limitations
|
|
1341
|
+
## Limitations
|
|
741
1342
|
|
|
742
1343
|
RTL is widely supported by the UI suite except the Galleria and Carousel components. These components will be enhanced with a modern implementation in upcoming versions with built-in support for RTL.
|
|
743
1344
|
|
|
@@ -747,21 +1348,21 @@ RTL is widely supported by the UI suite except the Galleria and Carousel compone
|
|
|
747
1348
|
|
|
748
1349
|
Moving from PrimeFlex to Tailwind CSS.
|
|
749
1350
|
|
|
750
|
-
## Compatibility
|
|
1351
|
+
## Compatibility
|
|
751
1352
|
|
|
752
1353
|
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.
|
|
753
1354
|
|
|
754
|
-
## Migration
|
|
1355
|
+
## Migration
|
|
755
1356
|
|
|
756
1357
|
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. 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
|
|
757
1358
|
|
|
758
|
-
## Overview
|
|
1359
|
+
## Overview
|
|
759
1360
|
|
|
760
1361
|
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.
|
|
761
1362
|
|
|
762
|
-
## Tailwindcss
|
|
1363
|
+
## Tailwindcss
|
|
763
1364
|
|
|
764
|
-
Tailwind CSS is the replacement we suggest. This documentation site is itself built with it, and we publish
|
|
1365
|
+
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.
|
|
765
1366
|
|
|
766
1367
|
---
|
|
767
1368
|
|
|
@@ -769,27 +1370,27 @@ Tailwind CSS is the replacement we suggest. This documentation site is itself bu
|
|
|
769
1370
|
|
|
770
1371
|
Why ExhaustiveUI exists, what it commits to, and where it stops.
|
|
771
1372
|
|
|
772
|
-
## Governance
|
|
1373
|
+
## Governance
|
|
773
1374
|
|
|
774
1375
|
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.
|
|
775
1376
|
|
|
776
|
-
## Limits
|
|
1377
|
+
## Limits
|
|
777
1378
|
|
|
778
1379
|
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 .
|
|
779
1380
|
|
|
780
|
-
## Origin
|
|
1381
|
+
## Origin
|
|
781
1382
|
|
|
782
1383
|
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.
|
|
783
1384
|
|
|
784
|
-
## Promises
|
|
1385
|
+
## Promises
|
|
785
1386
|
|
|
786
1387
|
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.
|
|
787
1388
|
|
|
788
|
-
## Sustainability
|
|
1389
|
+
## Sustainability
|
|
789
1390
|
|
|
790
1391
|
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.
|
|
791
1392
|
|
|
792
|
-
## Trademark
|
|
1393
|
+
## Trademark
|
|
793
1394
|
|
|
794
1395
|
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.
|
|
795
1396
|
|
|
@@ -799,41 +1400,67 @@ ExhaustiveUI is not affiliated with, endorsed by, or sponsored by PrimeTek. Prim
|
|
|
799
1400
|
|
|
800
1401
|
Licensing, migration from PrimeNG, the ecosystem, and how support works.
|
|
801
1402
|
|
|
802
|
-
## Ecosystem
|
|
1403
|
+
## Ecosystem
|
|
803
1404
|
|
|
804
|
-
Do the PrimeNG themes work? The built-in presets do — Aura, Material, Lara and Nora ship in
|
|
1405
|
+
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.
|
|
805
1406
|
|
|
806
|
-
## Migration
|
|
1407
|
+
## Migration
|
|
807
1408
|
|
|
808
|
-
Which Angular versions are supported? Angular
|
|
1409
|
+
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.
|
|
809
1410
|
|
|
810
|
-
## Project
|
|
1411
|
+
## Project
|
|
811
1412
|
|
|
812
1413
|
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.
|
|
813
1414
|
|
|
814
|
-
## Support
|
|
1415
|
+
## Support
|
|
815
1416
|
|
|
816
1417
|
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 .
|
|
817
1418
|
|
|
818
1419
|
---
|
|
819
1420
|
|
|
1421
|
+
# Update ExhaustiveUI
|
|
1422
|
+
|
|
1423
|
+
Updating with ng update, Angular version compatibility, and what changes in v22 (Signals API, OnPush, automated migrations).
|
|
1424
|
+
|
|
1425
|
+
## Major-versions
|
|
1426
|
+
|
|
1427
|
+
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.
|
|
1428
|
+
|
|
1429
|
+
## Ng-update
|
|
1430
|
+
|
|
1431
|
+
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.
|
|
1432
|
+
|
|
1433
|
+
## Overview
|
|
1434
|
+
|
|
1435
|
+
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.
|
|
1436
|
+
|
|
1437
|
+
## Release-notes
|
|
1438
|
+
|
|
1439
|
+
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.
|
|
1440
|
+
|
|
1441
|
+
## V22
|
|
1442
|
+
|
|
1443
|
+
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. 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. Each migration prints the files it changed and the places it left for you to review, with file and line numbers.
|
|
1444
|
+
|
|
1445
|
+
---
|
|
1446
|
+
|
|
820
1447
|
# Contribution Guide
|
|
821
1448
|
|
|
822
1449
|
How to contribute to ExhaustiveUI.
|
|
823
1450
|
|
|
824
|
-
## Benefits
|
|
1451
|
+
## Benefits
|
|
825
1452
|
|
|
826
1453
|
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.
|
|
827
1454
|
|
|
828
|
-
## Helpneeded
|
|
1455
|
+
## Helpneeded
|
|
829
1456
|
|
|
830
1457
|
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.
|
|
831
1458
|
|
|
832
|
-
## Introduction
|
|
1459
|
+
## Introduction
|
|
833
1460
|
|
|
834
1461
|
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:
|
|
835
1462
|
|
|
836
|
-
## Pathway
|
|
1463
|
+
## Pathway
|
|
837
1464
|
|
|
838
1465
|
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.
|
|
839
1466
|
|
|
@@ -1015,7 +1642,7 @@ export class AccordionDisabledDemo {}
|
|
|
1015
1642
|
|
|
1016
1643
|
## Dynamic
|
|
1017
1644
|
|
|
1018
|
-
AccordionPanel can be generated dynamically using the standard
|
|
1645
|
+
AccordionPanel can be generated dynamically using the standard @for block.
|
|
1019
1646
|
|
|
1020
1647
|
**Example:**
|
|
1021
1648
|
|
|
@@ -2147,7 +2774,7 @@ export class AutocompleteMultipleDemo {
|
|
|
2147
2774
|
|
|
2148
2775
|
## Objects
|
|
2149
2776
|
|
|
2150
|
-
AutoComplete can also work with objects using the optionLabel property that defines the label to display as a suggestion. The value passed to the model would still be the object instance of a suggestion. Here is an example with a Country object that has name and code fields such as
|
|
2777
|
+
AutoComplete can also work with objects using the optionLabel property that defines the label to display as a suggestion. The value passed to the model would still be the object instance of a suggestion. Here is an example with a Country object that has name and code fields such as {name: "United States", code:"USA"} .
|
|
2151
2778
|
|
|
2152
2779
|
**Example:**
|
|
2153
2780
|
|
|
@@ -11175,7 +11802,7 @@ export class DatepickerFluidDemo {
|
|
|
11175
11802
|
|
|
11176
11803
|
## Format
|
|
11177
11804
|
|
|
11178
|
-
Default date format is mm/dd/yy which can be customized using the dateFormat property. Following options can be a part of the format. d - day of month (no leading zero) dd - day of month (two digit) o - day of the year (no leading zeros) oo - day of the year (three digit) D - day name short DD - day name long m - month of year (no leading zero) mm - month of year (two digit) M - month name short MM - month name long y - year (two digit) yy - year (four digit)
|
|
11805
|
+
Default date format is mm/dd/yy which can be customized using the dateFormat property. Following options can be a part of the format. d - day of month (no leading zero) dd - day of month (two digit) o - day of the year (no leading zeros) oo - day of the year (three digit) D - day name short DD - day name long m - month of year (no leading zero) mm - month of year (two digit) M - month name short MM - month name long y - year (two digit) yy - year (four digit) @ - Unix timestamp (ms since 01/01/1970) ! - Windows ticks (100ns since 01/01/0001) '...' - literal text '' - single quote anything else - literal text
|
|
11179
11806
|
|
|
11180
11807
|
**Example:**
|
|
11181
11808
|
|
|
@@ -20405,7 +21032,7 @@ export class ListboxDisabledDemo implements OnInit {
|
|
|
20405
21032
|
|
|
20406
21033
|
## dragdrop-doc
|
|
20407
21034
|
|
|
20408
|
-
Items can be reordered using drag and drop by enabling dragdrop property. Depends on
|
|
21035
|
+
Items can be reordered using drag and drop by enabling dragdrop property. Depends on @angular/cdk package.
|
|
20409
21036
|
|
|
20410
21037
|
**Example:**
|
|
20411
21038
|
|
|
@@ -21083,7 +21710,7 @@ Add a .md to a page's URL to display a Markdown version of that page.
|
|
|
21083
21710
|
|
|
21084
21711
|
## MCP Server
|
|
21085
21712
|
|
|
21086
|
-
|
|
21713
|
+
@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.
|
|
21087
21714
|
|
|
21088
21715
|
---
|
|
21089
21716
|
|
|
@@ -24552,7 +25179,7 @@ export class OrderlistBasicDemo implements OnInit {
|
|
|
24552
25179
|
|
|
24553
25180
|
## dragdrop-doc
|
|
24554
25181
|
|
|
24555
|
-
Items can be reordered using drag and drop by enabling dragdrop property. Depends on
|
|
25182
|
+
Items can be reordered using drag and drop by enabling dragdrop property. Depends on @angular/cdk package.
|
|
24556
25183
|
|
|
24557
25184
|
**Example:**
|
|
24558
25185
|
|
|
@@ -27207,7 +27834,7 @@ Screen Reader Value to describe the source listbox and target listbox can be pro
|
|
|
27207
27834
|
|
|
27208
27835
|
## Basic
|
|
27209
27836
|
|
|
27210
|
-
PickList is used as a controlled input with source and target properties. Content of a list item needs to be defined with the item template that receives an object in the list as parameter. Drag & drop functionality depends on
|
|
27837
|
+
PickList is used as a controlled input with source and target properties. Content of a list item needs to be defined with the item template that receives an object in the list as parameter. Drag & drop functionality depends on @angular/cdk package.
|
|
27211
27838
|
|
|
27212
27839
|
**Example:**
|
|
27213
27840
|
|
|
@@ -34165,7 +34792,7 @@ export class StyleclassHideonresizeDemo {}
|
|
|
34165
34792
|
|
|
34166
34793
|
## Toggle Class
|
|
34167
34794
|
|
|
34168
|
-
StyleClass has two modes, toggleClass to simply add-remove a class and enter/leave animations. The target element to change the styling is defined with the selector property that accepts any valid CSS selector or keywords including
|
|
34795
|
+
StyleClass has two modes, toggleClass to simply add-remove a class and enter/leave animations. The target element to change the styling is defined with the selector property that accepts any valid CSS selector or keywords including @next , prev , parent , grandparent
|
|
34169
34796
|
|
|
34170
34797
|
**Example:**
|
|
34171
34798
|
|
|
@@ -39145,7 +39772,7 @@ export class TabsDisabledDemo {}
|
|
|
39145
39772
|
|
|
39146
39773
|
## Dynamic
|
|
39147
39774
|
|
|
39148
|
-
Tabs can be generated dynamically using the standard
|
|
39775
|
+
Tabs can be generated dynamically using the standard @for block.
|
|
39149
39776
|
|
|
39150
39777
|
**Example:**
|
|
39151
39778
|
|