@exhaustive-ui/mcp 22.0.0-rc.3 → 22.0.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
package/data/llms.txt CHANGED
@@ -21,7 +21,8 @@ Machine-readable API (selectors, inputs, outputs, templates, types): https://exh
21
21
  - [PrimeFlex](https://exhaustive-ui.com/guides/primeflex): Moving from PrimeFlex to Tailwind CSS.
22
22
  - [Philosophy](https://exhaustive-ui.com/philosophy): Why ExhaustiveUI exists, what it commits to, and where it stops.
23
23
  - [FAQ](https://exhaustive-ui.com/faq): Licensing, migration from PrimeNG, the ecosystem, and how support works.
24
- - [Update ExhaustiveUI](https://exhaustive-ui.com/migration/update): Updating with ng update, Angular version compatibility, and what changes in v22 (Signals API, OnPush, automated migrations).
24
+ - [Update ExhaustiveUI](https://exhaustive-ui.com/migration/update): Updating with ng update, Angular version compatibility, and a summary of what changes in v22.
25
+ - [Migrating to v22](https://exhaustive-ui.com/migration/v22): Moving an application to ExhaustiveUI v22: update steps from an ExhaustiveUI prerelease, PrimeNG v21 or Optimus UI, the automated migrations and their report, the Signals API, OnPush, removed API, behavior and type changes.
25
26
  - [Contribution Guide](https://exhaustive-ui.com/contribution): How to contribute to ExhaustiveUI.
26
27
 
27
28
  ## Components
@@ -1,7 +1,7 @@
1
1
  {
2
2
  "schemaVersion": 1,
3
3
  "package": "@exhaustive-ui/core",
4
- "version": "22.0.0-rc.3",
4
+ "version": "22.0.0",
5
5
  "site": "https://exhaustive-ui.com",
6
6
  "entryPoints": [
7
7
  {
@@ -4,25 +4,183 @@ ExhaustiveUI has WCAG 2.1 AA level compliance.
4
4
 
5
5
  ## Colors
6
6
 
7
- 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
7
+ 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.
8
+
9
+ ### Good Contrast
10
+
11
+ 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.
12
+
13
+ GOOD
14
+ BAD
15
+
16
+ ### Vibration
17
+
18
+ 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.
19
+
20
+ VIBRATE
21
+
22
+ ### Dark Mode
23
+
24
+ Highly saturated colors should be avoided when used within a dark design scheme as they cause eye strain. Instead desaturated colors should be preferred.
25
+
26
+ Indigo 500
27
+ Indigo 200
8
28
 
9
29
  ## Formcontrols
10
30
 
11
- 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.
31
+ 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
32
+ with space key as well to trigger.
33
+
34
+ ```html
35
+ <button (click)="onButtonClick($event)">Click></button>
36
+ ```
37
+
38
+ On the other hand, a fancy css based button using a div has no keyboard or screen reader support.
39
+
40
+ ```html
41
+ <div class="fancy-button" (click)="onButtonClick($event)">Click</div>
42
+ ```
43
+
44
+ `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
45
+ controls should be preferred.
46
+
47
+ ```html
48
+ <div class="fancy-button" (click)="onButtonClick($event)" (keydown)="onKeyDown($event)" tabIndex="0">Click</div>
49
+ ```
50
+
51
+ ### Relations
52
+
53
+ 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.
54
+
55
+ ```html
56
+ <label for="myinput">Username:</label>
57
+ <input id="myinput" type="text" name="username" />
58
+ ```
12
59
 
13
60
  ## Introduction
14
61
 
15
- 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.
62
+ 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
63
+ to ensure content can be consumed by anyone.
64
+
65
+ ### Disabilities
66
+
67
+ 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;
68
+
69
+ ### Visual Impairments
70
+
71
+ 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
72
+ developers are required to make sure content is readable by the readers. Popular readers are
73
+ [NVDA](https://www.nvaccess.org), [JAWS](https://www.freedomscientific.com/Products/software/JAWS/) and
74
+ [ChromeVox](https://www.chromevox.com).
75
+
76
+ ### Hearing Impairments
77
+
78
+ 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
79
+ providing textual alternatives, transcripts and captions for content with audio.
80
+
81
+ ### Mobility Impairments
82
+
83
+ 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
84
+ trackpad remain as solutions for people who are not able to utilize a mouse.
85
+
86
+ ### Cognitive Impairments
87
+
88
+ 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
89
+ impairments result in better design for any user.
16
90
 
17
91
  ## Semantichtml
18
92
 
19
- 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.
93
+ 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
94
+ `div` elements with classes are used. Consider the following example that do not mean too much for readers.
95
+
96
+ ```html
97
+ <div class="header"/>
98
+ <div class="header-text">Header></div>
99
+ </div>
100
+
101
+ <div class="nav"></div>
102
+
103
+ <div class="main">
104
+ <div class="content"></div>
105
+ <div class="sidebar"></div>
106
+ </div>
107
+
108
+ <div class="footer"></div>
109
+ ```
110
+
111
+ Same layout can be achieved using the semantic elements with screen reader support built-in.
112
+
113
+ ```html
114
+ <header>
115
+ <h1>Header</h1>
116
+ </header>
117
+
118
+ <nav></nav>
119
+
120
+ <main>
121
+ <article></article>
122
+ <aside></aside>
123
+ </main>
124
+
125
+ <footer></footer>
126
+ ```
20
127
 
21
128
  ## Waiaria
22
129
 
23
- ARIA refers to "Accessible Rich Internet Applications" is a suite to fill the gap where semantic HTML is inadequate. These cases are mainly related to rich UI components/widgets. Although browser support for rich UI components such as a datepicker or colorpicker has been improved over the past years many web developers still utilize UI components derived from standard HTML elements created by them or by other projects like ExhaustiveUI. These types of components must provide keyboard and screen reader support, the latter case is where the WAI-ARIA is utilized. ARIA consists of roles, properties and attributes. Roles define what the element is mainly used for e.g. checkbox , dialog , tablist whereas States and Properties define the metadata of the element like aria-checked , aria-disabled . Consider the following case of a native checkbox. It has built-in keyboard and screen reader support. A fancy checkbox with css animations might look more appealing but accessibility might be lacking. Checkbox below may display a checked font icon with animations however it is not tabbable, cannot be checked with space key and cannot be read by a reader. One alternative is using ARIA roles for readers and use javascript for keyboard support. Notice the usage of aria-labelledby as a replacement of the label tag with for. However the best practice is combining semantic HTML for accessibility while keeping the design for UX. This approach involves hiding a native checkbox for accessibility and using javascript events to update its state. Notice the usage of p-hidden-accessible that hides the elements from the user but not from the screen reader. A working sample is the ExhaustiveUI checkbox that is tabbable, keyboard accessible and is compliant with a screen reader. Instead of ARIA roles it relies on a hidden native checkbox. Remember Me
130
+ 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
131
+ 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
132
+ must provide keyboard and screen reader support, the latter case is where the WAI-ARIA is utilized.
133
+
134
+ 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
135
+ element like `aria-checked`, `aria-disabled`.
136
+
137
+ Consider the following case of a native checkbox. It has built-in keyboard and screen reader support.
138
+
139
+ ```html
140
+ <input type="checkbox" value="Prime" name="ui" checked/>
141
+ ```
142
+
143
+ 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
144
+ be read by a reader.
145
+
146
+ ```html
147
+ <div class="fancy-checkbox">
148
+ <i *ngIf="checked" class="checked-icon"></i>
149
+ </div>
150
+ ```
151
+
152
+ One alternative is using ARIA roles for readers and use javascript for keyboard support. Notice the usage of
153
+ `aria-labelledby` as a replacement of the `label` tag with for.
154
+
155
+ ```html
156
+ <span id="chk-label">Remember Me></span>
157
+ <div class="fancy-checkbox" role="checkbox" aria-checked="false" tabindex="0" aria-labelledby="chk-label" (click)="toggle()" (keydown)="onKeyDown($event)">
158
+ <i *ngIf="checked" class="checked-icon"></i>
159
+ </div>
160
+ ```
161
+
162
+ 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
163
+ usage of
164
+ `p-hidden-accessible`
165
+ that hides the elements from the user but not from the screen reader.
166
+
167
+ ```html
168
+ <label for="chkbox">Remember Me></label>
169
+ <div class="fancy-checkbox" (click)="toggle()">
170
+ <input class="p-hidden-accessible" type="checkbox" id="chkbox" (focus)="updateParentVisuals()" (blur)="updateParentVisuals()" (keydown)="$event.keyCode === 32 && updateParentVisuals()">
171
+ <i *ngIf="checked" class="checked-icon"></i>
172
+ </div>
173
+ ```
174
+
175
+ 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.
176
+
177
+ Remember Me
24
178
 
25
179
  ## Wcag
26
180
 
27
- 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.
181
+ [WCAG](https://www.w3.org/WAI/standards-guidelines/wcag/) refers to **Web Content Accessibility Guideline**, a standard managed by the WAI (Web Accessibility Initiative) of W3C (World Wide
182
+ 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.
183
+
184
+ Various countries around the globe have governmental policies regarding web accessibility as well. Most well known of these are [Section 508](https://www.section508.gov/manage/laws-and-policies/) in the US and
185
+ [Web Accessibility Directive](https://digital-strategy.ec.europa.eu/en/policies/web-accessibility) of the European Union.
28
186
 
@@ -4,15 +4,39 @@ Built-in CSS animations for ExhaustiveUI components.
4
4
 
5
5
  ## Anchoredoverlays
6
6
 
7
- 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.
7
+ 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
8
+ `.p-anchored-overlay-leave-active`
9
+ classes.
8
10
 
9
11
  ## Collapsibles
10
12
 
11
- 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.
13
+ 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
14
+ `.p-collapsible-leave-active`
15
+ classes.
16
+
17
+ Header I
18
+
19
+ 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
20
+ 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
21
+ id est laborum.
22
+
23
+ Header II
24
+
25
+ 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.
26
+ 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.
27
+
28
+ Header III
29
+
30
+ 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.
31
+ 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.
12
32
 
13
33
  ## Dialog
14
34
 
15
- Overlays such as Dialog and Drawer are positioned relative to the viewport and have their own animations. Update your information. Username Email
35
+ Overlays such as Dialog and Drawer are positioned relative to the viewport and have their own animations.
36
+
37
+ Update your information.
38
+ Username
39
+ Email
16
40
 
17
41
  ## Disable
18
42
 
@@ -20,9 +44,90 @@ Individual animations can be reduced and even disabled completely using the anim
20
44
 
21
45
  ## Introduction
22
46
 
23
- 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.
47
+ 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
48
+ default animations, this documentation covers the entire set of built-in animations.
49
+
50
+ 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
51
+ 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
52
+ demo purposes, this second approach is used throughout the next sections.
24
53
 
25
54
  ## Reference
26
55
 
27
- 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
56
+ List of class names of the CSS animations used by the components.
57
+
58
+ Component
59
+ Enter Class
60
+ Leave Class
61
+ `Accordion`
62
+ .p-collapsible-enter-active
63
+ .p-collapsible-leave-active
64
+ `AutoComplete`
65
+ .p-anchored-overlay-enter-active
66
+ .p-anchored-overlay-leave-active
67
+ `CascadeSelect`
68
+ .p-anchored-overlay-enter-active
69
+ .p-anchored-overlay-leave-active
70
+ `ColorPicker`
71
+ .p-anchored-overlay-enter-active
72
+ .p-anchored-overlay-leave-active
73
+ `ConfirmPopup`
74
+ .p-anchored-overlay-enter-active
75
+ .p-anchored-overlay-leave-active
76
+ `ContextMenu`
77
+ .p-anchored-overlay-enter-active
78
+ .p-anchored-overlay-leave-active
79
+ `DatePicker`
80
+ .p-anchored-overlay-enter-active
81
+ .p-anchored-overlay-leave-active
82
+ `Dialog`
83
+ .p-dialog-enter-active
84
+ .p-dialog-leave-active
85
+ `Drawer`
86
+ .p-drawer-enter-active
87
+ .p-drawer-leave-active
88
+ `Fieldset`
89
+ .p-collapsible-enter-active
90
+ .p-collapsible-leave-active
91
+ `Galleria`
92
+ .p-galleria-enter-active
93
+ .p-galleria-leave-active
94
+ `Image`
95
+ .p-image-original-enter-active
96
+ .p-image-original-leave-active
97
+ `Menu`
98
+ .p-anchored-overlay-enter-active
99
+ .p-anchored-overlay-leave-active
100
+ `Message`
101
+ .p-message-enter-active
102
+ .p-message-leave-active
103
+ `Modal Masks`
104
+ .p-overlay-mask-enter-active
105
+ .p-overlay-mask-leave-active
106
+ `MultiSelect`
107
+ .p-anchored-overlay-enter-active
108
+ .p-anchored-overlay-leave-active
109
+ `Panel`
110
+ .p-collapsible-enter-active
111
+ .p-collapsible-leave-active
112
+ `PanelMenu`
113
+ .p-collapsible-enter-active
114
+ .p-collapsible-leave-active
115
+ `Password`
116
+ .p-anchored-overlay-enter-active
117
+ .p-anchored-overlay-leave-active
118
+ `Select`
119
+ .p-anchored-overlay-enter-active
120
+ .p-anchored-overlay-leave-active
121
+ `Stepper`
122
+ .p-collapsible-enter-active
123
+ .p-collapsible-leave-active
124
+ `TieredMenu`
125
+ .p-anchored-overlay-enter-active
126
+ .p-anchored-overlay-leave-active
127
+ `Toast`
128
+ .p-toast-message-enter-active
129
+ .p-toast-message-leave-active
130
+ `TreeSelect`
131
+ .p-anchored-overlay-enter-active
132
+ .p-anchored-overlay-leave-active
28
133
 
@@ -2,21 +2,24 @@
2
2
 
3
3
  Application wide configuration for ExhaustiveUI.
4
4
 
5
- ## Csp
5
+ ## Provider
6
6
 
7
- The nonce value to use on dynamically generated style elements in core.
7
+ The initial configuration is defined by the `provideExhaustive` provider during application startup.
8
8
 
9
9
  ```typescript
10
- provideExhaustive({
11
- csp: {
12
- nonce: '...'
13
- }
14
- })
10
+ import { ApplicationConfig } from '@angular/core';
11
+ import { provideExhaustive } from '@exhaustive-ui/core/config';
12
+
13
+ export const appConfig: ApplicationConfig = {
14
+ providers: [
15
+ provideExhaustive({ /* options */ })
16
+ ]
17
+ };
15
18
  ```
16
19
 
17
20
  ## Dynamic
18
21
 
19
- Inject the Exhaustive to your application to update the initial configuration at runtime.
22
+ Inject the `Exhaustive` to your application to update the initial configuration at runtime.
20
23
 
21
24
  ```typescript
22
25
  import { Component, OnInit } from '@angular/core';
@@ -36,9 +39,56 @@ export class AppComponent implements OnInit {
36
39
  }
37
40
  ```
38
41
 
39
- ## Filtermode
42
+ ## Theme
40
43
 
41
- Default filter modes to display on DataTable filter menus.
44
+ ExhaustiveUI provides 4 predefined themes out of the box; Aura, Material, Lara and Nora. See the theming documentation for details.
45
+
46
+ ```typescript
47
+ import { ApplicationConfig } from '@angular/core';
48
+ import { provideExhaustive } from '@exhaustive-ui/core/config';
49
+
50
+ import Aura from '@exhaustive-ui/themes/aura';
51
+
52
+ export const appConfig: ApplicationConfig = {
53
+ providers: [
54
+ provideExhaustive({
55
+ theme: {
56
+ preset: Aura,
57
+ options: {
58
+ prefix: 'p',
59
+ darkModeSelector: 'system',
60
+ cssLayer: false
61
+ }
62
+ }
63
+ })
64
+ ]
65
+ };
66
+ ```
67
+
68
+ ## Ripple
69
+
70
+ Ripple is an optional animation for the supported components such as buttons. It is disabled by default.
71
+
72
+ ```typescript
73
+ provideExhaustive({
74
+ ripple: true
75
+ })
76
+ ```
77
+
78
+ ## InputVariant
79
+
80
+ 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
81
+ variant.
82
+
83
+ ## OverlayAppendTo
84
+
85
+ Defines the default location of the overlays; `self` refers to the host element and `body` targets the document body. Defaults to `self`.
86
+
87
+ ## ZIndex
88
+
89
+ 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
90
+ 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
91
+ customize the default values for components categories. Default values are described below and can be customized when setting up ExhaustiveUI.
42
92
 
43
93
  ```typescript
44
94
  import { ExhaustiveConfig } from '@exhaustive-ui/core/api';
@@ -52,43 +102,34 @@ export class AppComponent implements OnInit {
52
102
  constructor(private exhaustiveConfig: ExhaustiveConfig) {}
53
103
 
54
104
  ngOnInit() {
55
- exhaustiveConfig.filterMatchModeOptions = {
56
- text: [FilterMatchMode.STARTS_WITH, FilterMatchMode.CONTAINS, FilterMatchMode.NOT_CONTAINS, FilterMatchMode.ENDS_WITH, FilterMatchMode.EQUALS, FilterMatchMode.NOT_EQUALS],
57
- numeric: [FilterMatchMode.EQUALS, FilterMatchMode.NOT_EQUALS, FilterMatchMode.LESS_THAN, FilterMatchMode.LESS_THAN_OR_EQUAL_TO, FilterMatchMode.GREATER_THAN, FilterMatchMode.GREATER_THAN_OR_EQUAL_TO],
58
- date: [FilterMatchMode.DATE_IS, FilterMatchMode.DATE_IS_NOT, FilterMatchMode.DATE_BEFORE, FilterMatchMode.DATE_AFTER]
105
+ this.exhaustiveConfig.zIndex = {
106
+ modal: 1100, // dialog, sidebar
107
+ overlay: 1000, // dropdown, overlaypanel
108
+ menu: 1000, // overlay menus
109
+ tooltip: 1100 // tooltip
59
110
  };
60
111
  }
61
112
  }
62
113
  ```
63
114
 
64
- ## Inputvariant
65
-
66
- 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.
67
-
68
- ## Api
115
+ ## Nonce
69
116
 
70
- Locale Options
71
-
72
- ## Repository
73
-
74
- 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.
117
+ The `nonce` value to use on dynamically generated style elements in core.
75
118
 
76
119
  ```typescript
77
- import { de } from '@exhaustive-ui/locale/js/de.js';
78
-
79
120
  provideExhaustive({
80
- translation: de
121
+ csp: {
122
+ nonce: '...'
123
+ }
81
124
  })
82
125
  ```
83
126
 
84
- ## Runtime
127
+ ## Filter Mode
85
128
 
86
- The translations can be changed dynamically at runtime, here is an example with ngx-translate.
129
+ Default filter modes to display on DataTable filter menus.
87
130
 
88
131
  ```typescript
89
- import { Component, OnInit } from '@angular/core';
90
- import { Exhaustive } from '@exhaustive-ui/core/config';
91
- import { TranslateService } from '@ngx-translate/core';
132
+ import { ExhaustiveConfig } from '@exhaustive-ui/core/api';
92
133
 
93
134
  @Component({
94
135
  selector: 'app-root',
@@ -96,15 +137,14 @@ import { TranslateService } from '@ngx-translate/core';
96
137
  })
97
138
  export class AppComponent implements OnInit {
98
139
 
99
- constructor(private config: Exhaustive, private translateService: TranslateService) {}
140
+ constructor(private exhaustiveConfig: ExhaustiveConfig) {}
100
141
 
101
142
  ngOnInit() {
102
- this.translateService.setDefaultLang('en');
103
- }
104
-
105
- translate(lang: string) {
106
- this.translateService.use(lang);
107
- this.translateService.get('exhaustive').subscribe(res => this.config.setTranslation(res));
143
+ exhaustiveConfig.filterMatchModeOptions = {
144
+ text: [FilterMatchMode.STARTS_WITH, FilterMatchMode.CONTAINS, FilterMatchMode.NOT_CONTAINS, FilterMatchMode.ENDS_WITH, FilterMatchMode.EQUALS, FilterMatchMode.NOT_EQUALS],
145
+ numeric: [FilterMatchMode.EQUALS, FilterMatchMode.NOT_EQUALS, FilterMatchMode.LESS_THAN, FilterMatchMode.LESS_THAN_OR_EQUAL_TO, FilterMatchMode.GREATER_THAN, FilterMatchMode.GREATER_THAN_OR_EQUAL_TO],
146
+ date: [FilterMatchMode.DATE_IS, FilterMatchMode.DATE_IS_NOT, FilterMatchMode.DATE_BEFORE, FilterMatchMode.DATE_AFTER]
147
+ };
108
148
  }
109
149
  }
110
150
  ```
@@ -123,84 +163,49 @@ provideExhaustive({
123
163
  })
124
164
  ```
125
165
 
126
- ## Overlayappendto
127
-
128
- Defines the default location of the overlays; self refers to the host element and body targets the document body. Defaults to self .
129
-
130
- ## Provider
166
+ ## Runtime
131
167
 
132
- The initial configuration is defined by the provideExhaustive provider during application startup.
168
+ The translations can be changed dynamically at runtime, here is an example with ngx-translate.
133
169
 
134
170
  ```typescript
135
- import { ApplicationConfig } from '@angular/core';
136
- import { provideExhaustive } from '@exhaustive-ui/core/config';
137
-
138
- export const appConfig: ApplicationConfig = {
139
- providers: [
140
- provideExhaustive({ /* options */ })
141
- ]
142
- };
143
- ```
144
-
145
- ## Ripple
146
-
147
- Ripple is an optional animation for the supported components such as buttons. It is disabled by default.
171
+ import { Component, OnInit } from '@angular/core';
172
+ import { Exhaustive } from '@exhaustive-ui/core/config';
173
+ import { TranslateService } from '@ngx-translate/core';
148
174
 
149
- ```typescript
150
- provideExhaustive({
151
- ripple: true
175
+ @Component({
176
+ selector: 'app-root',
177
+ templateUrl: './app.component.html'
152
178
  })
153
- ```
154
-
155
- ## Theme
156
-
157
- ExhaustiveUI provides 4 predefined themes out of the box; Aura, Material, Lara and Nora. See the theming documentation for details.
179
+ export class AppComponent implements OnInit {
158
180
 
159
- ```typescript
160
- import { ApplicationConfig } from '@angular/core';
161
- import { provideExhaustive } from '@exhaustive-ui/core/config';
181
+ constructor(private config: Exhaustive, private translateService: TranslateService) {}
162
182
 
163
- import Aura from '@exhaustive-ui/themes/aura';
183
+ ngOnInit() {
184
+ this.translateService.setDefaultLang('en');
185
+ }
164
186
 
165
- export const appConfig: ApplicationConfig = {
166
- providers: [
167
- provideExhaustive({
168
- theme: {
169
- preset: Aura,
170
- options: {
171
- prefix: 'p',
172
- darkModeSelector: 'system',
173
- cssLayer: false
174
- }
175
- }
176
- })
177
- ]
178
- };
187
+ translate(lang: string) {
188
+ this.translateService.use(lang);
189
+ this.translateService.get('exhaustive').subscribe(res => this.config.setTranslation(res));
190
+ }
191
+ }
179
192
  ```
180
193
 
181
- ## Zindex
194
+ ## Repository
182
195
 
183
- 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.
196
+ Ready to use settings for locales are available as the `@exhaustive-ui/locale` package, maintained in the
197
+ [ExhaustiveUI](https://github.com/e-xiste/exhaustive-ui/tree/main/packages/locale) repository. We'd appreciate if you could contribute translations to the repository and share them
198
+ with the rest of the community.
184
199
 
185
200
  ```typescript
186
- import { ExhaustiveConfig } from '@exhaustive-ui/core/api';
201
+ import { de } from '@exhaustive-ui/locale/js/de.js';
187
202
 
188
- @Component({
189
- selector: 'app-root',
190
- templateUrl: './app.component.html'
203
+ provideExhaustive({
204
+ translation: de
191
205
  })
192
- export class AppComponent implements OnInit {
206
+ ```
193
207
 
194
- constructor(private exhaustiveConfig: ExhaustiveConfig) {}
208
+ ## API
195
209
 
196
- ngOnInit() {
197
- this.exhaustiveConfig.zIndex = {
198
- modal: 1100, // dialog, sidebar
199
- overlay: 1000, // dropdown, overlaypanel
200
- menu: 1000, // overlay menus
201
- tooltip: 1100 // tooltip
202
- };
203
- }
204
- }
205
- ```
210
+ ### Locale Options
206
211