@exhaustive-ui/mcp 22.0.0-rc.2 → 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/components/accordion.md +1 -0
- package/data/components/autocomplete.md +59 -0
- package/data/components/cascadeselect.md +136 -0
- package/data/components/checkbox.md +56 -0
- package/data/components/colorpicker.md +49 -0
- package/data/components/confirmpopup.md +0 -7
- package/data/components/dataview.md +0 -2
- package/data/components/datepicker.md +52 -3
- package/data/components/drawer.md +1 -1
- package/data/components/editor.md +49 -0
- package/data/components/floatlabel.md +72 -0
- package/data/components/iftalabel.md +68 -0
- package/data/components/inputmask.md +54 -4
- package/data/components/inputnumber.md +52 -3
- package/data/components/inputotp.md +50 -0
- package/data/components/inputtext.md +63 -1
- package/data/components/knob.md +55 -0
- package/data/components/listbox.md +57 -2
- package/data/components/message.md +0 -1
- package/data/components/multiselect.md +59 -4
- package/data/components/orderlist.md +1 -3
- package/data/components/password.md +52 -3
- package/data/components/picklist.md +0 -3
- package/data/components/radiobutton.md +60 -0
- package/data/components/rating.md +49 -0
- package/data/components/select.md +58 -3
- package/data/components/selectbutton.md +50 -1
- package/data/components/slider.md +50 -0
- package/data/components/stepper.md +0 -1
- package/data/components/table.md +1 -1
- package/data/components/textarea.md +48 -0
- package/data/components/togglebutton.md +50 -0
- package/data/components/toggleswitch.md +49 -0
- package/data/components/tooltip.md +0 -1
- package/data/components/treeselect.md +61 -1
- package/data/components/treetable.md +1 -1
- package/data/components.json +774 -503
- package/data/llms-full.txt +3494 -819
- package/data/llms.txt +2 -1
- package/data/manifest.json +91 -476
- package/data/pages/accessibility.md +164 -6
- package/data/pages/animations.md +110 -5
- package/data/pages/configuration.md +107 -102
- package/data/pages/contribution.md +68 -7
- package/data/pages/customicons.md +8 -8
- package/data/pages/faq.md +103 -8
- package/data/pages/icons.md +24 -23
- package/data/pages/installation.md +77 -25
- package/data/pages/llms.md +71 -15
- package/data/pages/passthrough.md +96 -7
- package/data/pages/philosophy.md +80 -11
- package/data/pages/primeflex.md +41 -4
- package/data/pages/rtl.md +4 -1
- package/data/pages/styled.md +174 -66
- package/data/pages/tailwind.md +309 -218
- package/data/pages/unstyled.md +48 -7
- package/data/pages/update.md +42 -13
- package/data/pages/v22.md +218 -0
- package/data/snapshot.json +4 -4
- package/dist/index.mjs +72 -22
- package/dist/index.mjs.map +1 -1
- package/package.json +1 -1
package/data/components.json
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
{
|
|
2
2
|
"version": "1.0.0",
|
|
3
|
-
"generatedAt": "2026-11-
|
|
3
|
+
"generatedAt": "2026-11-22",
|
|
4
4
|
"components": [
|
|
5
5
|
{
|
|
6
6
|
"name": "accordion",
|
|
@@ -278,6 +278,11 @@
|
|
|
278
278
|
"variable": "--p-accordion-header-active-hover-background",
|
|
279
279
|
"description": "Active hover background of header"
|
|
280
280
|
},
|
|
281
|
+
{
|
|
282
|
+
"token": "accordion.header.focus.background",
|
|
283
|
+
"variable": "--p-accordion-header-focus-background",
|
|
284
|
+
"description": "Focus background of header"
|
|
285
|
+
},
|
|
281
286
|
{
|
|
282
287
|
"token": "accordion.header.focus.ring.width",
|
|
283
288
|
"variable": "--p-accordion-header-focus-ring-width",
|
|
@@ -611,6 +616,14 @@
|
|
|
611
616
|
"typescript": "import { Component, inject } from '@angular/core';\nimport { ReactiveFormsModule } from '@angular/forms';\nimport { AutoCompleteModule } from '@exhaustive-ui/core/autocomplete';\nimport { MessageModule } from '@exhaustive-ui/core/message';\nimport { ToastModule } from '@exhaustive-ui/core/toast';\nimport { ButtonModule } from '@exhaustive-ui/core/button';\nimport { MessageService } from '@exhaustive-ui/core/api';\n\ninterface AutoCompleteCompleteEvent {\n originalEvent: Event;\n query: string;\n}\n\n@Component({\n template: `\n <p-toast />\n <div class=\"card flex justify-center\">\n <form [formGroup]=\"exampleForm\" (ngSubmit)=\"onSubmit()\" class=\"flex justify-center flex-col gap-4 md:w-56\">\n <div class=\"flex flex-col gap-1\">\n <p-autocomplete formControlName=\"value\" [suggestions]=\"items\" [invalid]=\"isInvalid('value')\" (completeMethod)=\"search($event)\" fluid />\n @if (isInvalid('value')) {\n <p-message severity=\"error\" size=\"small\" variant=\"simple\">Value is required.</p-message>\n }\n </div>\n <button pButton severity=\"secondary\" type=\"submit\"><span pButtonLabel>Submit</span></button>\n </form>\n </div>\n `,\n standalone: true,\n imports: [AutoCompleteModule, MessageModule, ToastModule, ButtonModule, ReactiveFormsModule]\n})\nexport class AutocompleteReactiveFormsDemo {\n messageService = inject(MessageService);\n items: any[] | undefined;\n exampleForm: FormGroup | undefined;\n formSubmitted: boolean = false;\n\n constructor() {\n this.exampleForm = this.fb.group({\n value: ['', Validators.required]\n });\n }\n\n search(event: AutoCompleteCompleteEvent) {\n this.items = [...Array(10).keys()].map((item) => event.query + '-' + item);\n }\n\n onSubmit() {\n this.formSubmitted = true;\n if (this.exampleForm.valid) {\n this.messageService.add({ severity: 'success', summary: 'Success', detail: 'Form is submitted', life: 3000 });\n this.exampleForm.reset();\n this.formSubmitted = false;\n }\n }\n\n isInvalid(controlName: string) {\n const control = this.exampleForm.get(controlName);\n return control?.invalid && (control.touched || this.formSubmitted);\n }\n}"
|
|
612
617
|
}
|
|
613
618
|
},
|
|
619
|
+
{
|
|
620
|
+
"id": "signalforms",
|
|
621
|
+
"label": "Signal Forms",
|
|
622
|
+
"description": "AutoComplete can also be used with Angular Signal Forms , the @angular/forms/signals API of Angular 21 and newer. The form model is a signal, form() declares its validators and the [formField] directive binds the component to a field. The field also sets the invalid state of the component, so the component is styled as invalid before any interaction, while the messages below appear once the field is touched or the form is submitted.",
|
|
623
|
+
"examples": {
|
|
624
|
+
"typescript": "import { Component, inject, signal } from '@angular/core';\nimport { form, FormField, required, submit } from '@angular/forms/signals';\nimport { AutoCompleteModule } from '@exhaustive-ui/core/autocomplete';\nimport { MessageModule } from '@exhaustive-ui/core/message';\nimport { ToastModule } from '@exhaustive-ui/core/toast';\nimport { ButtonModule } from '@exhaustive-ui/core/button';\nimport { MessageService } from '@exhaustive-ui/core/api';\n\ninterface AutoCompleteCompleteEvent {\n originalEvent: Event;\n query: string;\n}\n\n@Component({\n template: `\n <p-toast />\n <div class=\"card flex justify-center\">\n <form novalidate (submit)=\"onSubmit($event)\" class=\"flex justify-center flex-col gap-4 md:w-56\">\n <div class=\"flex flex-col gap-1\">\n <p-autocomplete [formField]=\"exampleForm.value\" [suggestions]=\"items\" (completeMethod)=\"search($event)\" fluid />\n @let value = exampleForm.value();\n @if (value.invalid() && value.touched()) {\n <p-message severity=\"error\" size=\"small\" variant=\"simple\">Value is required.</p-message>\n }\n </div>\n <button pButton severity=\"secondary\" type=\"submit\"><span pButtonLabel>Submit</span></button>\n </form>\n </div>\n `,\n standalone: true,\n imports: [AutoCompleteModule, MessageModule, ToastModule, ButtonModule, FormField]\n})\nexport class AutocompleteSignalformsDemo {\n messageService = inject(MessageService);\n items: any[] | undefined;\n model = signal({ value: '' });\n exampleForm = form(this.model, (f) => {\n required(f.value);\n });\n\n search(event: AutoCompleteCompleteEvent) {\n this.items = [...Array(10).keys()].map((item) => event.query + '-' + item);\n }\n\n onSubmit(event: Event) {\n event.preventDefault();\n submit(this.exampleForm, async () => {\n this.messageService.add({ severity: 'success', summary: 'Success', detail: 'Form is submitted', life: 3000 });\n this.exampleForm().reset({ value: '' });\n });\n }\n}"
|
|
625
|
+
}
|
|
626
|
+
},
|
|
614
627
|
{
|
|
615
628
|
"id": "sizes",
|
|
616
629
|
"label": "Sizes",
|
|
@@ -744,13 +757,6 @@
|
|
|
744
757
|
"description": "Whether to use the scroller feature. The properties of scroller component can be used like an object in it.",
|
|
745
758
|
"deprecated": ""
|
|
746
759
|
},
|
|
747
|
-
{
|
|
748
|
-
"name": "autoHighlight",
|
|
749
|
-
"type": "InputSignalWithTransform<boolean, unknown>",
|
|
750
|
-
"default": "...",
|
|
751
|
-
"description": "When enabled, highlights the first item in the list by default.",
|
|
752
|
-
"deprecated": ""
|
|
753
|
-
},
|
|
754
760
|
{
|
|
755
761
|
"name": "forceSelection",
|
|
756
762
|
"type": "InputSignalWithTransform<boolean, unknown>",
|
|
@@ -1117,21 +1123,21 @@
|
|
|
1117
1123
|
},
|
|
1118
1124
|
{
|
|
1119
1125
|
"name": "pattern",
|
|
1120
|
-
"type": "
|
|
1126
|
+
"type": "InputSignalWithTransform<string, string | readonly RegExp[]>",
|
|
1121
1127
|
"default": "undefined",
|
|
1122
1128
|
"description": "Specifies the value must match the pattern.",
|
|
1123
1129
|
"deprecated": ""
|
|
1124
1130
|
},
|
|
1125
1131
|
{
|
|
1126
1132
|
"name": "min",
|
|
1127
|
-
"type": "
|
|
1133
|
+
"type": "InputSignalWithTransform<number, unknown>",
|
|
1128
1134
|
"default": "undefined",
|
|
1129
1135
|
"description": "The value must be greater than or equal to the value.",
|
|
1130
1136
|
"deprecated": ""
|
|
1131
1137
|
},
|
|
1132
1138
|
{
|
|
1133
1139
|
"name": "max",
|
|
1134
|
-
"type": "
|
|
1140
|
+
"type": "InputSignalWithTransform<number, unknown>",
|
|
1135
1141
|
"default": "undefined",
|
|
1136
1142
|
"description": "The value must be less than or equal to the value.",
|
|
1137
1143
|
"deprecated": ""
|
|
@@ -5099,6 +5105,14 @@
|
|
|
5099
5105
|
"typescript": "import { Component, inject } from '@angular/core';\nimport { ReactiveFormsModule } from '@angular/forms';\nimport { CascadeSelectModule } from '@exhaustive-ui/core/cascadeselect';\nimport { MessageModule } from '@exhaustive-ui/core/message';\nimport { ToastModule } from '@exhaustive-ui/core/toast';\nimport { ButtonModule } from '@exhaustive-ui/core/button';\nimport { MessageService } from '@exhaustive-ui/core/api';\n\n@Component({\n template: `\n <p-toast />\n <div class=\"card flex justify-center\">\n <form [formGroup]=\"exampleForm\" (ngSubmit)=\"onSubmit()\" class=\"flex flex-col gap-4\">\n <div class=\"flex flex-col gap-1\">\n <p-cascadeselect\n formControlName=\"selectedCity\"\n [options]=\"countries\"\n optionLabel=\"cname\"\n optionGroupLabel=\"name\"\n [optionGroupChildren]=\"['states', 'cities']\"\n [style]=\"{ minWidth: '14rem' }\"\n placeholder=\"Select a City\"\n [invalid]=\"isInvalid('selectedCity')\"\n />\n @if (isInvalid('selectedCity')) {\n <p-message severity=\"error\" size=\"small\" variant=\"simple\">City is required.</p-message>\n }\n </div>\n <button pButton severity=\"secondary\" type=\"submit\"><span pButtonLabel>Submit</span></button>\n </form>\n </div>\n `,\n standalone: true,\n imports: [CascadeSelectModule, MessageModule, ToastModule, ButtonModule, ReactiveFormsModule]\n})\nexport class CascadeselectReactiveformsDemo {\n countries: any[] | undefined;\n formGroup: FormGroup | undefined;\n messageService = inject(MessageService);\n exampleForm: FormGroup | undefined;\n formSubmitted: boolean = false;\n\n constructor() {\n this.countries = [\n {\n name: 'Australia',\n code: 'AU',\n states: [\n {\n name: 'New South Wales',\n cities: [\n { cname: 'Sydney', code: 'A-SY' },\n { cname: 'Newcastle', code: 'A-NE' },\n { cname: 'Wollongong', code: 'A-WO' }\n ]\n },\n {\n name: 'Queensland',\n cities: [\n { cname: 'Brisbane', code: 'A-BR' },\n { cname: 'Townsville', code: 'A-TO' }\n ]\n }\n ]\n },\n {\n name: 'Canada',\n code: 'CA',\n states: [\n {\n name: 'Quebec',\n cities: [\n { cname: 'Montreal', code: 'C-MO' },\n { cname: 'Quebec City', code: 'C-QU' }\n ]\n },\n {\n name: 'Ontario',\n cities: [\n { cname: 'Ottawa', code: 'C-OT' },\n { cname: 'Toronto', code: 'C-TO' }\n ]\n }\n ]\n },\n {\n name: 'United States',\n code: 'US',\n states: [\n {\n name: 'California',\n cities: [\n { cname: 'Los Angeles', code: 'US-LA' },\n { cname: 'San Diego', code: 'US-SD' },\n { cname: 'San Francisco', code: 'US-SF' }\n ]\n },\n {\n name: 'Florida',\n cities: [\n { cname: 'Jacksonville', code: 'US-JA' },\n { cname: 'Miami', code: 'US-MI' },\n { cname: 'Tampa', code: 'US-TA' },\n { cname: 'Orlando', code: 'US-OR' }\n ]\n },\n {\n name: 'Texas',\n cities: [\n { cname: 'Austin', code: 'US-AU' },\n { cname: 'Dallas', code: 'US-DA' },\n { cname: 'Houston', code: 'US-HO' }\n ]\n }\n ]\n }\n ];\n this.exampleForm = this.fb.group({\n selectedCity: ['', Validators.required]\n });\n }\n\n onSubmit() {\n this.formSubmitted = true;\n if (this.exampleForm.valid) {\n this.messageService.add({ severity: 'success', summary: 'Success', detail: 'Form is submitted', life: 3000 });\n this.exampleForm.reset();\n this.formSubmitted = false;\n }\n }\n\n isInvalid(controlName: string) {\n const control = this.exampleForm.get(controlName);\n return control?.invalid && this.formSubmitted;\n }\n}"
|
|
5100
5106
|
}
|
|
5101
5107
|
},
|
|
5108
|
+
{
|
|
5109
|
+
"id": "signalforms",
|
|
5110
|
+
"label": "Signal Forms",
|
|
5111
|
+
"description": "CascadeSelect can also be used with Angular Signal Forms , the @angular/forms/signals API of Angular 21 and newer. The form model is a signal, form() declares its validators and the [formField] directive binds the component to a field. The field also sets the invalid state of the component, so the component is styled as invalid before any interaction, while the messages below appear once the field is touched or the form is submitted.",
|
|
5112
|
+
"examples": {
|
|
5113
|
+
"typescript": "import { Component, inject, signal } from '@angular/core';\nimport { form, FormField, required, submit } from '@angular/forms/signals';\nimport { CascadeSelectModule } from '@exhaustive-ui/core/cascadeselect';\nimport { MessageModule } from '@exhaustive-ui/core/message';\nimport { ToastModule } from '@exhaustive-ui/core/toast';\nimport { ButtonModule } from '@exhaustive-ui/core/button';\nimport { MessageService } from '@exhaustive-ui/core/api';\n\n@Component({\n template: `\n <p-toast />\n <div class=\"card flex justify-center\">\n <form novalidate (submit)=\"onSubmit($event)\" class=\"flex flex-col gap-4\">\n <div class=\"flex flex-col gap-1\">\n <p-cascadeselect\n [formField]=\"exampleForm.selectedCity\"\n [options]=\"countries\"\n optionLabel=\"cname\"\n optionValue=\"code\"\n optionGroupLabel=\"name\"\n [optionGroupChildren]=\"['states', 'cities']\"\n [style]=\"{ minWidth: '14rem' }\"\n placeholder=\"Select a City\"\n />\n @let selectedCity = exampleForm.selectedCity();\n @if (selectedCity.invalid() && selectedCity.touched()) {\n <p-message severity=\"error\" size=\"small\" variant=\"simple\">City is required.</p-message>\n }\n </div>\n <button pButton severity=\"secondary\" type=\"submit\"><span pButtonLabel>Submit</span></button>\n </form>\n </div>\n `,\n standalone: true,\n imports: [CascadeSelectModule, MessageModule, ToastModule, ButtonModule, FormField]\n})\nexport class CascadeselectSignalformsDemo {\n messageService = inject(MessageService);\n countries: any[] | undefined;\n model = signal<{ selectedCity: string | null }>({ selectedCity: null });\n exampleForm = form(this.model, (f) => {\n required(f.selectedCity);\n });\n\n constructor() {\n this.countries = [\n {\n name: 'Australia',\n code: 'AU',\n states: [\n {\n name: 'New South Wales',\n cities: [\n { cname: 'Sydney', code: 'A-SY' },\n { cname: 'Newcastle', code: 'A-NE' },\n { cname: 'Wollongong', code: 'A-WO' }\n ]\n },\n {\n name: 'Queensland',\n cities: [\n { cname: 'Brisbane', code: 'A-BR' },\n { cname: 'Townsville', code: 'A-TO' }\n ]\n }\n ]\n },\n {\n name: 'Canada',\n code: 'CA',\n states: [\n {\n name: 'Quebec',\n cities: [\n { cname: 'Montreal', code: 'C-MO' },\n { cname: 'Quebec City', code: 'C-QU' }\n ]\n },\n {\n name: 'Ontario',\n cities: [\n { cname: 'Ottawa', code: 'C-OT' },\n { cname: 'Toronto', code: 'C-TO' }\n ]\n }\n ]\n },\n {\n name: 'United States',\n code: 'US',\n states: [\n {\n name: 'California',\n cities: [\n { cname: 'Los Angeles', code: 'US-LA' },\n { cname: 'San Diego', code: 'US-SD' },\n { cname: 'San Francisco', code: 'US-SF' }\n ]\n },\n {\n name: 'Florida',\n cities: [\n { cname: 'Jacksonville', code: 'US-JA' },\n { cname: 'Miami', code: 'US-MI' },\n { cname: 'Tampa', code: 'US-TA' },\n { cname: 'Orlando', code: 'US-OR' }\n ]\n },\n {\n name: 'Texas',\n cities: [\n { cname: 'Austin', code: 'US-AU' },\n { cname: 'Dallas', code: 'US-DA' },\n { cname: 'Houston', code: 'US-HO' }\n ]\n }\n ]\n }\n ];\n }\n\n onSubmit(event: Event) {\n event.preventDefault();\n submit(this.exampleForm, async () => {\n this.messageService.add({ severity: 'success', summary: 'Success', detail: 'Form is submitted', life: 3000 });\n this.exampleForm().reset({ selectedCity: null });\n });\n }\n}"
|
|
5114
|
+
}
|
|
5115
|
+
},
|
|
5102
5116
|
{
|
|
5103
5117
|
"id": "sizes",
|
|
5104
5118
|
"label": "Sizes",
|
|
@@ -5296,7 +5310,7 @@
|
|
|
5296
5310
|
},
|
|
5297
5311
|
{
|
|
5298
5312
|
"name": "value",
|
|
5299
|
-
"type": "ModelSignal<
|
|
5313
|
+
"type": "ModelSignal<any>",
|
|
5300
5314
|
"default": "...",
|
|
5301
5315
|
"description": "Selected value of the component.",
|
|
5302
5316
|
"deprecated": ""
|
|
@@ -6314,6 +6328,14 @@
|
|
|
6314
6328
|
"typescript": "import { Component, inject } from '@angular/core';\nimport { ReactiveFormsModule } from '@angular/forms';\nimport { CheckboxModule } from '@exhaustive-ui/core/checkbox';\nimport { MessageModule } from '@exhaustive-ui/core/message';\nimport { ToastModule } from '@exhaustive-ui/core/toast';\nimport { ButtonModule } from '@exhaustive-ui/core/button';\nimport { MessageService } from '@exhaustive-ui/core/api';\n\n@Component({\n template: `\n <p-toast />\n <div class=\"card flex justify-center\">\n <form [formGroup]=\"exampleForm\" (ngSubmit)=\"onSubmit()\" class=\"flex flex-col gap-4\">\n <div class=\"flex flex-wrap gap-4\">\n @for (item of formKeys; track item) {\n <div class=\"flex items-center gap-2\">\n <p-checkbox [formControlName]=\"item\" [binary]=\"true\" [inputId]=\"item\" [invalid]=\"isInvalid(item)\" />\n <label [for]=\"item\"> {{ item | titlecase }} </label>\n </div>\n }\n </div>\n @if (hasAnyInvalid()) {\n <p-message severity=\"error\" size=\"small\" variant=\"simple\"> At least one ingredient must be selected. </p-message>\n }\n <button pButton severity=\"secondary\" type=\"submit\">\n <span pButtonLabel>Submit</span>\n </button>\n </form>\n </div>\n `,\n standalone: true,\n imports: [CheckboxModule, MessageModule, ToastModule, ButtonModule, ReactiveFormsModule]\n})\nexport class CheckboxReactiveformsDemo {\n messageService = inject(MessageService);\n formSubmitted: boolean = false;\n exampleForm: FormGroup;\n\n constructor() {\n this.exampleForm = this.fb.group(\n {\n cheese: [false],\n mushroom: [false],\n pepper: [false],\n onion: [false]\n },\n { validators: this.atLeastOneSelectedValidator }\n );\n }\n\n atLeastOneSelectedValidator(group: FormGroup) {\n [key: string]: any } | null {\n const anySelected = Object.values(group.controls).some((control) => control.value === true);\n return anySelected ? null : { atLeastOneRequired: true };\n }\n\n hasAnyInvalid(): boolean {\n return this.formSubmitted && this.exampleForm.hasError('atLeastOneRequired');\n }\n\n isInvalid(controlName: string): boolean {\n const control = this.exampleForm.get(controlName);\n return this.formSubmitted && this.exampleForm.hasError('atLeastOneRequired') && control?.value === false;\n }\n\n onSubmit() {\n this.formSubmitted = true;\n \n if (this.exampleForm.valid) {\n this.messageService.add({\n severity: 'success',\n summary: 'Success',\n detail: 'Form is submitted',\n life: 3000\n });\n \n this.exampleForm.reset({\n cheese: false,\n mushroom: false,\n pepper: false,\n onion: false\n });\n \n this.formSubmitted = false;\n }\n }\n}"
|
|
6315
6329
|
}
|
|
6316
6330
|
},
|
|
6331
|
+
{
|
|
6332
|
+
"id": "signalforms",
|
|
6333
|
+
"label": "Signal Forms",
|
|
6334
|
+
"description": "Checkbox can also be used with Angular Signal Forms , the @angular/forms/signals API of Angular 21 and newer. The form model is a signal, form() declares its validators and the [formField] directive binds the component to a field. The field also sets the invalid state of the component, so the component is styled as invalid before any interaction, while the messages below appear once the field is touched or the form is submitted.",
|
|
6335
|
+
"examples": {
|
|
6336
|
+
"typescript": "import { Component, inject, signal } from '@angular/core';\nimport { form, FormField, submit, validate } from '@angular/forms/signals';\nimport { CheckboxModule } from '@exhaustive-ui/core/checkbox';\nimport { MessageModule } from '@exhaustive-ui/core/message';\nimport { ToastModule } from '@exhaustive-ui/core/toast';\nimport { ButtonModule } from '@exhaustive-ui/core/button';\nimport { MessageService } from '@exhaustive-ui/core/api';\n\ntype Ingredient = 'cheese' | 'mushroom' | 'pepper' | 'onion';\n\n@Component({\n template: `\n <p-toast />\n <div class=\"card flex justify-center\">\n <form novalidate (submit)=\"onSubmit($event)\" class=\"flex flex-col gap-4\">\n <div class=\"flex flex-wrap gap-4\">\n @for (item of formKeys; track item) {\n <div class=\"flex items-center gap-2\">\n <p-checkbox [formField]=\"exampleForm[item]\" [binary]=\"true\" [inputId]=\"item\" />\n <label [for]=\"item\" class=\"capitalize\"> {{ item }} </label>\n </div>\n }\n </div>\n @if (exampleForm().invalid() && exampleForm().touched()) {\n <p-message severity=\"error\" size=\"small\" variant=\"simple\"> At least one ingredient must be selected. </p-message>\n }\n <button pButton severity=\"secondary\" type=\"submit\"><span pButtonLabel>Submit</span></button>\n </form>\n </div>\n `,\n standalone: true,\n imports: [CheckboxModule, MessageModule, ToastModule, ButtonModule, FormField]\n})\nexport class CheckboxSignalformsDemo {\n messageService = inject(MessageService);\n formKeys: Ingredient[] = ['cheese', 'mushroom', 'pepper', 'onion'];\n model = signal({ cheese: false, mushroom: false, pepper: false, onion: false });\n exampleForm = form(this.model, (f) => {\n validate(f, ({ value }) => (Object.values(value()).some(Boolean) ? null : { kind: 'atLeastOneRequired' }));\n });\n\n onSubmit(event: Event) {\n event.preventDefault();\n submit(this.exampleForm, async () => {\n this.messageService.add({ severity: 'success', summary: 'Success', detail: 'Form is submitted', life: 3000 });\n this.exampleForm().reset({ cheese: false, mushroom: false, pepper: false, onion: false });\n });\n }\n}"
|
|
6337
|
+
}
|
|
6338
|
+
},
|
|
6317
6339
|
{
|
|
6318
6340
|
"id": "sizes",
|
|
6319
6341
|
"label": "Sizes",
|
|
@@ -7155,6 +7177,14 @@
|
|
|
7155
7177
|
"typescript": "import { Component, inject } from '@angular/core';\nimport { ReactiveFormsModule } from '@angular/forms';\nimport { ColorPickerModule } from '@exhaustive-ui/core/colorpicker';\nimport { MessageModule } from '@exhaustive-ui/core/message';\nimport { ToastModule } from '@exhaustive-ui/core/toast';\nimport { ButtonModule } from '@exhaustive-ui/core/button';\nimport { MessageService } from '@exhaustive-ui/core/api';\n\n@Component({\n template: `\n <div class=\"card flex justify-center\">\n <p-toast />\n <form [formGroup]=\"exampleForm\" (ngSubmit)=\"onSubmit()\" class=\"flex flex-col gap-4\">\n <div class=\"flex flex-col items-center gap-2\">\n <p-colorpicker formControlName=\"color\" defaultColor=\"989898\" />\n @if (isInvalid('color')) {\n <p-message severity=\"error\" size=\"small\" variant=\"simple\">Color is required.</p-message>\n }\n </div>\n <button pButton severity=\"secondary\" type=\"submit\"><span pButtonLabel>Submit</span></button>\n </form>\n </div>\n `,\n standalone: true,\n imports: [ColorPickerModule, MessageModule, ToastModule, ButtonModule, ReactiveFormsModule]\n})\nexport class ColorpickerReactiveformsDemo {\n messageService = inject(MessageService);\n exampleForm: FormGroup;\n formSubmitted: boolean = false;\n\n constructor() {\n this.exampleForm = this.fb.group({\n color: ['', Validators.required]\n });\n }\n\n onSubmit() {\n this.formSubmitted = true;\n if (this.exampleForm.valid) {\n this.messageService.add({ severity: 'success', summary: 'Success', detail: 'Form is submitted', life: 3000 });\n this.exampleForm.reset();\n this.formSubmitted = false;\n }\n }\n\n isInvalid(controlName: string) {\n const control = this.exampleForm.get(controlName);\n return control?.invalid && this.formSubmitted;\n }\n}"
|
|
7156
7178
|
}
|
|
7157
7179
|
},
|
|
7180
|
+
{
|
|
7181
|
+
"id": "signalforms",
|
|
7182
|
+
"label": "Signal Forms",
|
|
7183
|
+
"description": "ColorPicker can also be used with Angular Signal Forms , the @angular/forms/signals API of Angular 21 and newer. The form model is a signal, form() declares its validators and the [formField] directive binds the component to a field. The field also sets the invalid state of the component, so the component is styled as invalid before any interaction, while the messages below appear once the field is touched or the form is submitted.",
|
|
7184
|
+
"examples": {
|
|
7185
|
+
"typescript": "import { Component, inject, signal } from '@angular/core';\nimport { form, FormField, required, submit } from '@angular/forms/signals';\nimport { ColorPickerModule } from '@exhaustive-ui/core/colorpicker';\nimport { MessageModule } from '@exhaustive-ui/core/message';\nimport { ToastModule } from '@exhaustive-ui/core/toast';\nimport { ButtonModule } from '@exhaustive-ui/core/button';\nimport { MessageService } from '@exhaustive-ui/core/api';\n\n@Component({\n template: `\n <p-toast />\n <div class=\"card flex justify-center\">\n <form novalidate (submit)=\"onSubmit($event)\" class=\"flex flex-col gap-4\">\n <div class=\"flex flex-col items-center gap-2\">\n <p-colorpicker [formField]=\"exampleForm.color\" defaultColor=\"989898\" />\n @let color = exampleForm.color();\n @if (color.invalid() && color.touched()) {\n <p-message severity=\"error\" size=\"small\" variant=\"simple\">Color is required.</p-message>\n }\n </div>\n <button pButton severity=\"secondary\" type=\"submit\"><span pButtonLabel>Submit</span></button>\n </form>\n </div>\n `,\n standalone: true,\n imports: [ColorPickerModule, MessageModule, ToastModule, ButtonModule, FormField]\n})\nexport class ColorpickerSignalformsDemo {\n messageService = inject(MessageService);\n model = signal({ color: '' });\n exampleForm = form(this.model, (f) => {\n required(f.color);\n });\n\n onSubmit(event: Event) {\n event.preventDefault();\n submit(this.exampleForm, async () => {\n this.messageService.add({ severity: 'success', summary: 'Success', detail: 'Form is submitted', life: 3000 });\n this.exampleForm().reset({ color: '' });\n });\n }\n}"
|
|
7186
|
+
}
|
|
7187
|
+
},
|
|
7158
7188
|
{
|
|
7159
7189
|
"id": "templatedrivenforms",
|
|
7160
7190
|
"label": "templatedrivenforms-doc",
|
|
@@ -7959,7 +7989,7 @@
|
|
|
7959
7989
|
"label": "props-doc",
|
|
7960
7990
|
"description": "",
|
|
7961
7991
|
"examples": {
|
|
7962
|
-
"typescript": "import { Component } from '@angular/core';\n\n@Component({\n template: `\n <div class=\"doc-tablewrapper\">\n <table class=\"doc-table\">\n <thead>\n <tr>\n <th>Name</th>\n <th>Type</th>\n <th>Default</th>\n <th>Description</th>\n </tr>\n </thead>\n <tbody>\n <tr>\n <td>key</td>\n <td>string</td>\n <td>null</td>\n <td>Optional key to match the key of confirm object, necessary to use when component tree has multiple confirm dialogs.</td>\n </tr>\n <tr>\n <td>autoZIndex</td>\n <td>boolean</td>\n <td>true</td>\n <td>Whether to automatically manage layering.</td>\n </tr>\n <tr>\n <td>
|
|
7992
|
+
"typescript": "import { Component } from '@angular/core';\n\n@Component({\n template: `\n <div class=\"doc-tablewrapper\">\n <table class=\"doc-table\">\n <thead>\n <tr>\n <th>Name</th>\n <th>Type</th>\n <th>Default</th>\n <th>Description</th>\n </tr>\n </thead>\n <tbody>\n <tr>\n <td>key</td>\n <td>string</td>\n <td>null</td>\n <td>Optional key to match the key of confirm object, necessary to use when component tree has multiple confirm dialogs.</td>\n </tr>\n <tr>\n <td>autoZIndex</td>\n <td>boolean</td>\n <td>true</td>\n <td>Whether to automatically manage layering.</td>\n </tr>\n <tr>\n <td>style</td>\n <td>string</td>\n <td>null</td>\n <td>Inline style of the component.</td>\n </tr>\n <tr>\n <td>styleClass</td>\n <td>string</td>\n <td>null</td>\n <td>Style class of the component.</td>\n </tr>\n </tbody>\n </table>\n </div>\n `,\n standalone: true,\n imports: []\n})\nexport class ConfirmpopupPropsDemo {}"
|
|
7963
7993
|
}
|
|
7964
7994
|
},
|
|
7965
7995
|
{
|
|
@@ -8030,13 +8060,6 @@
|
|
|
8030
8060
|
"description": "Whether to automatically manage layering.",
|
|
8031
8061
|
"deprecated": ""
|
|
8032
8062
|
},
|
|
8033
|
-
{
|
|
8034
|
-
"name": "baseZIndex",
|
|
8035
|
-
"type": "InputSignalWithTransform<number, unknown>",
|
|
8036
|
-
"default": "...",
|
|
8037
|
-
"description": "Base zIndex value to use in layering.",
|
|
8038
|
-
"deprecated": ""
|
|
8039
|
-
},
|
|
8040
8063
|
{
|
|
8041
8064
|
"name": "style",
|
|
8042
8065
|
"type": "InputSignal<{ [klass: string]: any }>",
|
|
@@ -8908,20 +8931,6 @@
|
|
|
8908
8931
|
"description": "Text to display when there is no data. Defaults to global value in i18n translation configuration.",
|
|
8909
8932
|
"deprecated": ""
|
|
8910
8933
|
},
|
|
8911
|
-
{
|
|
8912
|
-
"name": "gridStyleClass",
|
|
8913
|
-
"type": "InputSignal<string>",
|
|
8914
|
-
"default": "...",
|
|
8915
|
-
"description": "Style class of the grid.",
|
|
8916
|
-
"deprecated": ""
|
|
8917
|
-
},
|
|
8918
|
-
{
|
|
8919
|
-
"name": "trackBy",
|
|
8920
|
-
"type": "InputSignal<Function>",
|
|
8921
|
-
"default": "...",
|
|
8922
|
-
"description": "Function to optimize the dom operations by delegating to ngForTrackBy, default algorithm checks for object identity.",
|
|
8923
|
-
"deprecated": ""
|
|
8924
|
-
},
|
|
8925
8934
|
{
|
|
8926
8935
|
"name": "filterBy",
|
|
8927
8936
|
"type": "InputSignal<string>",
|
|
@@ -9493,6 +9502,14 @@
|
|
|
9493
9502
|
"typescript": "import { Component, inject } from '@angular/core';\nimport { ReactiveFormsModule } from '@angular/forms';\nimport { DatePickerModule } from '@exhaustive-ui/core/datepicker';\nimport { MessageModule } from '@exhaustive-ui/core/message';\nimport { ToastModule } from '@exhaustive-ui/core/toast';\nimport { ButtonModule } from '@exhaustive-ui/core/button';\nimport { MessageService } from '@exhaustive-ui/core/api';\n\n@Component({\n template: `\n <p-toast />\n <div class=\"card flex justify-center\">\n <form [formGroup]=\"exampleForm\" (ngSubmit)=\"onSubmit()\" class=\"flex flex-col gap-4\">\n <div class=\"flex flex-col gap-1\">\n <p-datepicker formControlName=\"selectedDate\" [invalid]=\"isInvalid('selectedDate')\" />\n @if (isInvalid('selectedDate')) {\n <p-message severity=\"error\" size=\"small\" variant=\"simple\">Date is required.</p-message>\n }\n </div>\n <button pButton severity=\"secondary\" type=\"submit\"><span pButtonLabel>Submit</span></button>\n </form>\n </div>\n `,\n standalone: true,\n imports: [DatePickerModule, MessageModule, ToastModule, ButtonModule, ReactiveFormsModule]\n})\nexport class DatepickerReactiveformsDemo {\n messageService = inject(MessageService);\n exampleForm: FormGroup | undefined;\n formSubmitted: boolean = false;\n\n constructor() {\n this.exampleForm = this.fb.group({\n selectedDate: ['', Validators.required]\n });\n }\n\n onSubmit() {\n this.formSubmitted = true;\n if (this.exampleForm.valid) {\n this.messageService.add({ severity: 'success', summary: 'Success', detail: 'Form is submitted', life: 3000 });\n this.exampleForm.reset();\n this.formSubmitted = false;\n }\n }\n\n isInvalid(controlName: string) {\n const control = this.exampleForm.get(controlName);\n return control?.invalid && (control.touched || this.formSubmitted);\n }\n}"
|
|
9494
9503
|
}
|
|
9495
9504
|
},
|
|
9505
|
+
{
|
|
9506
|
+
"id": "signalforms",
|
|
9507
|
+
"label": "Signal Forms",
|
|
9508
|
+
"description": "DatePicker can also be used with Angular Signal Forms , the @angular/forms/signals API of Angular 21 and newer. The form model is a signal, form() declares its validators and the [formField] directive binds the component to a field. The field also sets the invalid state of the component, so the component is styled as invalid before any interaction, while the messages below appear once the field is touched or the form is submitted.",
|
|
9509
|
+
"examples": {
|
|
9510
|
+
"typescript": "import { Component, inject, signal } from '@angular/core';\nimport { form, FormField, required, submit } from '@angular/forms/signals';\nimport { DatePickerModule } from '@exhaustive-ui/core/datepicker';\nimport { MessageModule } from '@exhaustive-ui/core/message';\nimport { ToastModule } from '@exhaustive-ui/core/toast';\nimport { ButtonModule } from '@exhaustive-ui/core/button';\nimport { MessageService } from '@exhaustive-ui/core/api';\n\n@Component({\n template: `\n <p-toast />\n <div class=\"card flex justify-center\">\n <form novalidate (submit)=\"onSubmit($event)\" class=\"flex flex-col gap-4\">\n <div class=\"flex flex-col gap-1\">\n <p-datepicker [formField]=\"exampleForm.selectedDate\" />\n @let selectedDate = exampleForm.selectedDate();\n @if (selectedDate.invalid() && selectedDate.touched()) {\n <p-message severity=\"error\" size=\"small\" variant=\"simple\">Date is required.</p-message>\n }\n </div>\n <button pButton severity=\"secondary\" type=\"submit\"><span pButtonLabel>Submit</span></button>\n </form>\n </div>\n `,\n standalone: true,\n imports: [DatePickerModule, MessageModule, ToastModule, ButtonModule, FormField]\n})\nexport class DatepickerSignalformsDemo {\n messageService = inject(MessageService);\n model = signal<{ selectedDate: Date | null }>({ selectedDate: null });\n exampleForm = form(this.model, (f) => {\n required(f.selectedDate);\n });\n\n onSubmit(event: Event) {\n event.preventDefault();\n submit(this.exampleForm, async () => {\n this.messageService.add({ severity: 'success', summary: 'Success', detail: 'Form is submitted', life: 3000 });\n this.exampleForm().reset({ selectedDate: null });\n });\n }\n}"
|
|
9511
|
+
}
|
|
9512
|
+
},
|
|
9496
9513
|
{
|
|
9497
9514
|
"id": "sizes",
|
|
9498
9515
|
"label": "Sizes",
|
|
@@ -9638,21 +9655,21 @@
|
|
|
9638
9655
|
},
|
|
9639
9656
|
{
|
|
9640
9657
|
"name": "pattern",
|
|
9641
|
-
"type": "
|
|
9658
|
+
"type": "InputSignalWithTransform<string, string | readonly RegExp[]>",
|
|
9642
9659
|
"default": "undefined",
|
|
9643
9660
|
"description": "Specifies the value must match the pattern.",
|
|
9644
9661
|
"deprecated": ""
|
|
9645
9662
|
},
|
|
9646
9663
|
{
|
|
9647
9664
|
"name": "min",
|
|
9648
|
-
"type": "
|
|
9665
|
+
"type": "InputSignalWithTransform<number, unknown>",
|
|
9649
9666
|
"default": "undefined",
|
|
9650
9667
|
"description": "The value must be greater than or equal to the value.",
|
|
9651
9668
|
"deprecated": ""
|
|
9652
9669
|
},
|
|
9653
9670
|
{
|
|
9654
9671
|
"name": "max",
|
|
9655
|
-
"type": "
|
|
9672
|
+
"type": "InputSignalWithTransform<number, unknown>",
|
|
9656
9673
|
"default": "undefined",
|
|
9657
9674
|
"description": "The value must be less than or equal to the value.",
|
|
9658
9675
|
"deprecated": ""
|
|
@@ -12448,7 +12465,7 @@
|
|
|
12448
12465
|
"deprecated": ""
|
|
12449
12466
|
},
|
|
12450
12467
|
{
|
|
12451
|
-
"name": "
|
|
12468
|
+
"name": "closeAriaLabel",
|
|
12452
12469
|
"type": "InputSignal<string>",
|
|
12453
12470
|
"default": "...",
|
|
12454
12471
|
"description": "Aria label of the close icon.",
|
|
@@ -12852,6 +12869,14 @@
|
|
|
12852
12869
|
"typescript": "import { Component } from '@angular/core';\nimport { FormsModule } from '@angular/forms';\nimport { EditorModule } from '@exhaustive-ui/core/editor';\n\n@Component({\n template: `\n <div class=\"card\">\n <p-editor [(ngModel)]=\"text\" [readonly]=\"true\" [style]=\"{ height: '320px' }\" />\n </div>\n `,\n standalone: true,\n imports: [EditorModule, FormsModule]\n})\nexport class EditorReadonlyDemo {\n text: string = 'Always bet on Prime!';\n}"
|
|
12853
12870
|
}
|
|
12854
12871
|
},
|
|
12872
|
+
{
|
|
12873
|
+
"id": "signalforms",
|
|
12874
|
+
"label": "Signal Forms",
|
|
12875
|
+
"description": "Editor can also be used with Angular Signal Forms , the @angular/forms/signals API of Angular 21 and newer. The form model is a signal, form() declares its validators and the [formField] directive binds the component to a field. The field also sets the invalid state of the component, so the component is styled as invalid before any interaction, while the messages below appear once the field is touched or the form is submitted.",
|
|
12876
|
+
"examples": {
|
|
12877
|
+
"typescript": "import { Component, inject, signal } from '@angular/core';\nimport { form, FormField, required, submit } from '@angular/forms/signals';\nimport { EditorModule } from '@exhaustive-ui/core/editor';\nimport { MessageModule } from '@exhaustive-ui/core/message';\nimport { ToastModule } from '@exhaustive-ui/core/toast';\nimport { ButtonModule } from '@exhaustive-ui/core/button';\nimport { MessageService } from '@exhaustive-ui/core/api';\n\n@Component({\n template: `\n <p-toast />\n <div class=\"card\">\n <form novalidate (submit)=\"onSubmit($event)\" class=\"flex flex-col gap-4\">\n <div class=\"flex flex-col gap-1\">\n <p-editor [formField]=\"exampleForm.text\" [style]=\"{ height: '320px' }\" />\n @let text = exampleForm.text();\n @if (text.invalid() && text.touched()) {\n <p-message severity=\"error\" size=\"small\" variant=\"simple\">Content is required.</p-message>\n }\n </div>\n <button pButton severity=\"secondary\" type=\"submit\"><span pButtonLabel>Submit</span></button>\n </form>\n </div>\n `,\n standalone: true,\n imports: [EditorModule, MessageModule, ToastModule, ButtonModule, FormField]\n})\nexport class EditorSignalformsDemo {\n messageService = inject(MessageService);\n model = signal({ text: '' });\n exampleForm = form(this.model, (f) => {\n required(f.text);\n });\n\n onSubmit(event: Event) {\n event.preventDefault();\n submit(this.exampleForm, async () => {\n this.messageService.add({ severity: 'success', summary: 'Success', detail: 'Form is submitted', life: 3000 });\n this.exampleForm().reset({ text: '' });\n });\n }\n}"
|
|
12878
|
+
}
|
|
12879
|
+
},
|
|
12855
12880
|
{
|
|
12856
12881
|
"id": "templatedrivenforms",
|
|
12857
12882
|
"label": "templatedrivenforms-doc",
|
|
@@ -14467,6 +14492,14 @@
|
|
|
14467
14492
|
"typescript": "import { Component } from '@angular/core';\nimport { FormsModule } from '@angular/forms';\nimport { FloatLabelModule } from '@exhaustive-ui/core/floatlabel';\nimport { InputTextModule } from '@exhaustive-ui/core/inputtext';\n\n@Component({\n template: `\n <div class=\"card flex flex-wrap justify-center items-end gap-4\">\n <p-floatlabel>\n <input pInputText id=\"value1\" [(ngModel)]=\"value1\" [invalid]=\"!value1\" autocomplete=\"off\" />\n <label for=\"value1\">Username</label>\n </p-floatlabel>\n <p-floatlabel variant=\"in\">\n <input pInputText id=\"value2\" [(ngModel)]=\"value2\" [invalid]=\"!value2\" autocomplete=\"off\" />\n <label for=\"value2\">Username</label>\n </p-floatlabel>\n <p-floatlabel variant=\"on\">\n <input pInputText id=\"value3\" [(ngModel)]=\"value3\" [invalid]=\"!value3\" autocomplete=\"off\" />\n <label for=\"value3\">Username</label>\n </p-floatlabel>\n </div>\n `,\n standalone: true,\n imports: [FloatLabelModule, InputTextModule, FormsModule]\n})\nexport class FloatlabelInvalidDemo {\n value1: string | undefined;\n value2: string | undefined;\n value3: string | undefined;\n}"
|
|
14468
14493
|
}
|
|
14469
14494
|
},
|
|
14495
|
+
{
|
|
14496
|
+
"id": "sizes",
|
|
14497
|
+
"label": "Sizes",
|
|
14498
|
+
"description": "The label follows the small and large sizes of the field it wraps, in every variant: its inset, its font size and, for the in variant, the vertical room left for it.",
|
|
14499
|
+
"examples": {
|
|
14500
|
+
"typescript": "import { Component } from '@angular/core';\nimport { FormsModule } from '@angular/forms';\nimport { SelectModule } from '@exhaustive-ui/core/select';\nimport { FloatLabelModule } from '@exhaustive-ui/core/floatlabel';\nimport { InputTextModule } from '@exhaustive-ui/core/inputtext';\n\n@Component({\n template: `\n <div class=\"card flex flex-col items-center gap-6\">\n <div class=\"flex flex-wrap justify-center items-end gap-4\">\n <p-floatlabel variant=\"in\">\n <input pInputText id=\"small_input\" pSize=\"small\" [(ngModel)]=\"value1\" autocomplete=\"off\" />\n <label for=\"small_input\">Small</label>\n </p-floatlabel>\n <p-floatlabel variant=\"in\">\n <input pInputText id=\"normal_input\" [(ngModel)]=\"value2\" autocomplete=\"off\" />\n <label for=\"normal_input\">Normal</label>\n </p-floatlabel>\n <p-floatlabel variant=\"in\">\n <input pInputText id=\"large_input\" pSize=\"large\" [(ngModel)]=\"value3\" autocomplete=\"off\" />\n <label for=\"large_input\">Large</label>\n </p-floatlabel>\n </div>\n <div class=\"flex flex-wrap justify-center items-end gap-4\">\n <p-floatlabel variant=\"on\">\n <p-select [(ngModel)]=\"city1\" inputId=\"small_select\" [options]=\"cities\" size=\"small\" class=\"w-56\" />\n <label for=\"small_select\">Small</label>\n </p-floatlabel>\n <p-floatlabel variant=\"on\">\n <p-select [(ngModel)]=\"city2\" inputId=\"normal_select\" [options]=\"cities\" class=\"w-56\" />\n <label for=\"normal_select\">Normal</label>\n </p-floatlabel>\n <p-floatlabel variant=\"on\">\n <p-select [(ngModel)]=\"city3\" inputId=\"large_select\" [options]=\"cities\" size=\"large\" class=\"w-56\" />\n <label for=\"large_select\">Large</label>\n </p-floatlabel>\n </div>\n </div>\n `,\n standalone: true,\n imports: [SelectModule, FloatLabelModule, InputTextModule, FormsModule]\n})\nexport class FloatlabelSizesDemo {\n value1: string | undefined;\n value2: string | undefined;\n value3: string | undefined;\n city1: string | undefined;\n city2: string | undefined;\n city3: string | undefined;\n cities: any[] = ['New York', 'Rome', 'London', 'Istanbul', 'Paris'];\n}"
|
|
14501
|
+
}
|
|
14502
|
+
},
|
|
14470
14503
|
{
|
|
14471
14504
|
"id": "variants",
|
|
14472
14505
|
"label": "Variants",
|
|
@@ -14586,6 +14619,46 @@
|
|
|
14586
14619
|
"variable": "--p-floatlabel-active-font-weight",
|
|
14587
14620
|
"description": "Active font weight of root"
|
|
14588
14621
|
},
|
|
14622
|
+
{
|
|
14623
|
+
"token": "floatlabel.sm.position.x",
|
|
14624
|
+
"variable": "--p-floatlabel-sm-position-x",
|
|
14625
|
+
"description": "Sm position x of root"
|
|
14626
|
+
},
|
|
14627
|
+
{
|
|
14628
|
+
"token": "floatlabel.sm.position.y",
|
|
14629
|
+
"variable": "--p-floatlabel-sm-position-y",
|
|
14630
|
+
"description": "Sm position y of root"
|
|
14631
|
+
},
|
|
14632
|
+
{
|
|
14633
|
+
"token": "floatlabel.sm.font.size",
|
|
14634
|
+
"variable": "--p-floatlabel-sm-font-size",
|
|
14635
|
+
"description": "Sm font size of root"
|
|
14636
|
+
},
|
|
14637
|
+
{
|
|
14638
|
+
"token": "floatlabel.sm.active.font.size",
|
|
14639
|
+
"variable": "--p-floatlabel-sm-active-font-size",
|
|
14640
|
+
"description": "Sm active font size of root"
|
|
14641
|
+
},
|
|
14642
|
+
{
|
|
14643
|
+
"token": "floatlabel.lg.position.x",
|
|
14644
|
+
"variable": "--p-floatlabel-lg-position-x",
|
|
14645
|
+
"description": "Lg position x of root"
|
|
14646
|
+
},
|
|
14647
|
+
{
|
|
14648
|
+
"token": "floatlabel.lg.position.y",
|
|
14649
|
+
"variable": "--p-floatlabel-lg-position-y",
|
|
14650
|
+
"description": "Lg position y of root"
|
|
14651
|
+
},
|
|
14652
|
+
{
|
|
14653
|
+
"token": "floatlabel.lg.font.size",
|
|
14654
|
+
"variable": "--p-floatlabel-lg-font-size",
|
|
14655
|
+
"description": "Lg font size of root"
|
|
14656
|
+
},
|
|
14657
|
+
{
|
|
14658
|
+
"token": "floatlabel.lg.active.font.size",
|
|
14659
|
+
"variable": "--p-floatlabel-lg-active-font-size",
|
|
14660
|
+
"description": "Lg active font size of root"
|
|
14661
|
+
},
|
|
14589
14662
|
{
|
|
14590
14663
|
"token": "floatlabel.over.active.top",
|
|
14591
14664
|
"variable": "--p-floatlabel-over-active-top",
|
|
@@ -14606,6 +14679,36 @@
|
|
|
14606
14679
|
"variable": "--p-floatlabel-in-active-top",
|
|
14607
14680
|
"description": "Active top of in"
|
|
14608
14681
|
},
|
|
14682
|
+
{
|
|
14683
|
+
"token": "floatlabel.in.sm.input.padding.top",
|
|
14684
|
+
"variable": "--p-floatlabel-in-sm-input-padding-top",
|
|
14685
|
+
"description": "Sm input padding top of in"
|
|
14686
|
+
},
|
|
14687
|
+
{
|
|
14688
|
+
"token": "floatlabel.in.sm.input.padding.bottom",
|
|
14689
|
+
"variable": "--p-floatlabel-in-sm-input-padding-bottom",
|
|
14690
|
+
"description": "Sm input padding bottom of in"
|
|
14691
|
+
},
|
|
14692
|
+
{
|
|
14693
|
+
"token": "floatlabel.in.sm.active.top",
|
|
14694
|
+
"variable": "--p-floatlabel-in-sm-active-top",
|
|
14695
|
+
"description": "Sm active top of in"
|
|
14696
|
+
},
|
|
14697
|
+
{
|
|
14698
|
+
"token": "floatlabel.in.lg.input.padding.top",
|
|
14699
|
+
"variable": "--p-floatlabel-in-lg-input-padding-top",
|
|
14700
|
+
"description": "Lg input padding top of in"
|
|
14701
|
+
},
|
|
14702
|
+
{
|
|
14703
|
+
"token": "floatlabel.in.lg.input.padding.bottom",
|
|
14704
|
+
"variable": "--p-floatlabel-in-lg-input-padding-bottom",
|
|
14705
|
+
"description": "Lg input padding bottom of in"
|
|
14706
|
+
},
|
|
14707
|
+
{
|
|
14708
|
+
"token": "floatlabel.in.lg.active.top",
|
|
14709
|
+
"variable": "--p-floatlabel-in-lg-active-top",
|
|
14710
|
+
"description": "Lg active top of in"
|
|
14711
|
+
},
|
|
14609
14712
|
{
|
|
14610
14713
|
"token": "floatlabel.on.border.radius",
|
|
14611
14714
|
"variable": "--p-floatlabel-on-border-radius",
|
|
@@ -15840,6 +15943,14 @@
|
|
|
15840
15943
|
"examples": {
|
|
15841
15944
|
"typescript": "import { Component } from '@angular/core';\nimport { FormsModule } from '@angular/forms';\nimport { IftaLabelModule } from '@exhaustive-ui/core/iftalabel';\nimport { InputTextModule } from '@exhaustive-ui/core/inputtext';\n\n@Component({\n template: `\n <div class=\"card flex justify-center\">\n <p-iftalabel>\n <input pInputText id=\"username\" [(ngModel)]=\"value\" [invalid]=\"!value\" autocomplete=\"off\" />\n <label for=\"username\">Username</label>\n </p-iftalabel>\n </div>\n `,\n standalone: true,\n imports: [IftaLabelModule, InputTextModule, FormsModule]\n})\nexport class IftalabelInvalidDemo {\n value: string | undefined;\n}"
|
|
15842
15945
|
}
|
|
15946
|
+
},
|
|
15947
|
+
{
|
|
15948
|
+
"id": "sizes",
|
|
15949
|
+
"label": "Sizes",
|
|
15950
|
+
"description": "The label follows the small and large sizes of the field it wraps: its inset, its font size and the vertical room left for it.",
|
|
15951
|
+
"examples": {
|
|
15952
|
+
"typescript": "import { Component } from '@angular/core';\nimport { FormsModule } from '@angular/forms';\nimport { SelectModule } from '@exhaustive-ui/core/select';\nimport { IftaLabelModule } from '@exhaustive-ui/core/iftalabel';\nimport { InputTextModule } from '@exhaustive-ui/core/inputtext';\n\n@Component({\n template: `\n <div class=\"card flex flex-col items-center gap-6\">\n <div class=\"flex flex-wrap justify-center items-end gap-4\">\n <p-iftalabel>\n <input pInputText id=\"small_input\" pSize=\"small\" [(ngModel)]=\"value1\" autocomplete=\"off\" />\n <label for=\"small_input\">Small</label>\n </p-iftalabel>\n <p-iftalabel>\n <input pInputText id=\"normal_input\" [(ngModel)]=\"value2\" autocomplete=\"off\" />\n <label for=\"normal_input\">Normal</label>\n </p-iftalabel>\n <p-iftalabel>\n <input pInputText id=\"large_input\" pSize=\"large\" [(ngModel)]=\"value3\" autocomplete=\"off\" />\n <label for=\"large_input\">Large</label>\n </p-iftalabel>\n </div>\n <div class=\"flex flex-wrap justify-center items-end gap-4\">\n <p-iftalabel>\n <p-select [(ngModel)]=\"city1\" inputId=\"small_select\" [options]=\"cities\" size=\"small\" class=\"w-56\" />\n <label for=\"small_select\">Small</label>\n </p-iftalabel>\n <p-iftalabel>\n <p-select [(ngModel)]=\"city2\" inputId=\"normal_select\" [options]=\"cities\" class=\"w-56\" />\n <label for=\"normal_select\">Normal</label>\n </p-iftalabel>\n <p-iftalabel>\n <p-select [(ngModel)]=\"city3\" inputId=\"large_select\" [options]=\"cities\" size=\"large\" class=\"w-56\" />\n <label for=\"large_select\">Large</label>\n </p-iftalabel>\n </div>\n </div>\n `,\n standalone: true,\n imports: [SelectModule, IftaLabelModule, InputTextModule, FormsModule]\n})\nexport class IftalabelSizesDemo {\n value1: string | undefined;\n value2: string | undefined;\n value3: string | undefined;\n city1: string | undefined;\n city2: string | undefined;\n city3: string | undefined;\n cities: any[] = ['New York', 'Rome', 'London', 'Istanbul', 'Paris'];\n}"
|
|
15953
|
+
}
|
|
15843
15954
|
}
|
|
15844
15955
|
],
|
|
15845
15956
|
"api": {
|
|
@@ -15935,6 +16046,36 @@
|
|
|
15935
16046
|
"variable": "--p-iftalabel-font-weight",
|
|
15936
16047
|
"description": "Font weight of root"
|
|
15937
16048
|
},
|
|
16049
|
+
{
|
|
16050
|
+
"token": "iftalabel.sm.position.x",
|
|
16051
|
+
"variable": "--p-iftalabel-sm-position-x",
|
|
16052
|
+
"description": "Sm position x of root"
|
|
16053
|
+
},
|
|
16054
|
+
{
|
|
16055
|
+
"token": "iftalabel.sm.top",
|
|
16056
|
+
"variable": "--p-iftalabel-sm-top",
|
|
16057
|
+
"description": "Sm top of root"
|
|
16058
|
+
},
|
|
16059
|
+
{
|
|
16060
|
+
"token": "iftalabel.sm.font.size",
|
|
16061
|
+
"variable": "--p-iftalabel-sm-font-size",
|
|
16062
|
+
"description": "Sm font size of root"
|
|
16063
|
+
},
|
|
16064
|
+
{
|
|
16065
|
+
"token": "iftalabel.lg.position.x",
|
|
16066
|
+
"variable": "--p-iftalabel-lg-position-x",
|
|
16067
|
+
"description": "Lg position x of root"
|
|
16068
|
+
},
|
|
16069
|
+
{
|
|
16070
|
+
"token": "iftalabel.lg.top",
|
|
16071
|
+
"variable": "--p-iftalabel-lg-top",
|
|
16072
|
+
"description": "Lg top of root"
|
|
16073
|
+
},
|
|
16074
|
+
{
|
|
16075
|
+
"token": "iftalabel.lg.font.size",
|
|
16076
|
+
"variable": "--p-iftalabel-lg-font-size",
|
|
16077
|
+
"description": "Lg font size of root"
|
|
16078
|
+
},
|
|
15938
16079
|
{
|
|
15939
16080
|
"token": "iftalabel.input.padding.top",
|
|
15940
16081
|
"variable": "--p-iftalabel-input-padding-top",
|
|
@@ -15944,6 +16085,26 @@
|
|
|
15944
16085
|
"token": "iftalabel.input.padding.bottom",
|
|
15945
16086
|
"variable": "--p-iftalabel-input-padding-bottom",
|
|
15946
16087
|
"description": "Padding bottom of input"
|
|
16088
|
+
},
|
|
16089
|
+
{
|
|
16090
|
+
"token": "iftalabel.input.sm.padding.top",
|
|
16091
|
+
"variable": "--p-iftalabel-input-sm-padding-top",
|
|
16092
|
+
"description": "Sm padding top of input"
|
|
16093
|
+
},
|
|
16094
|
+
{
|
|
16095
|
+
"token": "iftalabel.input.sm.padding.bottom",
|
|
16096
|
+
"variable": "--p-iftalabel-input-sm-padding-bottom",
|
|
16097
|
+
"description": "Sm padding bottom of input"
|
|
16098
|
+
},
|
|
16099
|
+
{
|
|
16100
|
+
"token": "iftalabel.input.lg.padding.top",
|
|
16101
|
+
"variable": "--p-iftalabel-input-lg-padding-top",
|
|
16102
|
+
"description": "Lg padding top of input"
|
|
16103
|
+
},
|
|
16104
|
+
{
|
|
16105
|
+
"token": "iftalabel.input.lg.padding.bottom",
|
|
16106
|
+
"variable": "--p-iftalabel-input-lg-padding-bottom",
|
|
16107
|
+
"description": "Lg padding bottom of input"
|
|
15947
16108
|
}
|
|
15948
16109
|
]
|
|
15949
16110
|
}
|
|
@@ -16530,7 +16691,7 @@
|
|
|
16530
16691
|
"deprecated": ""
|
|
16531
16692
|
},
|
|
16532
16693
|
{
|
|
16533
|
-
"name": "
|
|
16694
|
+
"name": "ariaLabelledBy",
|
|
16534
16695
|
"type": "InputSignal<string>",
|
|
16535
16696
|
"default": "...",
|
|
16536
16697
|
"description": "Defines a string value that labels an interactive element.",
|
|
@@ -16761,7 +16922,7 @@
|
|
|
16761
16922
|
"type": "InputSignal<string>",
|
|
16762
16923
|
"default": "...",
|
|
16763
16924
|
"description": "Icon to display in the close button.",
|
|
16764
|
-
"deprecated": "since v20.0.0, use "
|
|
16925
|
+
"deprecated": "since v20.0.0, use the "
|
|
16765
16926
|
},
|
|
16766
16927
|
{
|
|
16767
16928
|
"name": "closeAriaLabel",
|
|
@@ -17176,6 +17337,14 @@
|
|
|
17176
17337
|
"typescript": "import { Component, inject } from '@angular/core';\nimport { ReactiveFormsModule } from '@angular/forms';\nimport { MessageModule } from '@exhaustive-ui/core/message';\nimport { ToastModule } from '@exhaustive-ui/core/toast';\nimport { ButtonModule } from '@exhaustive-ui/core/button';\nimport { InputTextModule } from '@exhaustive-ui/core/inputtext';\nimport { InputMaskModule } from '@exhaustive-ui/core/inputmask';\nimport { MessageService } from '@exhaustive-ui/core/api';\n\n@Component({\n template: `\n <p-toast />\n <div class=\"card flex justify-center\">\n <form [formGroup]=\"exampleForm\" (ngSubmit)=\"onSubmit()\" class=\"flex flex-col gap-4 sm:w-56\">\n <div class=\"flex flex-col gap-1\">\n <input pInputText pInputMask=\"99-999999\" formControlName=\"value\" placeholder=\"99-999999\" [invalid]=\"isInvalid('value')\" fluid />\n @if (isInvalid('value')) {\n <p-message severity=\"error\" size=\"small\" variant=\"simple\">Serial number is required.</p-message>\n }\n </div>\n <button pButton severity=\"secondary\" type=\"submit\"><span pButtonLabel>Submit</span></button>\n </form>\n </div>\n `,\n standalone: true,\n imports: [MessageModule, ToastModule, ButtonModule, InputTextModule, InputMaskModule, ReactiveFormsModule]\n})\nexport class InputmaskReactiveformsDemo {\n messageService = inject(MessageService);\n items: any[] | undefined;\n exampleForm: FormGroup | undefined;\n formSubmitted: boolean = false;\n\n constructor() {\n this.exampleForm = this.fb.group({\n value: ['', Validators.required]\n });\n }\n\n onSubmit() {\n this.formSubmitted = true;\n if (this.exampleForm.valid) {\n this.messageService.add({ severity: 'success', summary: 'Success', detail: 'Form is submitted', life: 3000 });\n this.exampleForm.reset();\n this.formSubmitted = false;\n }\n }\n\n isInvalid(controlName: string) {\n const control = this.exampleForm.get(controlName);\n return control?.invalid && (control.touched || this.formSubmitted);\n }\n}"
|
|
17177
17338
|
}
|
|
17178
17339
|
},
|
|
17340
|
+
{
|
|
17341
|
+
"id": "signalforms",
|
|
17342
|
+
"label": "Signal Forms",
|
|
17343
|
+
"description": "InputMask can also be used with Angular Signal Forms , the @angular/forms/signals API of Angular 21 and newer. The form model is a signal, form() declares its validators and the [formField] directive binds the component to a field. The field also sets the invalid state of the component, so the component is styled as invalid before any interaction, while the messages below appear once the field is touched or the form is submitted.",
|
|
17344
|
+
"examples": {
|
|
17345
|
+
"typescript": "import { Component, inject, signal } from '@angular/core';\nimport { form, FormField, required, submit } from '@angular/forms/signals';\nimport { MessageModule } from '@exhaustive-ui/core/message';\nimport { ToastModule } from '@exhaustive-ui/core/toast';\nimport { ButtonModule } from '@exhaustive-ui/core/button';\nimport { InputTextModule } from '@exhaustive-ui/core/inputtext';\nimport { InputMaskModule } from '@exhaustive-ui/core/inputmask';\nimport { MessageService } from '@exhaustive-ui/core/api';\n\n@Component({\n template: `\n <p-toast />\n <div class=\"card flex justify-center\">\n <form novalidate (submit)=\"onSubmit($event)\" class=\"flex flex-col gap-4 sm:w-56\">\n <div class=\"flex flex-col gap-1\">\n <input pInputText pInputMask=\"99-999999\" [formField]=\"exampleForm.value\" placeholder=\"99-999999\" fluid />\n @let value = exampleForm.value();\n @if (value.invalid() && value.touched()) {\n <p-message severity=\"error\" size=\"small\" variant=\"simple\">Serial number is required.</p-message>\n }\n </div>\n <button pButton severity=\"secondary\" type=\"submit\"><span pButtonLabel>Submit</span></button>\n </form>\n </div>\n `,\n standalone: true,\n imports: [MessageModule, ToastModule, ButtonModule, InputTextModule, InputMaskModule, FormField]\n})\nexport class InputmaskSignalformsDemo {\n messageService = inject(MessageService);\n model = signal({ value: '' });\n exampleForm = form(this.model, (f) => {\n required(f.value);\n });\n\n onSubmit(event: Event) {\n event.preventDefault();\n submit(this.exampleForm, async () => {\n this.messageService.add({ severity: 'success', summary: 'Success', detail: 'Form is submitted', life: 3000 });\n this.exampleForm().reset({ value: '' });\n });\n }\n}"
|
|
17346
|
+
}
|
|
17347
|
+
},
|
|
17179
17348
|
{
|
|
17180
17349
|
"id": "sizes",
|
|
17181
17350
|
"label": "Sizes",
|
|
@@ -17289,21 +17458,21 @@
|
|
|
17289
17458
|
},
|
|
17290
17459
|
{
|
|
17291
17460
|
"name": "pattern",
|
|
17292
|
-
"type": "
|
|
17461
|
+
"type": "InputSignalWithTransform<string, string | readonly RegExp[]>",
|
|
17293
17462
|
"default": "undefined",
|
|
17294
17463
|
"description": "Specifies the value must match the pattern.",
|
|
17295
17464
|
"deprecated": ""
|
|
17296
17465
|
},
|
|
17297
17466
|
{
|
|
17298
17467
|
"name": "min",
|
|
17299
|
-
"type": "
|
|
17468
|
+
"type": "InputSignalWithTransform<number, unknown>",
|
|
17300
17469
|
"default": "undefined",
|
|
17301
17470
|
"description": "The value must be greater than or equal to the value.",
|
|
17302
17471
|
"deprecated": ""
|
|
17303
17472
|
},
|
|
17304
17473
|
{
|
|
17305
17474
|
"name": "max",
|
|
17306
|
-
"type": "
|
|
17475
|
+
"type": "InputSignalWithTransform<number, unknown>",
|
|
17307
17476
|
"default": "undefined",
|
|
17308
17477
|
"description": "The value must be less than or equal to the value.",
|
|
17309
17478
|
"deprecated": ""
|
|
@@ -17466,7 +17635,7 @@
|
|
|
17466
17635
|
"name": "mask",
|
|
17467
17636
|
"type": "InputSignal<string>",
|
|
17468
17637
|
"default": "...",
|
|
17469
|
-
"description": "Mask pattern.",
|
|
17638
|
+
"description": "Mask pattern. A backslash makes the next character a literal, e.g. mask=\"+\\9 999\" for a fixed '+9' prefix.",
|
|
17470
17639
|
"deprecated": ""
|
|
17471
17640
|
}
|
|
17472
17641
|
],
|
|
@@ -17690,6 +17859,14 @@
|
|
|
17690
17859
|
"typescript": "import { Component, inject } from '@angular/core';\nimport { ReactiveFormsModule } from '@angular/forms';\nimport { InputNumberModule } from '@exhaustive-ui/core/inputnumber';\nimport { MessageModule } from '@exhaustive-ui/core/message';\nimport { ToastModule } from '@exhaustive-ui/core/toast';\nimport { ButtonModule } from '@exhaustive-ui/core/button';\nimport { MessageService } from '@exhaustive-ui/core/api';\n\n@Component({\n template: `\n <p-toast />\n <div class=\"card flex justify-center\">\n <form [formGroup]=\"exampleForm\" (ngSubmit)=\"onSubmit()\" class=\"flex flex-col gap-4\">\n <div class=\"flex flex-col gap-1\">\n <p-inputnumber inputId=\"integeronly\" formControlName=\"value\" [invalid]=\"isInvalid('value')\" />\n @if (isInvalid('value')) {\n <p-message severity=\"error\" size=\"small\" variant=\"simple\">Number is required.</p-message>\n }\n </div>\n <button pButton severity=\"secondary\" type=\"submit\"><span pButtonLabel>Submit</span></button>\n </form>\n </div>\n `,\n standalone: true,\n imports: [InputNumberModule, MessageModule, ToastModule, ButtonModule, ReactiveFormsModule]\n})\nexport class InputnumberReactiveformsDemo {\n messageService = inject(MessageService);\n exampleForm: FormGroup | undefined;\n formSubmitted: boolean = false;\n\n constructor() {\n this.exampleForm = this.fb.group({\n value: [undefined, Validators.required]\n });\n }\n\n onSubmit() {\n this.formSubmitted = true;\n if (this.exampleForm.valid) {\n this.messageService.add({ severity: 'success', summary: 'Success', detail: 'Form Submitted', life: 3000 });\n this.exampleForm.reset();\n this.formSubmitted = false;\n }\n }\n\n isInvalid(controlName: string) {\n const control = this.exampleForm.get(controlName);\n return control?.invalid && (control.touched || this.formSubmitted);\n }\n}"
|
|
17691
17860
|
}
|
|
17692
17861
|
},
|
|
17862
|
+
{
|
|
17863
|
+
"id": "signalforms",
|
|
17864
|
+
"label": "Signal Forms",
|
|
17865
|
+
"description": "InputNumber can also be used with Angular Signal Forms , the @angular/forms/signals API of Angular 21 and newer. The form model is a signal, form() declares its validators and the [formField] directive binds the component to a field. The field also sets the invalid state of the component, so the component is styled as invalid before any interaction, while the messages below appear once the field is touched or the form is submitted.",
|
|
17866
|
+
"examples": {
|
|
17867
|
+
"typescript": "import { Component, inject, signal } from '@angular/core';\nimport { form, FormField, required, submit } from '@angular/forms/signals';\nimport { InputNumberModule } from '@exhaustive-ui/core/inputnumber';\nimport { MessageModule } from '@exhaustive-ui/core/message';\nimport { ToastModule } from '@exhaustive-ui/core/toast';\nimport { ButtonModule } from '@exhaustive-ui/core/button';\nimport { MessageService } from '@exhaustive-ui/core/api';\n\n@Component({\n template: `\n <p-toast />\n <div class=\"card flex justify-center\">\n <form novalidate (submit)=\"onSubmit($event)\" class=\"flex flex-col gap-4\">\n <div class=\"flex flex-col gap-1\">\n <p-inputnumber inputId=\"integeronly\" [formField]=\"exampleForm.value\" />\n @let value = exampleForm.value();\n @if (value.invalid() && value.touched()) {\n <p-message severity=\"error\" size=\"small\" variant=\"simple\">Number is required.</p-message>\n }\n </div>\n <button pButton severity=\"secondary\" type=\"submit\"><span pButtonLabel>Submit</span></button>\n </form>\n </div>\n `,\n standalone: true,\n imports: [InputNumberModule, MessageModule, ToastModule, ButtonModule, FormField]\n})\nexport class InputnumberSignalformsDemo {\n messageService = inject(MessageService);\n model = signal<{ value: number | null }>({ value: null });\n exampleForm = form(this.model, (f) => {\n required(f.value);\n });\n\n onSubmit(event: Event) {\n event.preventDefault();\n submit(this.exampleForm, async () => {\n this.messageService.add({ severity: 'success', summary: 'Success', detail: 'Form Submitted', life: 3000 });\n this.exampleForm().reset({ value: null });\n });\n }\n}"
|
|
17868
|
+
}
|
|
17869
|
+
},
|
|
17693
17870
|
{
|
|
17694
17871
|
"id": "sizes",
|
|
17695
17872
|
"label": "Sizes",
|
|
@@ -17803,21 +17980,21 @@
|
|
|
17803
17980
|
},
|
|
17804
17981
|
{
|
|
17805
17982
|
"name": "pattern",
|
|
17806
|
-
"type": "
|
|
17983
|
+
"type": "InputSignalWithTransform<string, string | readonly RegExp[]>",
|
|
17807
17984
|
"default": "undefined",
|
|
17808
17985
|
"description": "Specifies the value must match the pattern.",
|
|
17809
17986
|
"deprecated": ""
|
|
17810
17987
|
},
|
|
17811
17988
|
{
|
|
17812
17989
|
"name": "min",
|
|
17813
|
-
"type": "
|
|
17990
|
+
"type": "InputSignalWithTransform<number, unknown>",
|
|
17814
17991
|
"default": "undefined",
|
|
17815
17992
|
"description": "The value must be greater than or equal to the value.",
|
|
17816
17993
|
"deprecated": ""
|
|
17817
17994
|
},
|
|
17818
17995
|
{
|
|
17819
17996
|
"name": "max",
|
|
17820
|
-
"type": "
|
|
17997
|
+
"type": "InputSignalWithTransform<number, unknown>",
|
|
17821
17998
|
"default": "undefined",
|
|
17822
17999
|
"description": "The value must be less than or equal to the value.",
|
|
17823
18000
|
"deprecated": ""
|
|
@@ -18331,6 +18508,14 @@
|
|
|
18331
18508
|
"typescript": "import { Component } from '@angular/core';\nimport { FormsModule } from '@angular/forms';\nimport { ButtonModule } from '@exhaustive-ui/core/button';\nimport { InputOtpModule } from '@exhaustive-ui/core/inputotp';\n\n@Component({\n template: `\n <div class=\"card flex justify-center\">\n <div class=\"flex flex-col items-center\">\n <div class=\"font-bold text-xl mb-2\">Authenticate Your Account</div>\n <p class=\"text-muted-color block mb-8\">Please enter the code sent to your phone.</p>\n <p-inputotp [(ngModel)]=\"value\" [length]=\"6\">\n <ng-template #input let-token let-events=\"events\" let-index=\"index\">\n <input type=\"text\" [maxLength]=\"1\" (input)=\"events.input($event)\" (keydown)=\"events.keydown($event)\" [attr.value]=\"token\" class=\"custom-otp-input\" />\n <div *ngIf=\"index === 3\" class=\"px-4\">\n <i class=\"pi pi-minus\"></i>\n </div>\n </ng-template>\n </p-inputotp>\n <div class=\"flex justify-between mt-8 self-stretch\">\n <p-button label=\"Resend Code\" [link]=\"true\" class=\"p-0\" />\n <p-button label=\"Submit Code\" />\n </div>\n </div>\n </div>\n `,\n standalone: true,\n imports: [ButtonModule, InputOtpModule, FormsModule]\n})\nexport class InputotpSampleDemo {\n value: any;\n}"
|
|
18332
18509
|
}
|
|
18333
18510
|
},
|
|
18511
|
+
{
|
|
18512
|
+
"id": "signalforms",
|
|
18513
|
+
"label": "Signal Forms",
|
|
18514
|
+
"description": "InputOtp can also be used with Angular Signal Forms , the @angular/forms/signals API of Angular 21 and newer. The form model is a signal, form() declares its validators and the [formField] directive binds the component to a field. The field also sets the invalid state of the component, so the component is styled as invalid before any interaction, while the messages below appear once the field is touched or the form is submitted.",
|
|
18515
|
+
"examples": {
|
|
18516
|
+
"typescript": "import { Component, inject, signal } from '@angular/core';\nimport { form, FormField, minLength, required, submit } from '@angular/forms/signals';\nimport { InputOtpModule } from '@exhaustive-ui/core/inputotp';\nimport { MessageModule } from '@exhaustive-ui/core/message';\nimport { ToastModule } from '@exhaustive-ui/core/toast';\nimport { ButtonModule } from '@exhaustive-ui/core/button';\nimport { MessageService } from '@exhaustive-ui/core/api';\n\n@Component({\n template: `\n <p-toast />\n <div class=\"card flex justify-center\">\n <form novalidate (submit)=\"onSubmit($event)\" class=\"flex flex-col gap-4\">\n <div class=\"flex flex-col gap-1\">\n <p-inputotp [formField]=\"exampleForm.value\" />\n @let value = exampleForm.value();\n @if (value.invalid() && value.touched()) {\n <p-message severity=\"error\" size=\"small\" variant=\"simple\">Passcode is required.</p-message>\n }\n </div>\n <button pButton severity=\"secondary\" type=\"submit\"><span pButtonLabel>Submit</span></button>\n </form>\n </div>\n `,\n standalone: true,\n imports: [InputOtpModule, MessageModule, ToastModule, ButtonModule, FormField]\n})\nexport class InputotpSignalformsDemo {\n messageService = inject(MessageService);\n model = signal({ value: '' });\n exampleForm = form(this.model, (f) => {\n required(f.value);\n minLength(f.value, 4);\n });\n\n onSubmit(event: Event) {\n event.preventDefault();\n submit(this.exampleForm, async () => {\n this.messageService.add({ severity: 'success', summary: 'Success', detail: 'Form is submitted', life: 3000 });\n this.exampleForm().reset({ value: '' });\n });\n }\n}"
|
|
18517
|
+
}
|
|
18518
|
+
},
|
|
18334
18519
|
{
|
|
18335
18520
|
"id": "sizes",
|
|
18336
18521
|
"label": "Sizes",
|
|
@@ -18668,6 +18853,14 @@
|
|
|
18668
18853
|
"typescript": "import { Component, inject } from '@angular/core';\nimport { ReactiveFormsModule } from '@angular/forms';\nimport { MessageModule } from '@exhaustive-ui/core/message';\nimport { ToastModule } from '@exhaustive-ui/core/toast';\nimport { ButtonModule } from '@exhaustive-ui/core/button';\nimport { InputTextModule } from '@exhaustive-ui/core/inputtext';\nimport { MessageService } from '@exhaustive-ui/core/api';\n\n@Component({\n template: `\n <p-toast />\n <div class=\"card flex justify-center\">\n <form [formGroup]=\"exampleForm\" (ngSubmit)=\"onSubmit()\" class=\"flex flex-col gap-4 w-full sm:w-56\">\n <div class=\"flex flex-col gap-1\">\n <input pInputText type=\"text\" id=\"username\" placeholder=\"Username\" formControlName=\"username\" [invalid]=\"isInvalid('username')\" />\n @if (isInvalid('username')) {\n <p-message severity=\"error\" size=\"small\" variant=\"simple\">Username is required.</p-message>\n }\n </div>\n <div class=\"flex flex-col gap-1\">\n <input pInputText type=\"email\" id=\"email\" placeholder=\"Email\" formControlName=\"email\" [invalid]=\"isInvalid('email')\" />\n @if (isInvalid('email')) {\n @if (exampleForm.get('email')?.errors?.['required']) {\n <p-message severity=\"error\" size=\"small\" variant=\"simple\">Email is required.</p-message>\n }\n @if (exampleForm.get('email')?.errors?.['email']) {\n <p-message severity=\"error\" size=\"small\" variant=\"simple\">Please enter a valid email.</p-message>\n }\n }\n </div>\n <button pButton severity=\"secondary\" type=\"submit\"><span pButtonLabel>Submit</span></button>\n </form>\n </div>\n `,\n standalone: true,\n imports: [MessageModule, ToastModule, ButtonModule, InputTextModule, ReactiveFormsModule]\n})\nexport class InputtextReactiveformsDemo {\n messageService = inject(MessageService);\n exampleForm: FormGroup;\n formSubmitted: boolean = false;\n\n constructor() {\n this.exampleForm = this.fb.group({\n username: ['', Validators.required],\n email: ['', [Validators.required, Validators.email]]\n });\n }\n\n onSubmit() {\n this.formSubmitted = true;\n if (this.exampleForm.valid) {\n this.messageService.add({ severity: 'success', summary: 'Success', detail: 'Form Submitted', life: 3000 });\n this.exampleForm.reset();\n this.formSubmitted = false;\n }\n }\n\n isInvalid(controlName: string) {\n const control = this.exampleForm.get(controlName);\n return control?.invalid && (control.touched || this.formSubmitted);\n }\n}"
|
|
18669
18854
|
}
|
|
18670
18855
|
},
|
|
18856
|
+
{
|
|
18857
|
+
"id": "signalforms",
|
|
18858
|
+
"label": "Signal Forms",
|
|
18859
|
+
"description": "InputText can also be used with Angular Signal Forms , the @angular/forms/signals API of Angular 21 and newer. The form model is a signal, form() declares its validators and the [formField] directive binds the component to a field. The field also sets the invalid state of the component, so the component is styled as invalid before any interaction, while the messages below appear once the field is touched or the form is submitted.",
|
|
18860
|
+
"examples": {
|
|
18861
|
+
"typescript": "import { Component, inject, signal } from '@angular/core';\nimport { email, form, FormField, required, submit } from '@angular/forms/signals';\nimport { MessageModule } from '@exhaustive-ui/core/message';\nimport { ToastModule } from '@exhaustive-ui/core/toast';\nimport { ButtonModule } from '@exhaustive-ui/core/button';\nimport { InputTextModule } from '@exhaustive-ui/core/inputtext';\nimport { MessageService } from '@exhaustive-ui/core/api';\n\n@Component({\n template: `\n <p-toast />\n <div class=\"card flex justify-center\">\n <form novalidate (submit)=\"onSubmit($event)\" class=\"flex flex-col gap-4 w-full sm:w-56\">\n <div class=\"flex flex-col gap-1\">\n <input pInputText type=\"text\" id=\"username\" placeholder=\"Username\" [formField]=\"exampleForm.username\" />\n @let username = exampleForm.username();\n @if (username.invalid() && username.touched()) {\n <p-message severity=\"error\" size=\"small\" variant=\"simple\">Username is required.</p-message>\n }\n </div>\n <div class=\"flex flex-col gap-1\">\n <input pInputText type=\"email\" id=\"email\" placeholder=\"Email\" [formField]=\"exampleForm.email\" />\n @let email = exampleForm.email();\n @if (email.invalid() && email.touched()) {\n @if (email.getError('required')) {\n <p-message severity=\"error\" size=\"small\" variant=\"simple\">Email is required.</p-message>\n }\n @if (email.getError('email')) {\n <p-message severity=\"error\" size=\"small\" variant=\"simple\">Please enter a valid email.</p-message>\n }\n }\n </div>\n <button pButton severity=\"secondary\" type=\"submit\"><span pButtonLabel>Submit</span></button>\n </form>\n </div>\n `,\n standalone: true,\n imports: [MessageModule, ToastModule, ButtonModule, InputTextModule, FormField]\n})\nexport class InputtextSignalformsDemo {\n messageService = inject(MessageService);\n model = signal({ username: '', email: '' });\n exampleForm = form(this.model, (f) => {\n required(f.username);\n required(f.email);\n email(f.email);\n });\n\n onSubmit(event: Event) {\n event.preventDefault();\n submit(this.exampleForm, async () => {\n this.messageService.add({ severity: 'success', summary: 'Success', detail: 'Form Submitted', life: 3000 });\n this.exampleForm().reset({ username: '', email: '' });\n });\n }\n}"
|
|
18862
|
+
}
|
|
18863
|
+
},
|
|
18671
18864
|
{
|
|
18672
18865
|
"id": "sizes",
|
|
18673
18866
|
"label": "Sizes",
|
|
@@ -18715,13 +18908,6 @@
|
|
|
18715
18908
|
"description": "Used to configure passthrough(pt) options of the component.",
|
|
18716
18909
|
"deprecated": ""
|
|
18717
18910
|
},
|
|
18718
|
-
{
|
|
18719
|
-
"name": "ptInputText",
|
|
18720
|
-
"type": "InputSignal<InputTextPassThrough>",
|
|
18721
|
-
"default": "undefined",
|
|
18722
|
-
"description": "Used to pass attributes to DOM elements inside the InputText component.",
|
|
18723
|
-
"deprecated": "use pInputTextPT instead."
|
|
18724
|
-
},
|
|
18725
18911
|
{
|
|
18726
18912
|
"name": "pInputTextPT",
|
|
18727
18913
|
"type": "InputSignal<InputTextPassThrough>",
|
|
@@ -19061,6 +19247,14 @@
|
|
|
19061
19247
|
"typescript": "import { Component } from '@angular/core';\nimport { FormsModule } from '@angular/forms';\nimport { KnobModule } from '@exhaustive-ui/core/knob';\n\n@Component({\n template: `\n <div class=\"card flex justify-center\">\n <p-knob [(ngModel)]=\"value\" [readonly]=\"true\" />\n </div>\n `,\n standalone: true,\n imports: [KnobModule, FormsModule]\n})\nexport class KnobReadonlyDemo {\n value: number = 50;\n}"
|
|
19062
19248
|
}
|
|
19063
19249
|
},
|
|
19250
|
+
{
|
|
19251
|
+
"id": "signalforms",
|
|
19252
|
+
"label": "Signal Forms",
|
|
19253
|
+
"description": "Knob can also be used with Angular Signal Forms , the @angular/forms/signals API of Angular 21 and newer. The form model is a signal, form() declares its validators and the [formField] directive binds the component to a field. The field also sets the invalid state of the component, so the component is styled as invalid before any interaction, while the messages below appear once the field is touched or the form is submitted.",
|
|
19254
|
+
"examples": {
|
|
19255
|
+
"typescript": "import { Component, inject, signal } from '@angular/core';\nimport { form, FormField, submit, validate } from '@angular/forms/signals';\nimport { KnobModule } from '@exhaustive-ui/core/knob';\nimport { MessageModule } from '@exhaustive-ui/core/message';\nimport { ToastModule } from '@exhaustive-ui/core/toast';\nimport { ButtonModule } from '@exhaustive-ui/core/button';\nimport { MessageService } from '@exhaustive-ui/core/api';\n\n@Component({\n template: `\n <p-toast />\n <div class=\"card flex justify-center\">\n <form novalidate (submit)=\"onSubmit($event)\" class=\"flex flex-col items-center gap-4\">\n <div class=\"flex flex-col items-center gap-1\">\n <p-knob [formField]=\"exampleForm.value\" />\n @let value = exampleForm.value();\n @if (value.invalid() && (value.dirty() || value.touched())) {\n @if (value.getError('min')) {\n <p-message severity=\"error\" size=\"small\" variant=\"simple\">Value must be greater than 25.</p-message>\n }\n @if (value.getError('max')) {\n <p-message severity=\"error\" size=\"small\" variant=\"simple\">Must be less than 75.</p-message>\n }\n }\n </div>\n <button pButton severity=\"secondary\" type=\"submit\"><span pButtonLabel>Submit</span></button>\n </form>\n </div>\n `,\n standalone: true,\n imports: [KnobModule, MessageModule, ToastModule, ButtonModule, FormField]\n})\nexport class KnobSignalformsDemo {\n messageService = inject(MessageService);\n model = signal({ value: 15 });\n exampleForm = form(this.model, (f) => {\n // min() and max() would also set the range of the knob, so the bounds are checked by a validator\n validate(f.value, ({ value }) => (value() < 25 ? { kind: 'min' } : value() > 75 ? { kind: 'max' } : null));\n });\n\n onSubmit(event: Event) {\n event.preventDefault();\n submit(this.exampleForm, async () => {\n this.messageService.add({ severity: 'success', summary: 'Success', detail: 'Form is submitted', life: 3000 });\n this.exampleForm().reset({ value: 15 });\n });\n }\n}"
|
|
19256
|
+
}
|
|
19257
|
+
},
|
|
19064
19258
|
{
|
|
19065
19259
|
"id": "size",
|
|
19066
19260
|
"label": "Size",
|
|
@@ -19458,6 +19652,14 @@
|
|
|
19458
19652
|
"typescript": "import { Component, inject } from '@angular/core';\nimport { ReactiveFormsModule } from '@angular/forms';\nimport { ListboxModule } from '@exhaustive-ui/core/listbox';\nimport { MessageModule } from '@exhaustive-ui/core/message';\nimport { ToastModule } from '@exhaustive-ui/core/toast';\nimport { ButtonModule } from '@exhaustive-ui/core/button';\nimport { MessageService } from '@exhaustive-ui/core/api';\n\ninterface City {\n name: string;\n code: string;\n}\n\n@Component({\n template: `\n <p-toast />\n <div class=\"card flex justify-center\">\n <form [formGroup]=\"exampleForm\" (ngSubmit)=\"onSubmit()\" class=\"flex flex-col gap-4 sm:w-56\">\n <div class=\"flex flex-col gap-1\">\n <p-listbox [options]=\"cities\" formControlName=\"selectedCity\" optionLabel=\"name\" class=\"w-full md:w-56\" [invalid]=\"isInvalid('selectedCity')\" />\n @if (isInvalid('selectedCity')) {\n <p-message severity=\"error\" size=\"small\" variant=\"simple\">City is required.</p-message>\n }\n </div>\n <button pButton severity=\"secondary\" type=\"submit\"><span pButtonLabel>Submit</span></button>\n </form>\n </div>\n `,\n standalone: true,\n imports: [ListboxModule, MessageModule, ToastModule, ButtonModule, ReactiveFormsModule]\n})\nexport class ListboxReactiveformsDemo {\n messageService = inject(MessageService);\n exampleForm: FormGroup | undefined;\n formSubmitted: boolean = false;\n cities!: City[];\n\n constructor() {\n this.cities = [\n { name: 'New York', code: 'NY' },\n { name: 'Rome', code: 'RM' },\n { name: 'London', code: 'LDN' },\n { name: 'Istanbul', code: 'IST' },\n { name: 'Paris', code: 'PRS' }\n ];\n this.exampleForm = this.fb.group({\n selectedCity: ['', Validators.required]\n });\n }\n\n onSubmit() {\n this.formSubmitted = true;\n if (this.exampleForm.valid) {\n this.messageService.add({ severity: 'success', summary: 'Success', detail: 'Form is submitted', life: 3000 });\n this.exampleForm.reset();\n this.formSubmitted = false;\n }\n }\n\n isInvalid(controlName: string) {\n const control = this.exampleForm.get(controlName);\n return control?.invalid && this.formSubmitted;\n }\n}"
|
|
19459
19653
|
}
|
|
19460
19654
|
},
|
|
19655
|
+
{
|
|
19656
|
+
"id": "signalforms",
|
|
19657
|
+
"label": "Signal Forms",
|
|
19658
|
+
"description": "Listbox can also be used with Angular Signal Forms , the @angular/forms/signals API of Angular 21 and newer. The form model is a signal, form() declares its validators and the [formField] directive binds the component to a field. The field also sets the invalid state of the component, so the component is styled as invalid before any interaction, while the messages below appear once the field is touched or the form is submitted.",
|
|
19659
|
+
"examples": {
|
|
19660
|
+
"typescript": "import { Component, inject, signal } from '@angular/core';\nimport { form, FormField, required, submit } from '@angular/forms/signals';\nimport { ListboxModule } from '@exhaustive-ui/core/listbox';\nimport { MessageModule } from '@exhaustive-ui/core/message';\nimport { ToastModule } from '@exhaustive-ui/core/toast';\nimport { ButtonModule } from '@exhaustive-ui/core/button';\nimport { MessageService } from '@exhaustive-ui/core/api';\n\ninterface City {\n name: string;\n code: string;\n}\n\n@Component({\n template: `\n <p-toast />\n <div class=\"card flex justify-center\">\n <form novalidate (submit)=\"onSubmit($event)\" class=\"flex flex-col gap-4 sm:w-56\">\n <div class=\"flex flex-col gap-1\">\n <p-listbox [options]=\"cities\" [formField]=\"exampleForm.selectedCity\" optionLabel=\"name\" class=\"w-full md:w-56\" />\n @let selectedCity = exampleForm.selectedCity();\n @if (selectedCity.invalid() && selectedCity.touched()) {\n <p-message severity=\"error\" size=\"small\" variant=\"simple\">City is required.</p-message>\n }\n </div>\n <button pButton severity=\"secondary\" type=\"submit\"><span pButtonLabel>Submit</span></button>\n </form>\n </div>\n `,\n standalone: true,\n imports: [ListboxModule, MessageModule, ToastModule, ButtonModule, FormField]\n})\nexport class ListboxSignalformsDemo {\n messageService = inject(MessageService);\n cities: City[];\n model = signal<{ selectedCity: City | null }>({ selectedCity: null });\n exampleForm = form(this.model, (f) => {\n required(f.selectedCity);\n });\n\n onSubmit(event: Event) {\n event.preventDefault();\n submit(this.exampleForm, async () => {\n this.messageService.add({ severity: 'success', summary: 'Success', detail: 'Form is submitted', life: 3000 });\n this.exampleForm().reset({ selectedCity: null });\n });\n }\n}"
|
|
19661
|
+
}
|
|
19662
|
+
},
|
|
19461
19663
|
{
|
|
19462
19664
|
"id": "template",
|
|
19463
19665
|
"label": "Template",
|
|
@@ -19584,17 +19786,17 @@
|
|
|
19584
19786
|
"deprecated": ""
|
|
19585
19787
|
},
|
|
19586
19788
|
{
|
|
19587
|
-
"name": "
|
|
19588
|
-
"type": "
|
|
19789
|
+
"name": "ariaLabelledBy",
|
|
19790
|
+
"type": "InputSignal<string>",
|
|
19589
19791
|
"default": "...",
|
|
19590
|
-
"description": "
|
|
19792
|
+
"description": "Establishes relationships between the component and label(s) where its value should be one or more element IDs.",
|
|
19591
19793
|
"deprecated": ""
|
|
19592
19794
|
},
|
|
19593
19795
|
{
|
|
19594
|
-
"name": "
|
|
19796
|
+
"name": "selectOnFocus",
|
|
19595
19797
|
"type": "InputSignalWithTransform<boolean, unknown>",
|
|
19596
19798
|
"default": "...",
|
|
19597
|
-
"description": "
|
|
19799
|
+
"description": "When enabled, the focused option is selected.",
|
|
19598
19800
|
"deprecated": ""
|
|
19599
19801
|
},
|
|
19600
19802
|
{
|
|
@@ -19787,7 +19989,7 @@
|
|
|
19787
19989
|
"deprecated": ""
|
|
19788
19990
|
},
|
|
19789
19991
|
{
|
|
19790
|
-
"name": "
|
|
19992
|
+
"name": "filterPlaceholder",
|
|
19791
19993
|
"type": "InputSignal<string>",
|
|
19792
19994
|
"default": "...",
|
|
19793
19995
|
"description": "Defines placeholder of the filter input.",
|
|
@@ -22150,13 +22352,6 @@
|
|
|
22150
22352
|
"description": "Whether displaying messages would be escaped or not.",
|
|
22151
22353
|
"deprecated": "since v20.0.0. Use content projection instead '<p-message>Content</p-message>'."
|
|
22152
22354
|
},
|
|
22153
|
-
{
|
|
22154
|
-
"name": "style",
|
|
22155
|
-
"type": "InputSignal<{ [klass: string]: any }>",
|
|
22156
|
-
"default": "...",
|
|
22157
|
-
"description": "Inline style of the component.",
|
|
22158
|
-
"deprecated": ""
|
|
22159
|
-
},
|
|
22160
22355
|
{
|
|
22161
22356
|
"name": "closable",
|
|
22162
22357
|
"type": "InputSignalWithTransform<boolean, unknown>",
|
|
@@ -23160,6 +23355,14 @@
|
|
|
23160
23355
|
"typescript": "import { Component, inject } from '@angular/core';\nimport { ReactiveFormsModule } from '@angular/forms';\nimport { MessageModule } from '@exhaustive-ui/core/message';\nimport { MultiSelectModule } from '@exhaustive-ui/core/multiselect';\nimport { ToastModule } from '@exhaustive-ui/core/toast';\nimport { ButtonModule } from '@exhaustive-ui/core/button';\nimport { MessageService } from '@exhaustive-ui/core/api';\n\ninterface City {\n name: string;\n code: string;\n}\n\n@Component({\n template: `\n <p-toast />\n <div class=\"card flex justify-center\">\n <form [formGroup]=\"exampleForm\" (ngSubmit)=\"onSubmit()\" class=\"flex justify-center flex-col gap-4 w-full md:w-80\">\n <div class=\"flex flex-col gap-1\">\n <p-multiselect [options]=\"cities\" formControlName=\"city\" optionLabel=\"name\" placeholder=\"Select Cities\" [maxSelectedLabels]=\"3\" [fluid]=\"true\" [invalid]=\"isInvalid('city')\" />\n @if (isInvalid('city')) {\n <p-message severity=\"error\" size=\"small\" variant=\"simple\">City is required.</p-message>\n }\n </div>\n <button pButton severity=\"secondary\" type=\"submit\"><span pButtonLabel>Submit</span></button>\n </form>\n </div>\n `,\n standalone: true,\n imports: [MessageModule, MultiSelectModule, ToastModule, ButtonModule, ReactiveFormsModule],\n providers: [MessageService]\n})\nexport class MultiselectReactiveformsDemo {\n private messageService = inject(MessageService);\n messageService = inject(MessageService);\n cities: City[];\n exampleForm: FormGroup | undefined;\n formSubmitted: boolean = false;\n\n constructor() {\n this.exampleForm = this.fb.group({\n city: ['', Validators.required]\n });\n }\n\n onSubmit() {\n this.formSubmitted = true;\n if (this.exampleForm.valid) {\n this.messageService.add({ severity: 'success', summary: 'Success', detail: 'Form Submitted', life: 3000 });\n this.exampleForm.reset();\n this.formSubmitted = false;\n }\n }\n\n isInvalid(controlName: string) {\n const control = this.exampleForm.get(controlName);\n return control?.invalid && (control.touched || this.formSubmitted);\n }\n}"
|
|
23161
23356
|
}
|
|
23162
23357
|
},
|
|
23358
|
+
{
|
|
23359
|
+
"id": "signalforms",
|
|
23360
|
+
"label": "Signal Forms",
|
|
23361
|
+
"description": "MultiSelect can also be used with Angular Signal Forms , the @angular/forms/signals API of Angular 21 and newer. The form model is a signal, form() declares its validators and the [formField] directive binds the component to a field. The field also sets the invalid state of the component, so the component is styled as invalid before any interaction, while the messages below appear once the field is touched or the form is submitted.",
|
|
23362
|
+
"examples": {
|
|
23363
|
+
"typescript": "import { Component, inject, signal } from '@angular/core';\nimport { form, FormField, minLength, submit } from '@angular/forms/signals';\nimport { MessageModule } from '@exhaustive-ui/core/message';\nimport { MultiSelectModule } from '@exhaustive-ui/core/multiselect';\nimport { ToastModule } from '@exhaustive-ui/core/toast';\nimport { ButtonModule } from '@exhaustive-ui/core/button';\nimport { MessageService } from '@exhaustive-ui/core/api';\n\ninterface City {\n name: string;\n code: string;\n}\n\n@Component({\n template: `\n <p-toast />\n <div class=\"card flex justify-center\">\n <form novalidate (submit)=\"onSubmit($event)\" class=\"flex justify-center flex-col gap-4 w-full md:w-80\">\n <div class=\"flex flex-col gap-1\">\n <p-multiselect [options]=\"cities\" [formField]=\"exampleForm.city\" optionLabel=\"name\" placeholder=\"Select Cities\" [maxSelectedLabels]=\"3\" [fluid]=\"true\" />\n @let city = exampleForm.city();\n @if (city.invalid() && city.touched()) {\n <p-message severity=\"error\" size=\"small\" variant=\"simple\">City is required.</p-message>\n }\n </div>\n <button pButton severity=\"secondary\" type=\"submit\"><span pButtonLabel>Submit</span></button>\n </form>\n </div>\n `,\n standalone: true,\n imports: [MessageModule, MultiSelectModule, ToastModule, ButtonModule, FormField]\n})\nexport class MultiselectSignalformsDemo {\n messageService = inject(MessageService);\n cities: City[];\n model = signal<{ city: City[] }>({ city: [] });\n exampleForm = form(this.model, (f) => {\n // required() accepts an empty array, minLength() asks for one city at least\n minLength(f.city, 1);\n });\n\n onSubmit(event: Event) {\n event.preventDefault();\n submit(this.exampleForm, async () => {\n this.messageService.add({ severity: 'success', summary: 'Success', detail: 'Form Submitted', life: 3000 });\n this.exampleForm().reset({ city: [] });\n });\n }\n}"
|
|
23364
|
+
}
|
|
23365
|
+
},
|
|
23163
23366
|
{
|
|
23164
23367
|
"id": "sizes",
|
|
23165
23368
|
"label": "Sizes",
|
|
@@ -23308,7 +23511,7 @@
|
|
|
23308
23511
|
"deprecated": ""
|
|
23309
23512
|
},
|
|
23310
23513
|
{
|
|
23311
|
-
"name": "
|
|
23514
|
+
"name": "filterPlaceholder",
|
|
23312
23515
|
"type": "InputSignal<string>",
|
|
23313
23516
|
"default": "...",
|
|
23314
23517
|
"description": "Defines placeholder of the filter input.",
|
|
@@ -23749,11 +23952,6 @@
|
|
|
23749
23952
|
"type": "TemplateRef<void>",
|
|
23750
23953
|
"description": "Custom filter icon template."
|
|
23751
23954
|
},
|
|
23752
|
-
{
|
|
23753
|
-
"name": "removetokenicon",
|
|
23754
|
-
"type": "TemplateRef<MultiSelectChipIconTemplateContext>",
|
|
23755
|
-
"description": "Custom remove token icon template."
|
|
23756
|
-
},
|
|
23757
23955
|
{
|
|
23758
23956
|
"name": "chipicon",
|
|
23759
23957
|
"type": "TemplateRef<MultiSelectChipIconTemplateContext>",
|
|
@@ -23842,7 +24040,7 @@
|
|
|
23842
24040
|
"description": "Callback to invoke when input field is cleared."
|
|
23843
24041
|
},
|
|
23844
24042
|
{
|
|
23845
|
-
"name": "
|
|
24043
|
+
"name": "onShow",
|
|
23846
24044
|
"parameters": [
|
|
23847
24045
|
{
|
|
23848
24046
|
"name": "event",
|
|
@@ -23852,7 +24050,7 @@
|
|
|
23852
24050
|
"description": "Callback to invoke when overlay panel becomes visible."
|
|
23853
24051
|
},
|
|
23854
24052
|
{
|
|
23855
|
-
"name": "
|
|
24053
|
+
"name": "onHide",
|
|
23856
24054
|
"parameters": [
|
|
23857
24055
|
{
|
|
23858
24056
|
"name": "event",
|
|
@@ -24479,13 +24677,6 @@
|
|
|
24479
24677
|
"description": "Used to configure passthrough(pt) options of the component.",
|
|
24480
24678
|
"deprecated": ""
|
|
24481
24679
|
},
|
|
24482
|
-
{
|
|
24483
|
-
"name": "header",
|
|
24484
|
-
"type": "InputSignal<string>",
|
|
24485
|
-
"default": "...",
|
|
24486
|
-
"description": "Text for the caption.",
|
|
24487
|
-
"deprecated": ""
|
|
24488
|
-
},
|
|
24489
24680
|
{
|
|
24490
24681
|
"name": "tabindex",
|
|
24491
24682
|
"type": "InputSignalWithTransform<number, unknown>",
|
|
@@ -24598,13 +24789,6 @@
|
|
|
24598
24789
|
"description": "When present, it specifies that the component should be disabled.",
|
|
24599
24790
|
"deprecated": ""
|
|
24600
24791
|
},
|
|
24601
|
-
{
|
|
24602
|
-
"name": "trackBy",
|
|
24603
|
-
"type": "InputSignal<Function>",
|
|
24604
|
-
"default": "...",
|
|
24605
|
-
"description": "Function to optimize the dom operations by delegating to ngForTrackBy, default algorithm checks for object identity.",
|
|
24606
|
-
"deprecated": ""
|
|
24607
|
-
},
|
|
24608
24792
|
{
|
|
24609
24793
|
"name": "scrollHeight",
|
|
24610
24794
|
"type": "InputSignal<string>",
|
|
@@ -24764,7 +24948,7 @@
|
|
|
24764
24948
|
"description": "Callback to invoke when selection changes."
|
|
24765
24949
|
},
|
|
24766
24950
|
{
|
|
24767
|
-
"name": "
|
|
24951
|
+
"name": "onFilter",
|
|
24768
24952
|
"parameters": [
|
|
24769
24953
|
{
|
|
24770
24954
|
"name": "event",
|
|
@@ -24968,7 +25152,7 @@
|
|
|
24968
25152
|
"type": "InputSignalWithTransform<boolean, unknown>",
|
|
24969
25153
|
"default": "...",
|
|
24970
25154
|
"description": "Whether the space allocated by a node is preserved when hidden.",
|
|
24971
|
-
"deprecated": "
|
|
25155
|
+
"deprecated": ""
|
|
24972
25156
|
},
|
|
24973
25157
|
{
|
|
24974
25158
|
"name": "selection",
|
|
@@ -27034,6 +27218,14 @@
|
|
|
27034
27218
|
"typescript": "import { Component, inject } from '@angular/core';\nimport { ReactiveFormsModule } from '@angular/forms';\nimport { MessageModule } from '@exhaustive-ui/core/message';\nimport { PasswordModule } from '@exhaustive-ui/core/password';\nimport { ToastModule } from '@exhaustive-ui/core/toast';\nimport { ButtonModule } from '@exhaustive-ui/core/button';\nimport { MessageService } from '@exhaustive-ui/core/api';\n\n@Component({\n template: `\n <p-toast />\n <div class=\"card flex justify-center\">\n <form [formGroup]=\"exampleForm\" (ngSubmit)=\"onSubmit()\" class=\"flex flex-col gap-4 sm:w-56\">\n <div class=\"flex flex-col gap-1\">\n <p-password formControlName=\"value\" [invalid]=\"isInvalid('value')\" [feedback]=\"false\" autocomplete=\"off\" fluid />\n @if (isInvalid('value')) {\n <p-message severity=\"error\" size=\"small\" variant=\"simple\">Password is required.</p-message>\n }\n </div>\n <button pButton severity=\"secondary\" type=\"submit\"><span pButtonLabel>Submit</span></button>\n </form>\n </div>\n `,\n standalone: true,\n imports: [MessageModule, PasswordModule, ToastModule, ButtonModule, ReactiveFormsModule],\n providers: [MessageService]\n})\nexport class PasswordReactiveformsDemo {\n private messageService = inject(MessageService);\n messageService = inject(MessageService);\n exampleForm: FormGroup | undefined;\n formSubmitted: boolean = false;\n\n constructor() {\n this.exampleForm = this.fb.group({\n value: ['', Validators.required]\n });\n }\n\n onSubmit() {\n this.formSubmitted = true;\n if (this.exampleForm.valid) {\n this.messageService.add({ severity: 'success', summary: 'Success', detail: 'Form is submitted', life: 3000 });\n this.exampleForm.reset();\n this.formSubmitted = false;\n }\n }\n\n isInvalid(controlName: string) {\n const control = this.exampleForm.get(controlName);\n return control?.invalid && (control.touched || this.formSubmitted);\n }\n}"
|
|
27035
27219
|
}
|
|
27036
27220
|
},
|
|
27221
|
+
{
|
|
27222
|
+
"id": "signalforms",
|
|
27223
|
+
"label": "Signal Forms",
|
|
27224
|
+
"description": "Password can also be used with Angular Signal Forms , the @angular/forms/signals API of Angular 21 and newer. The form model is a signal, form() declares its validators and the [formField] directive binds the component to a field. The field also sets the invalid state of the component, so the component is styled as invalid before any interaction, while the messages below appear once the field is touched or the form is submitted.",
|
|
27225
|
+
"examples": {
|
|
27226
|
+
"typescript": "import { Component, inject, signal } from '@angular/core';\nimport { form, FormField, required, submit } from '@angular/forms/signals';\nimport { MessageModule } from '@exhaustive-ui/core/message';\nimport { PasswordModule } from '@exhaustive-ui/core/password';\nimport { ToastModule } from '@exhaustive-ui/core/toast';\nimport { ButtonModule } from '@exhaustive-ui/core/button';\nimport { MessageService } from '@exhaustive-ui/core/api';\n\n@Component({\n template: `\n <p-toast />\n <div class=\"card flex justify-center\">\n <form novalidate (submit)=\"onSubmit($event)\" class=\"flex flex-col gap-4 sm:w-56\">\n <div class=\"flex flex-col gap-1\">\n <p-password [formField]=\"exampleForm.value\" [feedback]=\"false\" autocomplete=\"off\" fluid />\n @let value = exampleForm.value();\n @if (value.invalid() && value.touched()) {\n <p-message severity=\"error\" size=\"small\" variant=\"simple\">Password is required.</p-message>\n }\n </div>\n <button pButton severity=\"secondary\" type=\"submit\"><span pButtonLabel>Submit</span></button>\n </form>\n </div>\n `,\n standalone: true,\n imports: [MessageModule, PasswordModule, ToastModule, ButtonModule, FormField]\n})\nexport class PasswordSignalformsDemo {\n messageService = inject(MessageService);\n model = signal({ value: '' });\n exampleForm = form(this.model, (f) => {\n required(f.value);\n });\n\n onSubmit(event: Event) {\n event.preventDefault();\n submit(this.exampleForm, async () => {\n this.messageService.add({ severity: 'success', summary: 'Success', detail: 'Form is submitted', life: 3000 });\n this.exampleForm().reset({ value: '' });\n });\n }\n}"
|
|
27227
|
+
}
|
|
27228
|
+
},
|
|
27037
27229
|
{
|
|
27038
27230
|
"id": "sizes",
|
|
27039
27231
|
"label": "Sizes",
|
|
@@ -27155,21 +27347,21 @@
|
|
|
27155
27347
|
},
|
|
27156
27348
|
{
|
|
27157
27349
|
"name": "pattern",
|
|
27158
|
-
"type": "
|
|
27350
|
+
"type": "InputSignalWithTransform<string, string | readonly RegExp[]>",
|
|
27159
27351
|
"default": "undefined",
|
|
27160
27352
|
"description": "Specifies the value must match the pattern.",
|
|
27161
27353
|
"deprecated": ""
|
|
27162
27354
|
},
|
|
27163
27355
|
{
|
|
27164
27356
|
"name": "min",
|
|
27165
|
-
"type": "
|
|
27357
|
+
"type": "InputSignalWithTransform<number, unknown>",
|
|
27166
27358
|
"default": "undefined",
|
|
27167
27359
|
"description": "The value must be greater than or equal to the value.",
|
|
27168
27360
|
"deprecated": ""
|
|
27169
27361
|
},
|
|
27170
27362
|
{
|
|
27171
27363
|
"name": "max",
|
|
27172
|
-
"type": "
|
|
27364
|
+
"type": "InputSignalWithTransform<number, unknown>",
|
|
27173
27365
|
"default": "undefined",
|
|
27174
27366
|
"description": "The value must be less than or equal to the value.",
|
|
27175
27367
|
"deprecated": ""
|
|
@@ -27808,27 +28000,6 @@
|
|
|
27808
28000
|
"description": "Locale to use in filtering. The default locale is the host environment's current locale.",
|
|
27809
28001
|
"deprecated": ""
|
|
27810
28002
|
},
|
|
27811
|
-
{
|
|
27812
|
-
"name": "trackBy",
|
|
27813
|
-
"type": "InputSignal<Function>",
|
|
27814
|
-
"default": "...",
|
|
27815
|
-
"description": "Function to optimize the dom operations by delegating to ngForTrackBy, default algorithm checks for object identity. Use sourceTrackBy or targetTrackBy in case different algorithms are needed per list.",
|
|
27816
|
-
"deprecated": ""
|
|
27817
|
-
},
|
|
27818
|
-
{
|
|
27819
|
-
"name": "sourceTrackBy",
|
|
27820
|
-
"type": "InputSignal<Function>",
|
|
27821
|
-
"default": "...",
|
|
27822
|
-
"description": "Function to optimize the dom operations by delegating to ngForTrackBy in source list, default algorithm checks for object identity.",
|
|
27823
|
-
"deprecated": ""
|
|
27824
|
-
},
|
|
27825
|
-
{
|
|
27826
|
-
"name": "targetTrackBy",
|
|
27827
|
-
"type": "InputSignal<Function>",
|
|
27828
|
-
"default": "...",
|
|
27829
|
-
"description": "Function to optimize the dom operations by delegating to ngForTrackBy in target list, default algorithm checks for object identity.",
|
|
27830
|
-
"deprecated": ""
|
|
27831
|
-
},
|
|
27832
28003
|
{
|
|
27833
28004
|
"name": "showSourceFilter",
|
|
27834
28005
|
"type": "InputSignalWithTransform<boolean, unknown>",
|
|
@@ -29112,6 +29283,14 @@
|
|
|
29112
29283
|
"typescript": "import { Component, inject } from '@angular/core';\nimport { ReactiveFormsModule } from '@angular/forms';\nimport { MessageModule } from '@exhaustive-ui/core/message';\nimport { RadioButtonModule } from '@exhaustive-ui/core/radiobutton';\nimport { ToastModule } from '@exhaustive-ui/core/toast';\nimport { ButtonModule } from '@exhaustive-ui/core/button';\nimport { MessageService } from '@exhaustive-ui/core/api';\n\n@Component({\n template: `\n <p-toast />\n <div class=\"card flex justify-center\">\n <form [formGroup]=\"exampleForm\" (ngSubmit)=\"onSubmit()\" class=\"flex flex-col gap-4\">\n <div class=\"flex flex-wrap gap-4\">\n @for (category of categories; track category.key) {\n <div class=\"flex items-center gap-2\">\n <p-radiobutton formControlName=\"selectedCategory\" name=\"selectedCategory\" [inputId]=\"category.key\" [value]=\"category\" [invalid]=\"isInvalid('selectedCategory')\" />\n <label [for]=\"category.key\"> {{ category.name }} </label>\n </div>\n }\n </div>\n @if (isInvalid('selectedCategory')) {\n <p-message severity=\"error\" size=\"small\" variant=\"simple\"> At least one ingredient must be selected. </p-message>\n }\n <button pButton severity=\"secondary\" type=\"submit\">\n <span pButtonLabel>Submit</span>\n </button>\n </form>\n </div>\n `,\n standalone: true,\n imports: [MessageModule, RadioButtonModule, ToastModule, ButtonModule, ReactiveFormsModule],\n providers: [MessageService]\n})\nexport class RadiobuttonReactiveformsDemo {\n private messageService = inject(MessageService);\n messageService = inject(MessageService);\n formSubmitted: boolean = false;\n exampleForm: FormGroup;\n categories: any[];\n\n constructor() {\n this.exampleForm = this.fb.group({\n selectedCategory: ['', Validators.required]\n });\n }\n\n isInvalid(controlName: string) {\n const control = this.exampleForm.get(controlName);\n return control?.invalid && this.formSubmitted;\n }\n\n onSubmit() {\n this.formSubmitted = true;\n \n if (this.exampleForm.valid) {\n this.messageService.add({\n severity: 'success',\n summary: 'Success',\n detail: 'Form is submitted',\n life: 3000\n });\n \n this.exampleForm.reset();\n \n this.formSubmitted = false;\n }\n }\n}"
|
|
29113
29284
|
}
|
|
29114
29285
|
},
|
|
29286
|
+
{
|
|
29287
|
+
"id": "signalforms",
|
|
29288
|
+
"label": "Signal Forms",
|
|
29289
|
+
"description": "RadioButton can also be used with Angular Signal Forms , the @angular/forms/signals API of Angular 21 and newer. The form model is a signal, form() declares its validators and the [formField] directive binds the component to a field. The field also sets the invalid state of the component, so the component is styled as invalid before any interaction, while the messages below appear once the field is touched or the form is submitted.",
|
|
29290
|
+
"examples": {
|
|
29291
|
+
"typescript": "import { Component, inject, signal } from '@angular/core';\nimport { form, FormField, required, submit } from '@angular/forms/signals';\nimport { MessageModule } from '@exhaustive-ui/core/message';\nimport { RadioButtonModule } from '@exhaustive-ui/core/radiobutton';\nimport { ToastModule } from '@exhaustive-ui/core/toast';\nimport { ButtonModule } from '@exhaustive-ui/core/button';\nimport { MessageService } from '@exhaustive-ui/core/api';\n\ninterface Category {\n name: string;\n key: string;\n}\n\n@Component({\n template: `\n <p-toast />\n <div class=\"card flex justify-center\">\n <form novalidate (submit)=\"onSubmit($event)\" class=\"flex flex-col gap-4\">\n <div class=\"flex flex-wrap gap-4\">\n @for (category of categories; track category.key) {\n <div class=\"flex items-center gap-2\">\n <p-radiobutton [formField]=\"exampleForm.selectedCategory\" [inputId]=\"category.key\" [value]=\"category\" />\n <label [for]=\"category.key\"> {{ category.name }} </label>\n </div>\n }\n </div>\n @let selectedCategory = exampleForm.selectedCategory();\n @if (selectedCategory.invalid() && selectedCategory.touched()) {\n <p-message severity=\"error\" size=\"small\" variant=\"simple\"> At least one ingredient must be selected. </p-message>\n }\n <button pButton severity=\"secondary\" type=\"submit\"><span pButtonLabel>Submit</span></button>\n </form>\n </div>\n `,\n standalone: true,\n imports: [MessageModule, RadioButtonModule, ToastModule, ButtonModule, FormField]\n})\nexport class RadiobuttonSignalformsDemo {\n messageService = inject(MessageService);\n categories: Category[];\n model = signal<{ selectedCategory: Category | null }>({ selectedCategory: null });\n exampleForm = form(this.model, (f) => {\n required(f.selectedCategory);\n });\n\n onSubmit(event: Event) {\n event.preventDefault();\n submit(this.exampleForm, async () => {\n this.messageService.add({ severity: 'success', summary: 'Success', detail: 'Form is submitted', life: 3000 });\n this.exampleForm().reset({ selectedCategory: null });\n });\n }\n}"
|
|
29292
|
+
}
|
|
29293
|
+
},
|
|
29115
29294
|
{
|
|
29116
29295
|
"id": "sizes",
|
|
29117
29296
|
"label": "Sizes",
|
|
@@ -29547,6 +29726,14 @@
|
|
|
29547
29726
|
"typescript": "import { Component } from '@angular/core';\nimport { FormsModule } from '@angular/forms';\nimport { RatingModule } from '@exhaustive-ui/core/rating';\n\n@Component({\n template: `\n <div class=\"card flex justify-center\">\n <p-rating [(ngModel)]=\"value\" [readonly]=\"true\" />\n </div>\n `,\n standalone: true,\n imports: [RatingModule, FormsModule]\n})\nexport class RatingReadonlyDemo {\n value: number = 3;\n}"
|
|
29548
29727
|
}
|
|
29549
29728
|
},
|
|
29729
|
+
{
|
|
29730
|
+
"id": "signalforms",
|
|
29731
|
+
"label": "Signal Forms",
|
|
29732
|
+
"description": "Rating can also be used with Angular Signal Forms , the @angular/forms/signals API of Angular 21 and newer. The form model is a signal, form() declares its validators and the [formField] directive binds the component to a field. The field also sets the invalid state of the component, so the component is styled as invalid before any interaction, while the messages below appear once the field is touched or the form is submitted.",
|
|
29733
|
+
"examples": {
|
|
29734
|
+
"typescript": "import { Component, inject, signal } from '@angular/core';\nimport { form, FormField, required, submit } from '@angular/forms/signals';\nimport { MessageModule } from '@exhaustive-ui/core/message';\nimport { RatingModule } from '@exhaustive-ui/core/rating';\nimport { ToastModule } from '@exhaustive-ui/core/toast';\nimport { ButtonModule } from '@exhaustive-ui/core/button';\nimport { MessageService } from '@exhaustive-ui/core/api';\n\n@Component({\n template: `\n <p-toast />\n <div class=\"card flex justify-center\">\n <form novalidate (submit)=\"onSubmit($event)\" class=\"flex flex-col gap-4 w-40\">\n <div class=\"flex flex-col items-center gap-2\">\n <p-rating [formField]=\"exampleForm.ratingValue\" />\n @let ratingValue = exampleForm.ratingValue();\n @if (ratingValue.invalid() && ratingValue.touched()) {\n <p-message severity=\"error\" size=\"small\" variant=\"simple\">Value is required.</p-message>\n }\n </div>\n <button pButton severity=\"secondary\" type=\"submit\"><span pButtonLabel>Submit</span></button>\n </form>\n </div>\n `,\n standalone: true,\n imports: [MessageModule, RatingModule, ToastModule, ButtonModule, FormField]\n})\nexport class RatingSignalformsDemo {\n messageService = inject(MessageService);\n model = signal<{ ratingValue: number | null }>({ ratingValue: null });\n exampleForm = form(this.model, (f) => {\n required(f.ratingValue);\n });\n\n onSubmit(event: Event) {\n event.preventDefault();\n submit(this.exampleForm, async () => {\n this.messageService.add({ severity: 'success', summary: 'Success', detail: 'Form is submitted', life: 3000 });\n this.exampleForm().reset({ ratingValue: null });\n });\n }\n}"
|
|
29735
|
+
}
|
|
29736
|
+
},
|
|
29550
29737
|
{
|
|
29551
29738
|
"id": "template",
|
|
29552
29739
|
"label": "Template",
|
|
@@ -30790,6 +30977,14 @@
|
|
|
30790
30977
|
"typescript": "import { Component, inject } from '@angular/core';\nimport { ReactiveFormsModule } from '@angular/forms';\nimport { SelectModule } from '@exhaustive-ui/core/select';\nimport { MessageModule } from '@exhaustive-ui/core/message';\nimport { ToastModule } from '@exhaustive-ui/core/toast';\nimport { ButtonModule } from '@exhaustive-ui/core/button';\nimport { MessageService } from '@exhaustive-ui/core/api';\n\ninterface City {\n name: string;\n code: string;\n}\n\n@Component({\n template: `\n <p-toast />\n <div class=\"card flex justify-center\">\n <form [formGroup]=\"exampleForm\" (ngSubmit)=\"onSubmit()\" class=\"flex flex-col gap-4 w-full sm:w-56\">\n <div class=\"flex flex-col gap-1\">\n <p-select formControlName=\"city\" [options]=\"cities\" [invalid]=\"isInvalid('city')\" optionLabel=\"name\" placeholder=\"Select a City\" class=\"w-full md:w-56\" />\n @if (isInvalid('city')) {\n <p-message severity=\"error\" size=\"small\" variant=\"simple\">City is required.</p-message>\n }\n </div>\n <button pButton severity=\"secondary\" type=\"submit\"><span pButtonLabel>Submit</span></button>\n </form>\n </div>\n `,\n standalone: true,\n imports: [SelectModule, MessageModule, ToastModule, ButtonModule, ReactiveFormsModule]\n})\nexport class SelectReactiveformsDemo {\n messageService = inject(MessageService);\n cities: City[];\n exampleForm: FormGroup | undefined;\n formSubmitted: boolean = false;\n\n constructor() {\n this.exampleForm = this.fb.group({\n city: ['', Validators.required]\n });\n }\n\n onSubmit() {\n this.formSubmitted = true;\n if (this.exampleForm.valid) {\n this.messageService.add({ severity: 'success', summary: 'Success', detail: 'Form is submitted', life: 3000 });\n this.exampleForm.reset();\n this.formSubmitted = false;\n }\n }\n\n isInvalid(controlName: string) {\n const control = this.exampleForm.get(controlName);\n return control?.invalid && (control.touched || this.formSubmitted);\n }\n}"
|
|
30791
30978
|
}
|
|
30792
30979
|
},
|
|
30980
|
+
{
|
|
30981
|
+
"id": "signalforms",
|
|
30982
|
+
"label": "Signal Forms",
|
|
30983
|
+
"description": "Select can also be used with Angular Signal Forms , the @angular/forms/signals API of Angular 21 and newer. The form model is a signal, form() declares its validators and the [formField] directive binds the component to a field. The field also sets the invalid state of the component, so the component is styled as invalid before any interaction, while the messages below appear once the field is touched or the form is submitted.",
|
|
30984
|
+
"examples": {
|
|
30985
|
+
"typescript": "import { Component, inject, signal } from '@angular/core';\nimport { form, FormField, required, submit } from '@angular/forms/signals';\nimport { SelectModule } from '@exhaustive-ui/core/select';\nimport { MessageModule } from '@exhaustive-ui/core/message';\nimport { ToastModule } from '@exhaustive-ui/core/toast';\nimport { ButtonModule } from '@exhaustive-ui/core/button';\nimport { MessageService } from '@exhaustive-ui/core/api';\n\ninterface City {\n name: string;\n code: string;\n}\n\n@Component({\n template: `\n <p-toast />\n <div class=\"card flex justify-center\">\n <form novalidate (submit)=\"onSubmit($event)\" class=\"flex flex-col gap-4 w-full sm:w-56\">\n <div class=\"flex flex-col gap-1\">\n <p-select [formField]=\"exampleForm.city\" [options]=\"cities\" optionLabel=\"name\" placeholder=\"Select a City\" class=\"w-full md:w-56\" />\n @let city = exampleForm.city();\n @if (city.invalid() && city.touched()) {\n <p-message severity=\"error\" size=\"small\" variant=\"simple\">City is required.</p-message>\n }\n </div>\n <button pButton severity=\"secondary\" type=\"submit\"><span pButtonLabel>Submit</span></button>\n </form>\n </div>\n `,\n standalone: true,\n imports: [SelectModule, MessageModule, ToastModule, ButtonModule, FormField]\n})\nexport class SelectSignalformsDemo {\n messageService = inject(MessageService);\n cities: City[];\n model = signal<{ city: City | null }>({ city: null });\n exampleForm = form(this.model, (f) => {\n required(f.city);\n });\n\n onSubmit(event: Event) {\n event.preventDefault();\n submit(this.exampleForm, async () => {\n this.messageService.add({ severity: 'success', summary: 'Success', detail: 'Form is submitted', life: 3000 });\n this.exampleForm().reset({ city: null });\n });\n }\n}"
|
|
30986
|
+
}
|
|
30987
|
+
},
|
|
30793
30988
|
{
|
|
30794
30989
|
"id": "sizes",
|
|
30795
30990
|
"label": "Sizes",
|
|
@@ -30911,21 +31106,21 @@
|
|
|
30911
31106
|
},
|
|
30912
31107
|
{
|
|
30913
31108
|
"name": "pattern",
|
|
30914
|
-
"type": "
|
|
31109
|
+
"type": "InputSignalWithTransform<string, string | readonly RegExp[]>",
|
|
30915
31110
|
"default": "undefined",
|
|
30916
31111
|
"description": "Specifies the value must match the pattern.",
|
|
30917
31112
|
"deprecated": ""
|
|
30918
31113
|
},
|
|
30919
31114
|
{
|
|
30920
31115
|
"name": "min",
|
|
30921
|
-
"type": "
|
|
31116
|
+
"type": "InputSignalWithTransform<number, unknown>",
|
|
30922
31117
|
"default": "undefined",
|
|
30923
31118
|
"description": "The value must be greater than or equal to the value.",
|
|
30924
31119
|
"deprecated": ""
|
|
30925
31120
|
},
|
|
30926
31121
|
{
|
|
30927
31122
|
"name": "max",
|
|
30928
|
-
"type": "
|
|
31123
|
+
"type": "InputSignalWithTransform<number, unknown>",
|
|
30929
31124
|
"default": "undefined",
|
|
30930
31125
|
"description": "The value must be less than or equal to the value.",
|
|
30931
31126
|
"deprecated": ""
|
|
@@ -32074,6 +32269,14 @@
|
|
|
32074
32269
|
"typescript": "import { Component, inject } from '@angular/core';\nimport { ReactiveFormsModule } from '@angular/forms';\nimport { MessageModule } from '@exhaustive-ui/core/message';\nimport { SelectButtonModule } from '@exhaustive-ui/core/selectbutton';\nimport { ToastModule } from '@exhaustive-ui/core/toast';\nimport { ButtonModule } from '@exhaustive-ui/core/button';\nimport { MessageService } from '@exhaustive-ui/core/api';\n\n@Component({\n template: `\n <p-toast />\n <div class=\"card flex justify-center\">\n <form [formGroup]=\"exampleForm\" (ngSubmit)=\"onSubmit()\" class=\"flex flex-col gap-4\">\n <div class=\"flex flex-col gap-1\">\n <p-selectbutton [options]=\"stateOptions\" formControlName=\"value\" [invalid]=\"isInvalid('value')\" optionLabel=\"label\" optionValue=\"value\" />\n @if (isInvalid('value')) {\n <p-message severity=\"error\" size=\"small\" variant=\"simple\">Selection is required</p-message>\n }\n </div>\n <button pButton type=\"submit\"><span pButtonLabel>Submit</span></button>\n </form>\n </div>\n `,\n standalone: true,\n imports: [MessageModule, SelectButtonModule, ToastModule, ButtonModule, ReactiveFormsModule]\n})\nexport class SelectbuttonReactiveformsDemo {\n messageService = inject(MessageService);\n exampleForm: FormGroup | undefined;\n formSubmitted: boolean = false;\n stateOptions: any[];\n\n constructor() {\n this.exampleForm = this.fb.group({\n value: ['', Validators.required]\n });\n }\n\n onSubmit() {\n this.formSubmitted = true;\n if (this.exampleForm.valid) {\n this.messageService.add({ severity: 'success', summary: 'Success', detail: 'Form is submitted', life: 3000 });\n this.exampleForm.reset();\n this.formSubmitted = false;\n }\n }\n\n isInvalid(controlName: string) {\n const control = this.exampleForm.get(controlName);\n return control?.invalid && (control.touched || this.formSubmitted);\n }\n}"
|
|
32075
32270
|
}
|
|
32076
32271
|
},
|
|
32272
|
+
{
|
|
32273
|
+
"id": "signalforms",
|
|
32274
|
+
"label": "Signal Forms",
|
|
32275
|
+
"description": "SelectButton can also be used with Angular Signal Forms , the @angular/forms/signals API of Angular 21 and newer. The form model is a signal, form() declares its validators and the [formField] directive binds the component to a field. The field also sets the invalid state of the component, so the component is styled as invalid before any interaction, while the messages below appear once the field is touched or the form is submitted.",
|
|
32276
|
+
"examples": {
|
|
32277
|
+
"typescript": "import { Component, inject, signal } from '@angular/core';\nimport { form, FormField, required, submit } from '@angular/forms/signals';\nimport { MessageModule } from '@exhaustive-ui/core/message';\nimport { SelectButtonModule } from '@exhaustive-ui/core/selectbutton';\nimport { ToastModule } from '@exhaustive-ui/core/toast';\nimport { ButtonModule } from '@exhaustive-ui/core/button';\nimport { MessageService } from '@exhaustive-ui/core/api';\n\n@Component({\n template: `\n <p-toast />\n <div class=\"card flex justify-center\">\n <form novalidate (submit)=\"onSubmit($event)\" class=\"flex flex-col gap-4\">\n <div class=\"flex flex-col gap-1\">\n <p-selectbutton [options]=\"stateOptions\" [formField]=\"exampleForm.value\" optionLabel=\"label\" optionValue=\"value\" />\n @let value = exampleForm.value();\n @if (value.invalid() && value.touched()) {\n <p-message severity=\"error\" size=\"small\" variant=\"simple\">Selection is required</p-message>\n }\n </div>\n <button pButton severity=\"secondary\" type=\"submit\"><span pButtonLabel>Submit</span></button>\n </form>\n </div>\n `,\n standalone: true,\n imports: [MessageModule, SelectButtonModule, ToastModule, ButtonModule, FormField]\n})\nexport class SelectbuttonSignalformsDemo {\n messageService = inject(MessageService);\n stateOptions: any[];\n model = signal({ value: '' });\n exampleForm = form(this.model, (f) => {\n required(f.value);\n });\n\n onSubmit(event: Event) {\n event.preventDefault();\n submit(this.exampleForm, async () => {\n this.messageService.add({ severity: 'success', summary: 'Success', detail: 'Form is submitted', life: 3000 });\n this.exampleForm().reset({ value: '' });\n });\n }\n}"
|
|
32278
|
+
}
|
|
32279
|
+
},
|
|
32077
32280
|
{
|
|
32078
32281
|
"id": "sizes",
|
|
32079
32282
|
"label": "Sizes",
|
|
@@ -32192,13 +32395,6 @@
|
|
|
32192
32395
|
"description": "Whether selection can be cleared.",
|
|
32193
32396
|
"deprecated": ""
|
|
32194
32397
|
},
|
|
32195
|
-
{
|
|
32196
|
-
"name": "tabindex",
|
|
32197
|
-
"type": "InputSignalWithTransform<number, unknown>",
|
|
32198
|
-
"default": "...",
|
|
32199
|
-
"description": "Index of the element in tabbing order.",
|
|
32200
|
-
"deprecated": ""
|
|
32201
|
-
},
|
|
32202
32398
|
{
|
|
32203
32399
|
"name": "multiple",
|
|
32204
32400
|
"type": "InputSignalWithTransform<boolean, unknown>",
|
|
@@ -32531,6 +32727,14 @@
|
|
|
32531
32727
|
"typescript": "import { Component, inject } from '@angular/core';\nimport { ReactiveFormsModule } from '@angular/forms';\nimport { MessageModule } from '@exhaustive-ui/core/message';\nimport { SliderModule } from '@exhaustive-ui/core/slider';\nimport { ToastModule } from '@exhaustive-ui/core/toast';\nimport { ButtonModule } from '@exhaustive-ui/core/button';\nimport { MessageService } from '@exhaustive-ui/core/api';\n\n@Component({\n template: `\n <p-toast />\n <div class=\"card flex justify-center\">\n <form [formGroup]=\"exampleForm\" (ngSubmit)=\"onSubmit()\" class=\"flex flex-col gap-4\">\n <div class=\"flex flex-col gap-4\">\n <p-slider formControlName=\"value\" class=\"w-56\" />\n @if (isInvalid('value')) {\n <p-message severity=\"error\" size=\"small\" variant=\"simple\">Must be greater than 25.</p-message>\n }\n </div>\n <button pButton severity=\"secondary\" type=\"submit\"><span pButtonLabel>Submit</span></button>\n </form>\n </div>\n `,\n standalone: true,\n imports: [MessageModule, SliderModule, ToastModule, ButtonModule, ReactiveFormsModule]\n})\nexport class SliderReactiveformsDemo {\n messageService = inject(MessageService);\n exampleForm: FormGroup | undefined;\n formSubmitted: boolean = false;\n\n constructor() {\n this.exampleForm = this.fb.group({\n value: ['', Validators.required]\n });\n }\n\n onSubmit() {\n this.formSubmitted = true;\n if (this.exampleForm.valid) {\n this.messageService.add({ severity: 'success', summary: 'Success', detail: 'Form is submitted', life: 3000 });\n this.exampleForm.reset();\n this.formSubmitted = false;\n }\n }\n\n isInvalid(controlName: string) {\n const control = this.exampleForm.get(controlName);\n return control?.invalid && (control.touched || this.formSubmitted);\n }\n}"
|
|
32532
32728
|
}
|
|
32533
32729
|
},
|
|
32730
|
+
{
|
|
32731
|
+
"id": "signalforms",
|
|
32732
|
+
"label": "Signal Forms",
|
|
32733
|
+
"description": "Slider can also be used with Angular Signal Forms , the @angular/forms/signals API of Angular 21 and newer. The form model is a signal, form() declares its validators and the [formField] directive binds the component to a field. The field also sets the invalid state of the component, so the component is styled as invalid before any interaction, while the messages below appear once the field is touched or the form is submitted.",
|
|
32734
|
+
"examples": {
|
|
32735
|
+
"typescript": "import { Component, inject, signal } from '@angular/core';\nimport { form, FormField, submit, validate } from '@angular/forms/signals';\nimport { MessageModule } from '@exhaustive-ui/core/message';\nimport { SliderModule } from '@exhaustive-ui/core/slider';\nimport { ToastModule } from '@exhaustive-ui/core/toast';\nimport { ButtonModule } from '@exhaustive-ui/core/button';\nimport { MessageService } from '@exhaustive-ui/core/api';\n\n@Component({\n template: `\n <p-toast />\n <div class=\"card flex justify-center\">\n <form novalidate (submit)=\"onSubmit($event)\" class=\"flex flex-col gap-4\">\n <div class=\"flex flex-col gap-4\">\n <p-slider [formField]=\"exampleForm.value\" class=\"w-56\" />\n @let value = exampleForm.value();\n @if (value.invalid() && value.touched()) {\n <p-message severity=\"error\" size=\"small\" variant=\"simple\">Must be greater than 25.</p-message>\n }\n </div>\n <button pButton severity=\"secondary\" type=\"submit\"><span pButtonLabel>Submit</span></button>\n </form>\n </div>\n `,\n standalone: true,\n imports: [MessageModule, SliderModule, ToastModule, ButtonModule, FormField]\n})\nexport class SliderSignalformsDemo {\n messageService = inject(MessageService);\n model = signal({ value: 0 });\n exampleForm = form(this.model, (f) => {\n // min() would also set the start of the slider range, so the lower bound is checked by a validator\n validate(f.value, ({ value }) => (value() > 25 ? null : { kind: 'min' }));\n });\n\n onSubmit(event: Event) {\n event.preventDefault();\n submit(this.exampleForm, async () => {\n this.messageService.add({ severity: 'success', summary: 'Success', detail: 'Form is submitted', life: 3000 });\n this.exampleForm().reset({ value: 0 });\n });\n }\n}"
|
|
32736
|
+
}
|
|
32737
|
+
},
|
|
32534
32738
|
{
|
|
32535
32739
|
"id": "step",
|
|
32536
32740
|
"label": "Step",
|
|
@@ -34044,13 +34248,6 @@
|
|
|
34044
34248
|
"description": "A boolean variable that captures user input.",
|
|
34045
34249
|
"deprecated": ""
|
|
34046
34250
|
},
|
|
34047
|
-
{
|
|
34048
|
-
"name": "transitionOptions",
|
|
34049
|
-
"type": "InputSignal<string>",
|
|
34050
|
-
"default": "400ms cubic-bezier(0.86, 0, 0.07, 1)",
|
|
34051
|
-
"description": "Transition options of the animation.",
|
|
34052
|
-
"deprecated": "since v21.0.0, use "
|
|
34053
|
-
},
|
|
34054
34251
|
{
|
|
34055
34252
|
"name": "motionOptions",
|
|
34056
34253
|
"type": "InputSignal<MotionOptions>",
|
|
@@ -35286,7 +35483,7 @@
|
|
|
35286
35483
|
"templates": null,
|
|
35287
35484
|
"emits": [
|
|
35288
35485
|
{
|
|
35289
|
-
"name": "
|
|
35486
|
+
"name": "onSelectAllChange",
|
|
35290
35487
|
"parameters": [
|
|
35291
35488
|
{
|
|
35292
35489
|
"name": "event",
|
|
@@ -36849,6 +37046,14 @@
|
|
|
36849
37046
|
"typescript": "import { Component, inject } from '@angular/core';\nimport { ReactiveFormsModule } from '@angular/forms';\nimport { MessageModule } from '@exhaustive-ui/core/message';\nimport { ToastModule } from '@exhaustive-ui/core/toast';\nimport { ButtonModule } from '@exhaustive-ui/core/button';\nimport { MessageService } from '@exhaustive-ui/core/api';\n\n@Component({\n template: `\n <p-toast />\n <div class=\"card flex justify-center\">\n <form [formGroup]=\"exampleForm\" (ngSubmit)=\"onSubmit()\" class=\"flex flex-col gap-4\">\n <div class=\"flex flex-col gap-1\">\n <textarea rows=\"5\" cols=\"30\" pTextarea formControlName=\"address\" [invalid]=\"isInvalid('address')\"></textarea>\n @if (isInvalid('address')) {\n <p-message severity=\"error\" size=\"small\" variant=\"simple\">Address is required..</p-message>\n }\n </div>\n <button pButton severity=\"secondary\" type=\"submit\"><span pButtonLabel>Submit</span></button>\n </form>\n </div>\n `,\n standalone: true,\n imports: [MessageModule, ToastModule, ButtonModule, ReactiveFormsModule]\n})\nexport class TextareaReactiveformsDemo {\n messageService = inject(MessageService);\n items: any[] | undefined;\n exampleForm: FormGroup | undefined;\n formSubmitted: boolean = false;\n\n constructor() {\n this.exampleForm = this.fb.group({\n address: ['', Validators.required]\n });\n }\n\n onSubmit() {\n this.formSubmitted = true;\n if (this.exampleForm.valid) {\n this.messageService.add({ severity: 'success', summary: 'Success', detail: 'Form is submitted', life: 3000 });\n this.exampleForm.reset();\n this.formSubmitted = false;\n }\n }\n\n isInvalid(controlName: string) {\n const control = this.exampleForm.get(controlName);\n return control?.invalid && (control.touched || this.formSubmitted);\n }\n}"
|
|
36850
37047
|
}
|
|
36851
37048
|
},
|
|
37049
|
+
{
|
|
37050
|
+
"id": "signalforms",
|
|
37051
|
+
"label": "Signal Forms",
|
|
37052
|
+
"description": "Textarea can also be used with Angular Signal Forms , the @angular/forms/signals API of Angular 21 and newer. The form model is a signal, form() declares its validators and the [formField] directive binds the component to a field. The field also sets the invalid state of the component, so the component is styled as invalid before any interaction, while the messages below appear once the field is touched or the form is submitted.",
|
|
37053
|
+
"examples": {
|
|
37054
|
+
"typescript": "import { Component, inject, signal } from '@angular/core';\nimport { form, FormField, required, submit } from '@angular/forms/signals';\nimport { MessageModule } from '@exhaustive-ui/core/message';\nimport { ToastModule } from '@exhaustive-ui/core/toast';\nimport { ButtonModule } from '@exhaustive-ui/core/button';\nimport { MessageService } from '@exhaustive-ui/core/api';\n\n@Component({\n template: `\n <p-toast />\n <div class=\"card flex justify-center\">\n <form novalidate (submit)=\"onSubmit($event)\" class=\"flex flex-col gap-4\">\n <div class=\"flex flex-col gap-1\">\n <textarea rows=\"5\" cols=\"30\" pTextarea [formField]=\"exampleForm.address\"></textarea>\n @let address = exampleForm.address();\n @if (address.invalid() && address.touched()) {\n <p-message severity=\"error\" size=\"small\" variant=\"simple\">Address is required.</p-message>\n }\n </div>\n <button pButton severity=\"secondary\" type=\"submit\"><span pButtonLabel>Submit</span></button>\n </form>\n </div>\n `,\n standalone: true,\n imports: [MessageModule, ToastModule, ButtonModule, FormField]\n})\nexport class TextareaSignalformsDemo {\n messageService = inject(MessageService);\n model = signal({ address: '' });\n exampleForm = form(this.model, (f) => {\n required(f.address);\n });\n\n onSubmit(event: Event) {\n event.preventDefault();\n submit(this.exampleForm, async () => {\n this.messageService.add({ severity: 'success', summary: 'Success', detail: 'Form is submitted', life: 3000 });\n this.exampleForm().reset({ address: '' });\n });\n }\n}"
|
|
37055
|
+
}
|
|
37056
|
+
},
|
|
36852
37057
|
{
|
|
36853
37058
|
"id": "sizes",
|
|
36854
37059
|
"label": "Sizes",
|
|
@@ -38615,6 +38820,14 @@
|
|
|
38615
38820
|
"typescript": "import { Component, inject } from '@angular/core';\nimport { ReactiveFormsModule } from '@angular/forms';\nimport { MessageModule } from '@exhaustive-ui/core/message';\nimport { ToastModule } from '@exhaustive-ui/core/toast';\nimport { ToggleButtonModule } from '@exhaustive-ui/core/togglebutton';\nimport { ButtonModule } from '@exhaustive-ui/core/button';\nimport { MessageService } from '@exhaustive-ui/core/api';\n\n@Component({\n template: `\n <p-toast />\n <div class=\"card flex justify-center\">\n <form [formGroup]=\"exampleForm\" (ngSubmit)=\"onSubmit()\" class=\"flex flex-col items-center gap-4\">\n <div class=\"flex flex-col items-center gap-1\">\n <p-togglebutton name=\"consent\" formControlName=\"checked\" [invalid]=\"isInvalid('checked')\" onLabel=\"Accept All\" offLabel=\"Reject All\" class=\"min-w-40\" />\n @if (isInvalid('checked')) {\n <p-message severity=\"error\" size=\"small\" variant=\"simple\">Consent is mandatory.</p-message>\n }\n </div>\n <button pButton type=\"submit\"><span pButtonLabel>Submit</span></button>\n </form>\n </div>\n `,\n standalone: true,\n imports: [MessageModule, ToastModule, ToggleButtonModule, ButtonModule, ReactiveFormsModule]\n})\nexport class TogglebuttonReactiveformsDemo {\n messageService = inject(MessageService);\n exampleForm: FormGroup | undefined;\n formSubmitted: boolean = false;\n\n constructor() {\n this.exampleForm = this.fb.group({\n checked: [false, Validators.requiredTrue]\n });\n }\n\n onSubmit() {\n this.formSubmitted = true;\n if (this.exampleForm.valid) {\n this.messageService.add({ severity: 'success', summary: 'Success', detail: 'Form is submitted', life: 3000 });\n this.exampleForm.reset();\n this.formSubmitted = false;\n }\n }\n\n isInvalid(controlName: string) {\n const control = this.exampleForm.get(controlName);\n return control?.invalid && (control.touched || this.formSubmitted);\n }\n}"
|
|
38616
38821
|
}
|
|
38617
38822
|
},
|
|
38823
|
+
{
|
|
38824
|
+
"id": "signalforms",
|
|
38825
|
+
"label": "Signal Forms",
|
|
38826
|
+
"description": "ToggleButton can also be used with Angular Signal Forms , the @angular/forms/signals API of Angular 21 and newer. The form model is a signal, form() declares its validators and the [formField] directive binds the component to a field. The field also sets the invalid state of the component, so the component is styled as invalid before any interaction, while the messages below appear once the field is touched or the form is submitted.",
|
|
38827
|
+
"examples": {
|
|
38828
|
+
"typescript": "import { Component, inject, signal } from '@angular/core';\nimport { form, FormField, required, submit } from '@angular/forms/signals';\nimport { MessageModule } from '@exhaustive-ui/core/message';\nimport { ToastModule } from '@exhaustive-ui/core/toast';\nimport { ToggleButtonModule } from '@exhaustive-ui/core/togglebutton';\nimport { ButtonModule } from '@exhaustive-ui/core/button';\nimport { MessageService } from '@exhaustive-ui/core/api';\n\n@Component({\n template: `\n <p-toast />\n <div class=\"card flex justify-center\">\n <form novalidate (submit)=\"onSubmit($event)\" class=\"flex flex-col items-center gap-4\">\n <div class=\"flex flex-col items-center gap-1\">\n <p-togglebutton [formField]=\"exampleForm.checked\" onLabel=\"Accept All\" offLabel=\"Reject All\" class=\"min-w-40\" />\n @let checked = exampleForm.checked();\n @if (checked.invalid() && checked.touched()) {\n <p-message severity=\"error\" size=\"small\" variant=\"simple\">Consent is mandatory.</p-message>\n }\n </div>\n <button pButton severity=\"secondary\" type=\"submit\"><span pButtonLabel>Submit</span></button>\n </form>\n </div>\n `,\n standalone: true,\n imports: [MessageModule, ToastModule, ToggleButtonModule, ButtonModule, FormField]\n})\nexport class TogglebuttonSignalformsDemo {\n messageService = inject(MessageService);\n model = signal({ checked: false });\n exampleForm = form(this.model, (f) => {\n // required() rejects false, like Validators.requiredTrue\n required(f.checked);\n });\n\n onSubmit(event: Event) {\n event.preventDefault();\n submit(this.exampleForm, async () => {\n this.messageService.add({ severity: 'success', summary: 'Success', detail: 'Form is submitted', life: 3000 });\n this.exampleForm().reset({ checked: false });\n });\n }\n}"
|
|
38829
|
+
}
|
|
38830
|
+
},
|
|
38618
38831
|
{
|
|
38619
38832
|
"id": "sizes",
|
|
38620
38833
|
"label": "Sizes",
|
|
@@ -39079,6 +39292,14 @@
|
|
|
39079
39292
|
"typescript": "import { Component, inject } from '@angular/core';\nimport { ReactiveFormsModule } from '@angular/forms';\nimport { MessageModule } from '@exhaustive-ui/core/message';\nimport { ToastModule } from '@exhaustive-ui/core/toast';\nimport { ToggleSwitchModule } from '@exhaustive-ui/core/toggleswitch';\nimport { ButtonModule } from '@exhaustive-ui/core/button';\nimport { MessageService } from '@exhaustive-ui/core/api';\n\n@Component({\n template: `\n <p-toast />\n <div class=\"card flex justify-center\">\n <form [formGroup]=\"exampleForm\" (ngSubmit)=\"onSubmit()\" class=\"flex flex-col gap-4 w-48\">\n <div class=\"flex flex-col items-center gap-2\">\n <p-toggleswitch name=\"activation\" formControlName=\"activation\" [invalid]=\"isInvalid('activation')\" />\n @if (isInvalid('activation')) {\n <p-message severity=\"error\" size=\"small\" variant=\"simple\">Activation is required.</p-message>\n }\n </div>\n <button pButton severity=\"secondary\" type=\"submit\"><span pButtonLabel>Submit</span></button>\n </form>\n </div>\n `,\n standalone: true,\n imports: [MessageModule, ToastModule, ToggleSwitchModule, ButtonModule, ReactiveFormsModule]\n})\nexport class ToggleswitchReactiveformsDemo {\n messageService = inject(MessageService);\n exampleForm: FormGroup | undefined;\n formSubmitted: boolean = false;\n\n constructor() {\n this.exampleForm = this.fb.group({\n activation: ['', Validators.required]\n });\n }\n\n onSubmit() {\n this.formSubmitted = true;\n if (this.exampleForm.valid) {\n this.messageService.add({ severity: 'success', summary: 'Success', detail: 'Form is submitted', life: 3000 });\n this.exampleForm.reset();\n this.formSubmitted = false;\n }\n }\n\n isInvalid(controlName: string) {\n const control = this.exampleForm.get(controlName);\n return control?.invalid && (control.touched || this.formSubmitted);\n }\n}"
|
|
39080
39293
|
}
|
|
39081
39294
|
},
|
|
39295
|
+
{
|
|
39296
|
+
"id": "signalforms",
|
|
39297
|
+
"label": "Signal Forms",
|
|
39298
|
+
"description": "ToggleSwitch can also be used with Angular Signal Forms , the @angular/forms/signals API of Angular 21 and newer. The form model is a signal, form() declares its validators and the [formField] directive binds the component to a field. The field also sets the invalid state of the component, so the component is styled as invalid before any interaction, while the messages below appear once the field is touched or the form is submitted.",
|
|
39299
|
+
"examples": {
|
|
39300
|
+
"typescript": "import { Component, inject, signal } from '@angular/core';\nimport { form, FormField, required, submit } from '@angular/forms/signals';\nimport { MessageModule } from '@exhaustive-ui/core/message';\nimport { ToastModule } from '@exhaustive-ui/core/toast';\nimport { ToggleSwitchModule } from '@exhaustive-ui/core/toggleswitch';\nimport { ButtonModule } from '@exhaustive-ui/core/button';\nimport { MessageService } from '@exhaustive-ui/core/api';\n\n@Component({\n template: `\n <p-toast />\n <div class=\"card flex justify-center\">\n <form novalidate (submit)=\"onSubmit($event)\" class=\"flex flex-col gap-4 w-48\">\n <div class=\"flex flex-col items-center gap-2\">\n <p-toggleswitch [formField]=\"exampleForm.activation\" />\n @let activation = exampleForm.activation();\n @if (activation.invalid() && activation.touched()) {\n <p-message severity=\"error\" size=\"small\" variant=\"simple\">Activation is required.</p-message>\n }\n </div>\n <button pButton severity=\"secondary\" type=\"submit\"><span pButtonLabel>Submit</span></button>\n </form>\n </div>\n `,\n standalone: true,\n imports: [MessageModule, ToastModule, ToggleSwitchModule, ButtonModule, FormField]\n})\nexport class ToggleswitchSignalformsDemo {\n messageService = inject(MessageService);\n model = signal({ activation: false });\n exampleForm = form(this.model, (f) => {\n required(f.activation);\n });\n\n onSubmit(event: Event) {\n event.preventDefault();\n submit(this.exampleForm, async () => {\n this.messageService.add({ severity: 'success', summary: 'Success', detail: 'Form is submitted', life: 3000 });\n this.exampleForm().reset({ activation: false });\n });\n }\n}"
|
|
39301
|
+
}
|
|
39302
|
+
},
|
|
39082
39303
|
{
|
|
39083
39304
|
"id": "template",
|
|
39084
39305
|
"label": "Template",
|
|
@@ -39196,13 +39417,6 @@
|
|
|
39196
39417
|
"description": "Used to define a string that autocomplete attribute the current element.",
|
|
39197
39418
|
"deprecated": ""
|
|
39198
39419
|
},
|
|
39199
|
-
{
|
|
39200
|
-
"name": "size",
|
|
39201
|
-
"type": "InputSignal<\"small\" | \"large\">",
|
|
39202
|
-
"default": "undefined",
|
|
39203
|
-
"description": "Specifies the size of the component.",
|
|
39204
|
-
"deprecated": ""
|
|
39205
|
-
},
|
|
39206
39420
|
{
|
|
39207
39421
|
"name": "ariaLabelledBy",
|
|
39208
39422
|
"type": "InputSignal<string>",
|
|
@@ -39830,13 +40044,6 @@
|
|
|
39830
40044
|
"description": "Target element to attach the overlay, valid values are \"body\" or a local ng-template variable of another element (note: use binding with brackets for template variables, e.g. [appendTo]=\"mydiv\" for a div element having #mydiv as variable name).",
|
|
39831
40045
|
"deprecated": ""
|
|
39832
40046
|
},
|
|
39833
|
-
{
|
|
39834
|
-
"name": "ptTooltip",
|
|
39835
|
-
"type": "InputSignal<TooltipPassThrough>",
|
|
39836
|
-
"default": "undefined",
|
|
39837
|
-
"description": "Used to pass attributes to DOM elements inside the Tooltip component.",
|
|
39838
|
-
"deprecated": "use pTooltipPT instead."
|
|
39839
|
-
},
|
|
39840
40047
|
{
|
|
39841
40048
|
"name": "pTooltipPT",
|
|
39842
40049
|
"type": "InputSignal<TooltipPassThrough>",
|
|
@@ -40885,7 +41092,7 @@
|
|
|
40885
41092
|
{
|
|
40886
41093
|
"id": "accessibility",
|
|
40887
41094
|
"label": "Accessibility",
|
|
40888
|
-
"description": "Screen Reader Value to describe the component can either be provided with
|
|
41095
|
+
"description": "Screen Reader Value to describe the component can either be provided with ariaLabelledBy or ariaLabel props. The treeselect element has a combobox role in addition to aria-haspopup and aria-expanded attributes. The relation between the combobox and the popup is created with aria-controls that refers to the id of the popup. The popup list has an id that refers to the aria-controls attribute of the combobox element and uses tree as the role. Each list item has a treeitem role along with aria-label , aria-selected and aria-expanded attributes. In checkbox selection, aria-checked is used instead of aria-selected . Checkbox and toggle icons are hidden from screen readers as their parent element with treeitem role and attributes are used instead for readers and keyboard support. The container element of a treenode has the group role. The aria-setsize , aria-posinset and aria-level attributes are calculated implicitly and added to each treeitem. If filtering is enabled, filterInputProps can be defined to give aria-* props to the filter input element.",
|
|
40889
41096
|
"examples": null
|
|
40890
41097
|
},
|
|
40891
41098
|
{
|
|
@@ -40992,6 +41199,14 @@
|
|
|
40992
41199
|
"typescript": "import { Component, OnInit, inject } from '@angular/core';\nimport { ReactiveFormsModule } from '@angular/forms';\nimport { MessageModule } from '@exhaustive-ui/core/message';\nimport { ToastModule } from '@exhaustive-ui/core/toast';\nimport { TreeSelectModule } from '@exhaustive-ui/core/treeselect';\nimport { ButtonModule } from '@exhaustive-ui/core/button';\nimport { NodeService } from '@/service/nodeservice';\nimport { MessageService } from '@exhaustive-ui/core/api';\n\n@Component({\n template: `\n <p-toast />\n <div class=\"card flex justify-center\">\n <form [formGroup]=\"exampleForm\" (ngSubmit)=\"onSubmit()\" class=\"flex flex-col gap-4 w-full md:w-80\">\n <div class=\"flex flex-col gap-1\">\n <p-treeselect class=\"md:w-80 w-full\" formControlName=\"selectedNodes\" [options]=\"nodes\" placeholder=\"Select Item\" [invalid]=\"isInvalid('selectedNodes')\" />\n @if (isInvalid('selectedNodes')) {\n <p-message severity=\"error\" size=\"small\" variant=\"simple\">Selection is required.</p-message>\n }\n </div>\n <button pButton severity=\"secondary\" type=\"submit\"><span pButtonLabel>Submit</span></button>\n </form>\n </div>\n `,\n standalone: true,\n imports: [MessageModule, ToastModule, TreeSelectModule, ButtonModule, ReactiveFormsModule],\n providers: [NodeService]\n})\nexport class TreeselectReactiveformsDemo implements OnInit {\n private nodeService = inject(NodeService);\n messageService = inject(MessageService);\n nodes!: any[];\n exampleForm: FormGroup | undefined;\n formSubmitted: boolean = false;\n\n constructor() {\n this.nodeService.getFiles().then((files) => (this.nodes = files));\n this.exampleForm = this.fb.group({\n selectedNodes: ['', Validators.required]\n });\n }\n\n ngOnInit() {\n }\n\n onSubmit() {\n this.formSubmitted = true;\n if (this.exampleForm.valid) {\n this.messageService.add({ severity: 'success', summary: 'Success', detail: 'Form is submitted', life: 3000 });\n this.exampleForm.reset();\n this.formSubmitted = false;\n }\n }\n\n isInvalid(controlName: string) {\n const control = this.exampleForm.get(controlName);\n return control?.invalid && this.formSubmitted;\n }\n}"
|
|
40993
41200
|
}
|
|
40994
41201
|
},
|
|
41202
|
+
{
|
|
41203
|
+
"id": "signalforms",
|
|
41204
|
+
"label": "Signal Forms",
|
|
41205
|
+
"description": "TreeSelect can also be used with Angular Signal Forms , the @angular/forms/signals API of Angular 21 and newer. The form model is a signal, form() declares its validators and the [formField] directive binds the component to a field. The field also sets the invalid state of the component, so the component is styled as invalid before any interaction, while the messages below appear once the field is touched or the form is submitted.",
|
|
41206
|
+
"examples": {
|
|
41207
|
+
"typescript": "import { Component, OnInit, inject, signal } from '@angular/core';\nimport { form, FormField, required, submit } from '@angular/forms/signals';\nimport { MessageModule } from '@exhaustive-ui/core/message';\nimport { ToastModule } from '@exhaustive-ui/core/toast';\nimport { TreeSelectModule } from '@exhaustive-ui/core/treeselect';\nimport { ButtonModule } from '@exhaustive-ui/core/button';\nimport { NodeService } from '@/service/nodeservice';\nimport { TreeNode, MessageService } from '@exhaustive-ui/core/api';\n\n@Component({\n template: `\n <p-toast />\n <div class=\"card flex justify-center\">\n <form novalidate (submit)=\"onSubmit($event)\" class=\"flex flex-col gap-4 w-full md:w-80\">\n <div class=\"flex flex-col gap-1\">\n <p-treeselect class=\"md:w-80 w-full\" [formField]=\"exampleForm.selectedNodes\" [options]=\"nodes\" placeholder=\"Select Item\" />\n @let selectedNodes = exampleForm.selectedNodes();\n @if (selectedNodes.invalid() && selectedNodes.touched()) {\n <p-message severity=\"error\" size=\"small\" variant=\"simple\">Selection is required.</p-message>\n }\n </div>\n <button pButton severity=\"secondary\" type=\"submit\"><span pButtonLabel>Submit</span></button>\n </form>\n </div>\n `,\n standalone: true,\n imports: [MessageModule, ToastModule, TreeSelectModule, ButtonModule, FormField],\n providers: [NodeService]\n})\nexport class TreeselectSignalformsDemo implements OnInit {\n private nodeService = inject(NodeService);\n messageService = inject(MessageService);\n nodes!: any[];\n model = signal<{ selectedNodes: TreeNode | null }>({ selectedNodes: null });\n exampleForm = form(this.model, (f) => {\n required(f.selectedNodes);\n });\n\n constructor() {\n this.nodeService.getFiles().then((files) => (this.nodes = files));\n }\n\n ngOnInit() {\n }\n\n onSubmit(event: Event) {\n event.preventDefault();\n submit(this.exampleForm, async () => {\n this.messageService.add({ severity: 'success', summary: 'Success', detail: 'Form is submitted', life: 3000 });\n this.exampleForm().reset({ selectedNodes: null });\n });\n }\n}"
|
|
41208
|
+
}
|
|
41209
|
+
},
|
|
40995
41210
|
{
|
|
40996
41211
|
"id": "sizes",
|
|
40997
41212
|
"label": "Sizes",
|
|
@@ -42478,7 +42693,7 @@
|
|
|
42478
42693
|
"name": "rowTrackBy",
|
|
42479
42694
|
"type": "InputSignal<Function>",
|
|
42480
42695
|
"default": "...",
|
|
42481
|
-
"description": "Function to optimize the dom operations by delegating to ngForTrackBy, default algorithm checks for
|
|
42696
|
+
"description": "Function to optimize the dom operations by delegating to ngForTrackBy, default algorithm checks for the identity of the row node.",
|
|
42482
42697
|
"deprecated": ""
|
|
42483
42698
|
},
|
|
42484
42699
|
{
|
|
@@ -43477,63 +43692,59 @@
|
|
|
43477
43692
|
"description": "Setting up ExhaustiveUI in an Angular CLI project.",
|
|
43478
43693
|
"sections": [
|
|
43479
43694
|
{
|
|
43480
|
-
"id": "
|
|
43481
|
-
"label": "
|
|
43482
|
-
"description": "
|
|
43483
|
-
"examples": {
|
|
43484
|
-
"command": "# Using npm\nnpm install @exhaustive-ui/core @exhaustive-ui/themes\n\n# Using yarn\nyarn add @exhaustive-ui/core @exhaustive-ui/themes\n\n# Using pnpm\npnpm add @exhaustive-ui/core @exhaustive-ui/themes"
|
|
43485
|
-
}
|
|
43486
|
-
},
|
|
43487
|
-
{
|
|
43488
|
-
"id": "examples",
|
|
43489
|
-
"label": "Examples",
|
|
43490
|
-
"description": "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.",
|
|
43695
|
+
"id": "prerequisites",
|
|
43696
|
+
"label": "Prerequisites",
|
|
43697
|
+
"description": "ExhaustiveUI v22 targets Angular v22. Any workspace created with the Angular CLI works, standalone or NgModule based.\n\n- Angular v22, including `@angular/cdk`, `@angular/forms` and `@angular/router`; the form components work with template-driven forms, reactive forms and Signal Forms (`@angular/forms/signals`)\n- RxJS v7.8.1 or newer\n- A package manager of your choice — npm, yarn or pnpm\n\nAlready using PrimeNG? Do not follow this page. The [migration guide](https://v1.optimus.openng.org/migration/primeng) covers moving an existing PrimeNG v21\nworkspace, once updated to Angular v22, across with the `migrate-from-primeng` schematic, which is a separate command from the `ng add` below.",
|
|
43491
43698
|
"examples": null
|
|
43492
43699
|
},
|
|
43493
43700
|
{
|
|
43494
|
-
"id": "
|
|
43495
|
-
"label": "
|
|
43496
|
-
"description": "ExhaustiveUI
|
|
43701
|
+
"id": "compatibility",
|
|
43702
|
+
"label": "Angular Version Compatibility",
|
|
43703
|
+
"description": "Each ExhaustiveUI major targets a single Angular major. Install the version matching your workspace, and see the [update guide](https://exhaustive-ui.com/migration/update) when moving to a newer one.",
|
|
43497
43704
|
"examples": null
|
|
43498
43705
|
},
|
|
43499
43706
|
{
|
|
43500
|
-
"id": "
|
|
43501
|
-
"label": "
|
|
43502
|
-
"description": "
|
|
43707
|
+
"id": "ngadd",
|
|
43708
|
+
"label": "Install",
|
|
43709
|
+
"description": "The recommended way to add ExhaustiveUI to an Angular CLI workspace is a single command.\n\n```bash\nng add @exhaustive-ui/core\n```\n\nThe schematic asks which theme preset you want and then does the rest:\n\n- adds `@exhaustive-ui/core` and `@exhaustive-ui/themes` to your dependencies\n- wires `provideExhaustive` into your root providers with the chosen preset, in `app.config.ts` or your root NgModule\n- installs the packages\n\nPass the preset up front to skip the prompt, or skip the install step if you want to run it yourself:\n\n```bash\n# Choose the preset without the prompt — Aura, Lara, Material or Nora\nng add @exhaustive-ui/core --theme=Lara\n\n# Wire everything up but do not run the package install\nng add @exhaustive-ui/core --skip-install\n\n# Target a specific project in a multi-project workspace\nng add @exhaustive-ui/core --project=admin\n```\n\nIf 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\nnothing and fails with an error rather than reporting success, and points you at the [migration guide](https://v1.optimus.openng.org/migration/primeng), which\ncovers 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\nmigration schematic needs it there.",
|
|
43503
43710
|
"examples": null
|
|
43504
43711
|
},
|
|
43505
43712
|
{
|
|
43506
|
-
"id": "
|
|
43507
|
-
"label": "
|
|
43508
|
-
"description": "
|
|
43713
|
+
"id": "download",
|
|
43714
|
+
"label": "Download",
|
|
43715
|
+
"description": "Prefer to wire things up yourself? Install the packages from the [npm registry](https://www.npmjs.com/package/@exhaustive-ui/core) directly. The next section covers the provider\nsetup that `ng add` would have written for you.",
|
|
43509
43716
|
"examples": {
|
|
43510
|
-
"command": "
|
|
43717
|
+
"command": "# Using npm\nnpm install @exhaustive-ui/core @exhaustive-ui/themes\n\n# Using yarn\nyarn add @exhaustive-ui/core @exhaustive-ui/themes\n\n# Using pnpm\npnpm add @exhaustive-ui/core @exhaustive-ui/themes"
|
|
43511
43718
|
}
|
|
43512
43719
|
},
|
|
43513
43720
|
{
|
|
43514
|
-
"id": "
|
|
43515
|
-
"label": "
|
|
43516
|
-
"description": "
|
|
43721
|
+
"id": "provider",
|
|
43722
|
+
"label": "Provider",
|
|
43723
|
+
"description": "Add `provideExhaustive` to the list of providers in your `app.config.ts` and use the `theme` property to configure a theme such as Aura.\n\n```typescript\nimport { ApplicationConfig } from '@angular/core';\nimport { provideExhaustive } from '@exhaustive-ui/core/config';\nimport Aura from '@exhaustive-ui/themes/aura';\n\nexport const appConfig: ApplicationConfig = {\n providers: [\n provideExhaustive({\n theme: {\n preset: Aura\n }\n })\n ]\n};\n```",
|
|
43517
43724
|
"examples": null
|
|
43518
43725
|
},
|
|
43519
43726
|
{
|
|
43520
|
-
"id": "
|
|
43521
|
-
"label": "
|
|
43522
|
-
"description": "
|
|
43523
|
-
"examples":
|
|
43524
|
-
"typescript": "import { ApplicationConfig } from '@angular/core';\nimport { provideExhaustive } from '@exhaustive-ui/core/config';\nimport Aura from '@exhaustive-ui/themes/aura';\n\nexport const appConfig: ApplicationConfig = {\n providers: [\n provideExhaustive({\n theme: {\n preset: Aura\n }\n })\n ]\n};"
|
|
43525
|
-
}
|
|
43727
|
+
"id": "icons",
|
|
43728
|
+
"label": "Icons",
|
|
43729
|
+
"description": "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\n[OpenNG Icons](https://exhaustive-ui.com/icons), and component defaults such as the DatePicker arrows reference them too. Install it if you want the demos to look the way they do here.\n\n```bash\nnpm install @openng/icons\n```\n\nThen import the stylesheet, either from your global stylesheet or from the `styles` array in `angular.json`.\n\n```scss\n@import \"@openng/icons/openng-icons.css\";\n```",
|
|
43730
|
+
"examples": null
|
|
43526
43731
|
},
|
|
43527
43732
|
{
|
|
43528
43733
|
"id": "verify",
|
|
43529
43734
|
"label": "Verify",
|
|
43530
|
-
"description": "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
|
|
43735
|
+
"description": "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\ncorresponding component.",
|
|
43736
|
+
"examples": null
|
|
43737
|
+
},
|
|
43738
|
+
{
|
|
43739
|
+
"id": "examples",
|
|
43740
|
+
"label": "Examples",
|
|
43741
|
+
"description": "Every example in this documentation opens in StackBlitz from the code toolbar above each demo, already wired up with the current version. The\n[source repository](https://github.com/e-xiste/exhaustive-ui) is the reference for how the library itself is built and consumed.",
|
|
43531
43742
|
"examples": null
|
|
43532
43743
|
},
|
|
43533
43744
|
{
|
|
43534
|
-
"id": "
|
|
43535
|
-
"label": "
|
|
43536
|
-
"description": "
|
|
43745
|
+
"id": "nextsteps",
|
|
43746
|
+
"label": "Next Steps",
|
|
43747
|
+
"description": "Once you have ExhaustiveUI up and running, we recommend exploring the following resources to gain a deeper understanding of the library.\n\n- [Global configuration](https://exhaustive-ui.com/configuration)\n- [Styled mode](https://exhaustive-ui.com/theming/styled) and [unstyled mode](https://exhaustive-ui.com/theming/unstyled)\n- [Tailwind CSS integration](https://exhaustive-ui.com/tailwind)\n- [Pass Through](https://exhaustive-ui.com/passthrough) for direct access to the underlying elements\n- [Philosophy](https://exhaustive-ui.com/philosophy) — what this project promises, and what it does not\n- [FAQ](https://exhaustive-ui.com/faq)",
|
|
43537
43748
|
"examples": null
|
|
43538
43749
|
}
|
|
43539
43750
|
]
|
|
@@ -43545,102 +43756,98 @@
|
|
|
43545
43756
|
"description": "Application wide configuration for ExhaustiveUI.",
|
|
43546
43757
|
"sections": [
|
|
43547
43758
|
{
|
|
43548
|
-
"id": "
|
|
43549
|
-
"label": "
|
|
43550
|
-
"description": "The
|
|
43759
|
+
"id": "provider",
|
|
43760
|
+
"label": "Provider",
|
|
43761
|
+
"description": "The initial configuration is defined by the `provideExhaustive` provider during application startup.",
|
|
43551
43762
|
"examples": {
|
|
43552
|
-
"typescript": "provideExhaustive
|
|
43763
|
+
"typescript": "import { ApplicationConfig } from '@angular/core';\nimport { provideExhaustive } from '@exhaustive-ui/core/config';\n\nexport const appConfig: ApplicationConfig = {\n providers: [\n provideExhaustive({ /* options */ })\n ]\n};"
|
|
43553
43764
|
}
|
|
43554
43765
|
},
|
|
43555
43766
|
{
|
|
43556
43767
|
"id": "dynamic",
|
|
43557
43768
|
"label": "Dynamic",
|
|
43558
|
-
"description": "Inject the Exhaustive to your application to update the initial configuration at runtime.",
|
|
43769
|
+
"description": "Inject the `Exhaustive` to your application to update the initial configuration at runtime.",
|
|
43559
43770
|
"examples": {
|
|
43560
43771
|
"typescript": "import { Component, OnInit } from '@angular/core';\nimport { Exhaustive } from '@exhaustive-ui/core/config';\n\n@Component({\n selector: 'app-root',\n templateUrl: './app.component.html'\n})\nexport class AppComponent implements OnInit {\n\n constructor(private config: Exhaustive) {}\n\n ngOnInit() {\n this.config.ripple.set(true);\n }\n}"
|
|
43561
43772
|
}
|
|
43562
43773
|
},
|
|
43563
43774
|
{
|
|
43564
|
-
"id": "
|
|
43565
|
-
"label": "
|
|
43566
|
-
"description": "
|
|
43775
|
+
"id": "theme",
|
|
43776
|
+
"label": "Theme",
|
|
43777
|
+
"description": "ExhaustiveUI provides 4 predefined themes out of the box; Aura, Material, Lara and Nora. See the theming documentation for details.",
|
|
43567
43778
|
"examples": {
|
|
43568
|
-
"typescript": "import {
|
|
43779
|
+
"typescript": "import { ApplicationConfig } from '@angular/core';\nimport { provideExhaustive } from '@exhaustive-ui/core/config';\n\nimport Aura from '@exhaustive-ui/themes/aura';\n\nexport const appConfig: ApplicationConfig = {\n providers: [\n provideExhaustive({\n theme: {\n preset: Aura,\n options: {\n prefix: 'p',\n darkModeSelector: 'system',\n cssLayer: false\n }\n }\n })\n ]\n};"
|
|
43780
|
+
}
|
|
43781
|
+
},
|
|
43782
|
+
{
|
|
43783
|
+
"id": "ripple",
|
|
43784
|
+
"label": "Ripple",
|
|
43785
|
+
"description": "Ripple is an optional animation for the supported components such as buttons. It is disabled by default.",
|
|
43786
|
+
"examples": {
|
|
43787
|
+
"typescript": "provideExhaustive({\n ripple: true\n})"
|
|
43569
43788
|
}
|
|
43570
43789
|
},
|
|
43571
43790
|
{
|
|
43572
43791
|
"id": "inputvariant",
|
|
43573
|
-
"label": "
|
|
43574
|
-
"description": "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
|
|
43792
|
+
"label": "InputVariant",
|
|
43793
|
+
"description": "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\nvariant.",
|
|
43575
43794
|
"examples": null
|
|
43576
43795
|
},
|
|
43577
43796
|
{
|
|
43578
|
-
"id": "
|
|
43579
|
-
"label": "
|
|
43580
|
-
"description": "
|
|
43797
|
+
"id": "overlayappendto",
|
|
43798
|
+
"label": "OverlayAppendTo",
|
|
43799
|
+
"description": "Defines the default location of the overlays; `self` refers to the host element and `body` targets the document body. Defaults to `self`.",
|
|
43581
43800
|
"examples": null
|
|
43582
43801
|
},
|
|
43583
43802
|
{
|
|
43584
|
-
"id": "
|
|
43585
|
-
"label": "
|
|
43586
|
-
"description": "
|
|
43803
|
+
"id": "zIndex",
|
|
43804
|
+
"label": "ZIndex",
|
|
43805
|
+
"description": "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\nlayout 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\ncustomize the default values for components categories. Default values are described below and can be customized when setting up ExhaustiveUI.",
|
|
43587
43806
|
"examples": {
|
|
43588
|
-
"typescript": "import {
|
|
43807
|
+
"typescript": "import { ExhaustiveConfig } from '@exhaustive-ui/core/api';\n\n@Component({\n selector: 'app-root',\n templateUrl: './app.component.html'\n})\nexport class AppComponent implements OnInit {\n\n constructor(private exhaustiveConfig: ExhaustiveConfig) {}\n\n ngOnInit() {\n this.exhaustiveConfig.zIndex = {\n modal: 1100, // dialog, sidebar\n overlay: 1000, // dropdown, overlaypanel\n menu: 1000, // overlay menus\n tooltip: 1100 // tooltip\n };\n }\n}"
|
|
43589
43808
|
}
|
|
43590
43809
|
},
|
|
43591
43810
|
{
|
|
43592
|
-
"id": "
|
|
43593
|
-
"label": "
|
|
43594
|
-
"description": "The
|
|
43811
|
+
"id": "csp-nonce",
|
|
43812
|
+
"label": "Nonce",
|
|
43813
|
+
"description": "The `nonce` value to use on dynamically generated style elements in core.",
|
|
43595
43814
|
"examples": {
|
|
43596
|
-
"typescript": "
|
|
43815
|
+
"typescript": "provideExhaustive({\n csp: {\n nonce: '...'\n }\n})"
|
|
43597
43816
|
}
|
|
43598
43817
|
},
|
|
43599
43818
|
{
|
|
43600
|
-
"id": "
|
|
43601
|
-
"label": "
|
|
43602
|
-
"description": "
|
|
43819
|
+
"id": "filter-mode",
|
|
43820
|
+
"label": "Filter Mode",
|
|
43821
|
+
"description": "Default filter modes to display on DataTable filter menus.",
|
|
43603
43822
|
"examples": {
|
|
43604
|
-
"typescript": "
|
|
43823
|
+
"typescript": "import { ExhaustiveConfig } from '@exhaustive-ui/core/api';\n\n@Component({\n selector: 'app-root',\n templateUrl: './app.component.html'\n})\nexport class AppComponent implements OnInit {\n\n constructor(private exhaustiveConfig: ExhaustiveConfig) {}\n\n ngOnInit() {\n exhaustiveConfig.filterMatchModeOptions = {\n text: [FilterMatchMode.STARTS_WITH, FilterMatchMode.CONTAINS, FilterMatchMode.NOT_CONTAINS, FilterMatchMode.ENDS_WITH, FilterMatchMode.EQUALS, FilterMatchMode.NOT_EQUALS],\n numeric: [FilterMatchMode.EQUALS, FilterMatchMode.NOT_EQUALS, FilterMatchMode.LESS_THAN, FilterMatchMode.LESS_THAN_OR_EQUAL_TO, FilterMatchMode.GREATER_THAN, FilterMatchMode.GREATER_THAN_OR_EQUAL_TO],\n date: [FilterMatchMode.DATE_IS, FilterMatchMode.DATE_IS_NOT, FilterMatchMode.DATE_BEFORE, FilterMatchMode.DATE_AFTER]\n };\n }\n}"
|
|
43605
43824
|
}
|
|
43606
43825
|
},
|
|
43607
43826
|
{
|
|
43608
|
-
"id": "
|
|
43609
|
-
"label": "
|
|
43610
|
-
"description": "
|
|
43827
|
+
"id": "translation",
|
|
43828
|
+
"label": "Translation",
|
|
43829
|
+
"description": "A translation is specified using the translation property during initialization.\n\n```typescript\nprovideExhaustive({\n translation: {\n accept: 'Aceptar',\n reject: 'Rechazar',\n //translations\n }\n})\n```",
|
|
43611
43830
|
"examples": null
|
|
43612
43831
|
},
|
|
43613
43832
|
{
|
|
43614
|
-
"id": "
|
|
43615
|
-
"label": "
|
|
43616
|
-
"description": "The
|
|
43617
|
-
"examples": {
|
|
43618
|
-
"typescript": "import { ApplicationConfig } from '@angular/core';\nimport { provideExhaustive } from '@exhaustive-ui/core/config';\n\nexport const appConfig: ApplicationConfig = {\n providers: [\n provideExhaustive({ /* options */ })\n ]\n};"
|
|
43619
|
-
}
|
|
43620
|
-
},
|
|
43621
|
-
{
|
|
43622
|
-
"id": "ripple",
|
|
43623
|
-
"label": "Ripple",
|
|
43624
|
-
"description": "Ripple is an optional animation for the supported components such as buttons. It is disabled by default.",
|
|
43833
|
+
"id": "Runtime",
|
|
43834
|
+
"label": "Runtime",
|
|
43835
|
+
"description": "The translations can be changed dynamically at runtime, here is an example with ngx-translate.",
|
|
43625
43836
|
"examples": {
|
|
43626
|
-
"typescript": "
|
|
43837
|
+
"typescript": "import { Component, OnInit } from '@angular/core';\nimport { Exhaustive } from '@exhaustive-ui/core/config';\nimport { TranslateService } from '@ngx-translate/core';\n\n@Component({\n selector: 'app-root',\n templateUrl: './app.component.html'\n})\nexport class AppComponent implements OnInit {\n\n constructor(private config: Exhaustive, private translateService: TranslateService) {}\n\n ngOnInit() {\n this.translateService.setDefaultLang('en');\n }\n\n translate(lang: string) {\n this.translateService.use(lang);\n this.translateService.get('exhaustive').subscribe(res => this.config.setTranslation(res));\n }\n}"
|
|
43627
43838
|
}
|
|
43628
43839
|
},
|
|
43629
43840
|
{
|
|
43630
|
-
"id": "
|
|
43631
|
-
"label": "
|
|
43632
|
-
"description": "
|
|
43633
|
-
"examples":
|
|
43634
|
-
"typescript": "import { ApplicationConfig } from '@angular/core';\nimport { provideExhaustive } from '@exhaustive-ui/core/config';\n\nimport Aura from '@exhaustive-ui/themes/aura';\n\nexport const appConfig: ApplicationConfig = {\n providers: [\n provideExhaustive({\n theme: {\n preset: Aura,\n options: {\n prefix: 'p',\n darkModeSelector: 'system',\n cssLayer: false\n }\n }\n })\n ]\n};"
|
|
43635
|
-
}
|
|
43841
|
+
"id": "repository",
|
|
43842
|
+
"label": "Repository",
|
|
43843
|
+
"description": "Ready to use settings for locales are available as the `@exhaustive-ui/locale` package, maintained in the\n[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\nwith the rest of the community.\n\n```typescript\nimport { de } from '@exhaustive-ui/locale/js/de.js';\n\nprovideExhaustive({\n translation: de\n})\n```",
|
|
43844
|
+
"examples": null
|
|
43636
43845
|
},
|
|
43637
43846
|
{
|
|
43638
|
-
"id": "
|
|
43639
|
-
"label": "
|
|
43640
|
-
"description": "
|
|
43641
|
-
"examples":
|
|
43642
|
-
"typescript": "import { ExhaustiveConfig } from '@exhaustive-ui/core/api';\n\n@Component({\n selector: 'app-root',\n templateUrl: './app.component.html'\n})\nexport class AppComponent implements OnInit {\n\n constructor(private exhaustiveConfig: ExhaustiveConfig) {}\n\n ngOnInit() {\n this.exhaustiveConfig.zIndex = {\n modal: 1100, // dialog, sidebar\n overlay: 1000, // dropdown, overlaypanel\n menu: 1000, // overlay menus\n tooltip: 1100 // tooltip\n };\n }\n}"
|
|
43643
|
-
}
|
|
43847
|
+
"id": "api",
|
|
43848
|
+
"label": "API",
|
|
43849
|
+
"description": "### Locale Options",
|
|
43850
|
+
"examples": null
|
|
43644
43851
|
}
|
|
43645
43852
|
]
|
|
43646
43853
|
},
|
|
@@ -43653,61 +43860,69 @@
|
|
|
43653
43860
|
{
|
|
43654
43861
|
"id": "architecture",
|
|
43655
43862
|
"label": "Architecture",
|
|
43656
|
-
"description": "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
|
|
43863
|
+
"description": "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\nparts;\n`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\npresets, currently Aura, Material, Lara and Nora are the available built-in options.\n\nThe 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`.\n\n### Primitive Tokens\n\nPrimitive 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\non its own, the name of the token does not indicate context. Usually they are utilized by the semantic tokens.\n\n### Semantic Tokens\n\nSemantic 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\n`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.\n\n### Component Tokens\n\nComponent 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\n`primary.color` semantic token which maps to the `green.500` primitive token.\n\n### Best Practices\n\nUse 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\ncomponent. 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\nresort, design tokens are the suggested approach.",
|
|
43657
43864
|
"examples": null
|
|
43658
43865
|
},
|
|
43659
43866
|
{
|
|
43660
|
-
"id": "
|
|
43661
|
-
"label": "
|
|
43662
|
-
"description": "
|
|
43663
|
-
"examples":
|
|
43867
|
+
"id": "theme",
|
|
43868
|
+
"label": "Theme",
|
|
43869
|
+
"description": "The `theme` property is used to customize the initial theme.",
|
|
43870
|
+
"examples": {
|
|
43871
|
+
"typescript": "import { ApplicationConfig } from '@angular/core';\nimport { provideExhaustive } from '@exhaustive-ui/core/config';\nimport Aura from '@exhaustive-ui/themes/aura';\n\nexport const appConfig: ApplicationConfig = {\n providers: [\n provideExhaustive({\n theme: {\n preset: Aura\n }\n })\n ]\n};"
|
|
43872
|
+
}
|
|
43664
43873
|
},
|
|
43665
43874
|
{
|
|
43666
|
-
"id": "
|
|
43667
|
-
"label": "
|
|
43668
|
-
"description": "
|
|
43875
|
+
"id": "options",
|
|
43876
|
+
"label": "Options",
|
|
43877
|
+
"description": "The `options` property defines the how the CSS would be generated from the design tokens of the preset.\n\nprefix\n\nThe prefix of the CSS variables, defaults to `p`. For instance, the `primary.color` design token would be `var(--p-primary-color)`.\n\ndarkModeSelector\n\nThe 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\ndefine a class selector such as `.app-dark` and toggle this class at the document root. See the dark mode toggle section for an example.\n\ncssLayer\n\nDefines whether the styles should be defined inside a\n[CSS layer](https://developer.mozilla.org/en-US/docs/Web/CSS/@layer)\nby default or not. A CSS layer would be handy to declare a custom cascade layer for easier customization if necessary. The default is `false`.",
|
|
43669
43878
|
"examples": null
|
|
43670
43879
|
},
|
|
43671
43880
|
{
|
|
43672
|
-
"id": "
|
|
43673
|
-
"label": "
|
|
43674
|
-
"description": "
|
|
43881
|
+
"id": "presets",
|
|
43882
|
+
"label": "Presets",
|
|
43883
|
+
"description": "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\nand Nora is inspired by enterprise applications. Visit the [source code](https://github.com/e-xiste/exhaustive-ui/tree/main/packages/themes/src/presets) to learn more about the\nstructure 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.",
|
|
43675
43884
|
"examples": null
|
|
43676
43885
|
},
|
|
43677
43886
|
{
|
|
43678
|
-
"id": "
|
|
43679
|
-
"label": "
|
|
43680
|
-
"description": "
|
|
43887
|
+
"id": "colors",
|
|
43888
|
+
"label": "Colors",
|
|
43889
|
+
"description": "Color palette of a preset is defined by the `primitive` design token group. You can access colors using CSS variables or the `$dt` utility.\n\n@for (color of colors; track color) {\n- {{ color }} @for (shade of shades; track shade) { {{ shade }} }\n}",
|
|
43681
43890
|
"examples": null
|
|
43682
43891
|
},
|
|
43683
43892
|
{
|
|
43684
43893
|
"id": "darkmode",
|
|
43685
|
-
"label": "
|
|
43686
|
-
"description": "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
|
|
43894
|
+
"label": "Dark Mode",
|
|
43895
|
+
"description": "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\n`.my-app-dark` so that ExhaustiveUI can fit in seamlessly with your color scheme.\n\n```typescript\nprovideExhaustive({\n theme: {\n preset: Aura,\n options: {\n darkModeSelector: '.my-app-dark'\n }\n }\n})\n```\n\nFollowing is a very basic example implementation of a dark mode switch, you may extend it further by involving\n`prefers-color-scheme` to retrieve it from the system initially and use `localStorage` to make it stateful. See this\n[article](https://dev.to/abbeyperini/dark-mode-toggle-and-prefers-color-scheme-4f3m)\nfor more information.\n\nIn case you prefer to use dark mode all the time, apply the `darkModeSelector` initially and never change it.\n\nIt is also possible to disable dark mode completely using `false` or `none` as the value of the selector.\n\n```typescript\nprovideExhaustive({\n theme: {\n preset: Aura,\n options: {\n darkModeSelector: false || 'none'\n }\n }\n})\n```",
|
|
43687
43896
|
"examples": null
|
|
43688
43897
|
},
|
|
43689
43898
|
{
|
|
43690
43899
|
"id": "definepreset",
|
|
43691
|
-
"label": "
|
|
43692
|
-
"description": "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.",
|
|
43900
|
+
"label": "definePreset",
|
|
43901
|
+
"description": "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.",
|
|
43693
43902
|
"examples": null
|
|
43694
43903
|
},
|
|
43695
43904
|
{
|
|
43696
|
-
"id": "
|
|
43697
|
-
"label": "
|
|
43698
|
-
"description": "
|
|
43905
|
+
"id": "colorscheme",
|
|
43906
|
+
"label": "Color Scheme",
|
|
43907
|
+
"description": "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.\n\nCommon Pitfall\n\nWhen 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\nonly 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\nthat 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.\n\nBest Practices\n\n- Check how tokens are defined in the preset before customizing from the [source](https://github.com/e-xiste/exhaustive-ui/blob/main/packages/themes/src/presets).\n- Always maintain the same structure (direct value or colorScheme) as the original preset.\n- Consider both light and dark mode values when overriding scheme-dependent tokens.\n\nThis approach ensures your customizations will be applied correctly regardless of the user's selected color scheme.",
|
|
43699
43908
|
"examples": null
|
|
43700
43909
|
},
|
|
43701
43910
|
{
|
|
43702
|
-
"id": "
|
|
43703
|
-
"label": "
|
|
43704
|
-
"description": "The
|
|
43911
|
+
"id": "primary",
|
|
43912
|
+
"label": "Primary",
|
|
43913
|
+
"description": "The `primary` defines the main color palette, default value maps to the `emerald` primitive token. Let's setup to use `indigo` instead.",
|
|
43705
43914
|
"examples": null
|
|
43706
43915
|
},
|
|
43707
43916
|
{
|
|
43708
|
-
"id": "
|
|
43709
|
-
"label": "
|
|
43710
|
-
"description": "
|
|
43917
|
+
"id": "surface",
|
|
43918
|
+
"label": "Surface",
|
|
43919
|
+
"description": "The color scheme palette that varies between light and dark modes is specified with the surface tokens. Example below uses\n`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.",
|
|
43920
|
+
"examples": null
|
|
43921
|
+
},
|
|
43922
|
+
{
|
|
43923
|
+
"id": "noir",
|
|
43924
|
+
"label": "Noir",
|
|
43925
|
+
"description": "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\nprimary color;",
|
|
43711
43926
|
"examples": null
|
|
43712
43927
|
},
|
|
43713
43928
|
{
|
|
@@ -43719,105 +43934,97 @@
|
|
|
43719
43934
|
{
|
|
43720
43935
|
"id": "forms",
|
|
43721
43936
|
"label": "Forms",
|
|
43722
|
-
"description": "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
|
|
43937
|
+
"description": "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\n`dropdown.hover.border.color` and `textarea.hover.border.color` would receive the change.",
|
|
43723
43938
|
"examples": null
|
|
43724
43939
|
},
|
|
43725
43940
|
{
|
|
43726
|
-
"id": "
|
|
43727
|
-
"label": "
|
|
43728
|
-
"description": "
|
|
43941
|
+
"id": "focusring",
|
|
43942
|
+
"label": "Focus Ring",
|
|
43943
|
+
"description": "Focus ring defines the outline width, style, color and offset. Let's use a thicker ring with the primary color for the outline.",
|
|
43729
43944
|
"examples": null
|
|
43730
43945
|
},
|
|
43731
43946
|
{
|
|
43732
|
-
"id": "
|
|
43733
|
-
"label": "
|
|
43734
|
-
"description": "The
|
|
43947
|
+
"id": "component",
|
|
43948
|
+
"label": "Component",
|
|
43949
|
+
"description": "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.\nThis 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.",
|
|
43735
43950
|
"examples": null
|
|
43736
43951
|
},
|
|
43737
43952
|
{
|
|
43738
|
-
"id": "
|
|
43739
|
-
"label": "
|
|
43740
|
-
"description": "The
|
|
43953
|
+
"id": "extend",
|
|
43954
|
+
"label": "Extend",
|
|
43955
|
+
"description": "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\ndefault tokens.\n\nThe 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.",
|
|
43741
43956
|
"examples": null
|
|
43742
43957
|
},
|
|
43743
43958
|
{
|
|
43744
|
-
"id": "
|
|
43745
|
-
"label": "
|
|
43746
|
-
"description": "
|
|
43959
|
+
"id": "scopedtokens",
|
|
43960
|
+
"label": "Scoped Tokens",
|
|
43961
|
+
"description": "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.\n\nThis approach is recommended over the `::ng-deep` as it offers a cleaner API while avoiding the hassle of CSS rule overrides.",
|
|
43747
43962
|
"examples": null
|
|
43748
43963
|
},
|
|
43749
43964
|
{
|
|
43750
|
-
"id": "
|
|
43751
|
-
"label": "
|
|
43752
|
-
"description": "
|
|
43965
|
+
"id": "usepreset",
|
|
43966
|
+
"label": "usePreset",
|
|
43967
|
+
"description": "Replaces the current presets entirely, common use case is changing the preset dynamically at runtime.",
|
|
43753
43968
|
"examples": null
|
|
43754
43969
|
},
|
|
43755
43970
|
{
|
|
43756
|
-
"id": "
|
|
43757
|
-
"label": "
|
|
43758
|
-
"description": "
|
|
43971
|
+
"id": "updatepreset",
|
|
43972
|
+
"label": "updatePreset",
|
|
43973
|
+
"description": "Merges the provided tokens to the current preset, an example would be changing the primary color palette dynamically.",
|
|
43759
43974
|
"examples": null
|
|
43760
43975
|
},
|
|
43761
43976
|
{
|
|
43762
|
-
"id": "
|
|
43763
|
-
"label": "
|
|
43764
|
-
"description": "
|
|
43977
|
+
"id": "updateprimarypalette",
|
|
43978
|
+
"label": "updatePrimaryPalette",
|
|
43979
|
+
"description": "Updates the primary colors, this is a shorthand to do the same update using `updatePreset`.",
|
|
43765
43980
|
"examples": null
|
|
43766
43981
|
},
|
|
43767
43982
|
{
|
|
43768
|
-
"id": "
|
|
43769
|
-
"label": "
|
|
43770
|
-
"description": "
|
|
43983
|
+
"id": "updatesurfacepalette",
|
|
43984
|
+
"label": "updateSurfacePalette",
|
|
43985
|
+
"description": "Updates the surface colors, this is a shorthand to do the same update using `updatePreset`.",
|
|
43771
43986
|
"examples": null
|
|
43772
43987
|
},
|
|
43773
43988
|
{
|
|
43774
|
-
"id": "
|
|
43775
|
-
"label": "
|
|
43776
|
-
"description": "
|
|
43989
|
+
"id": "dt",
|
|
43990
|
+
"label": "$dt",
|
|
43991
|
+
"description": "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.",
|
|
43777
43992
|
"examples": null
|
|
43778
43993
|
},
|
|
43779
43994
|
{
|
|
43780
|
-
"id": "
|
|
43781
|
-
"label": "
|
|
43782
|
-
"description": "
|
|
43995
|
+
"id": "Palette",
|
|
43996
|
+
"label": "palette",
|
|
43997
|
+
"description": "Returns shades and tints of a given color from 50 to 950 as an array.",
|
|
43783
43998
|
"examples": null
|
|
43784
43999
|
},
|
|
43785
44000
|
{
|
|
43786
|
-
"id": "
|
|
43787
|
-
"label": "
|
|
43788
|
-
"description": "The
|
|
44001
|
+
"id": "specificity",
|
|
44002
|
+
"label": "Specificity",
|
|
44003
|
+
"description": "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\n[MDN](https://developer.mozilla.org/en-US/docs/Web/CSS/@layer) to begin with.\n\nThe `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\napp 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.",
|
|
43789
44004
|
"examples": null
|
|
43790
44005
|
},
|
|
43791
44006
|
{
|
|
43792
|
-
"id": "
|
|
43793
|
-
"label": "
|
|
43794
|
-
"description": "
|
|
43795
|
-
"examples": {
|
|
43796
|
-
"typescript": "import { ApplicationConfig } from '@angular/core';\nimport { provideExhaustive } from '@exhaustive-ui/core/config';\nimport Aura from '@exhaustive-ui/themes/aura';\n\nexport const appConfig: ApplicationConfig = {\n providers: [\n provideExhaustive({\n theme: {\n preset: Aura\n }\n })\n ]\n};"
|
|
43797
|
-
}
|
|
43798
|
-
},
|
|
43799
|
-
{
|
|
43800
|
-
"id": "updatepreset",
|
|
43801
|
-
"label": "Updatepreset",
|
|
43802
|
-
"description": "Merges the provided tokens to the current preset, an example would be changing the primary color palette dynamically.",
|
|
44007
|
+
"id": "reset",
|
|
44008
|
+
"label": "Reset",
|
|
44009
|
+
"description": "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\nand defining the layer order. This way, your Reset CSS does not get in the way of ExhaustiveUI components.",
|
|
43803
44010
|
"examples": null
|
|
43804
44011
|
},
|
|
43805
44012
|
{
|
|
43806
|
-
"id": "
|
|
43807
|
-
"label": "
|
|
43808
|
-
"description": "
|
|
44013
|
+
"id": "scale",
|
|
44014
|
+
"label": "Scale",
|
|
44015
|
+
"description": "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\n`14px` as the base so it may differ from your application if your base font size is different.",
|
|
43809
44016
|
"examples": null
|
|
43810
44017
|
},
|
|
43811
44018
|
{
|
|
43812
|
-
"id": "
|
|
43813
|
-
"label": "
|
|
43814
|
-
"description": "
|
|
44019
|
+
"id": "bootstrap",
|
|
44020
|
+
"label": "Bootstrap",
|
|
44021
|
+
"description": "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.",
|
|
43815
44022
|
"examples": null
|
|
43816
44023
|
},
|
|
43817
44024
|
{
|
|
43818
|
-
"id": "
|
|
43819
|
-
"label": "
|
|
43820
|
-
"description": "
|
|
44025
|
+
"id": "libraries",
|
|
44026
|
+
"label": "Libraries",
|
|
44027
|
+
"description": "Example layer configuration for the popular CSS libraries.",
|
|
43821
44028
|
"examples": null
|
|
43822
44029
|
}
|
|
43823
44030
|
]
|
|
@@ -43831,27 +44038,25 @@
|
|
|
43831
44038
|
{
|
|
43832
44039
|
"id": "architecture",
|
|
43833
44040
|
"label": "Architecture",
|
|
43834
|
-
"description": "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
|
|
44041
|
+
"description": "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\nincluded. Here is an example of an Unstyled Select, the core functionality and accessibility is provided whereas styling is not included.",
|
|
44042
|
+
"examples": null
|
|
44043
|
+
},
|
|
44044
|
+
{
|
|
44045
|
+
"id": "setup",
|
|
44046
|
+
"label": "Setup",
|
|
44047
|
+
"description": "Unstyled mode is enabled for the whole suite by enabling `unstyled` option during ExhaustiveUI installation.\n\n```typescript\nimport { ApplicationConfig } from '@angular/core';\n\nexport const appConfig: ApplicationConfig = {\n providers: [\n provideExhaustive({\n unstyled: true\n })\n ]\n};\n```\n\nAlternatively even in the default styled mode, a particular component can still be used as unstyled by adding the `unstyled` prop of the component.\n\n```html\n<div class=\"card flex justify-center items-center gap-2\">\n <p-button label=\"Styled\" icon=\"pi pi-check\" />\n <p-button label=\"Unstyled\" icon=\"pi pi-check\" [unstyled]=\"true\" />\n</div>\n```",
|
|
43835
44048
|
"examples": null
|
|
43836
44049
|
},
|
|
43837
44050
|
{
|
|
43838
44051
|
"id": "example",
|
|
43839
44052
|
"label": "Example",
|
|
43840
|
-
"description": "Unstyled components require styling using your preferred approach. We recommend using Tailwind CSS with PassThrough attributes, a combination that works seamlessly together. The
|
|
44053
|
+
"description": "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\nvariants such as `p-outlined:`, `p-vertical` for the ExhaustiveUI components.\n\nThe example below demonstrates how to style a button component with Tailwind CSS using PassThrough attributes. Before you begin, refer to the\npass through section in the button documentation to familiarize yourself with the component's internal structure and PassThrough attributes. In this\nexample, we'll target the `root`, `label` and `icon` elements to apply custom styles.\n\n```html\n<p-button\n label=\"Search\"\n icon=\"pi pi-search\"\n [unstyled]=\"true\"\n [pt]=\"{\n root: 'bg-teal-500 hover:bg-teal-700 active:bg-teal-900 cursor-pointer py-2 px-4 rounded-full border-0 flex gap-2',\n label: 'text-white font-bold text-lg',\n icon: 'text-white text-xl!'\n }\"\n/>\n```",
|
|
43841
44054
|
"examples": null
|
|
43842
44055
|
},
|
|
43843
44056
|
{
|
|
43844
44057
|
"id": "global",
|
|
43845
44058
|
"label": "Global",
|
|
43846
|
-
"description": "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
|
|
43847
|
-
"examples": {
|
|
43848
|
-
"typescript": "import { ApplicationConfig } from '@angular/core';\n\nexport const appConfig: ApplicationConfig = {\n providers: [\n provideExhaustive({\n unstyled: true,\n pt: {\n button: {\n root: 'bg-teal-500 hover:bg-teal-700 active:bg-teal-900 cursor-pointer py-2 px-4 rounded-full border-0 flex gap-2',\n label: 'text-white font-bold text-lg',\n icon: 'text-white text-xl!'\n }\n }\n })\n ]\n};"
|
|
43849
|
-
}
|
|
43850
|
-
},
|
|
43851
|
-
{
|
|
43852
|
-
"id": "setup",
|
|
43853
|
-
"label": "Setup",
|
|
43854
|
-
"description": "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.",
|
|
44059
|
+
"description": "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\nwith its own `pt` property.\n\n```typescript\nimport { ApplicationConfig } from '@angular/core';\n\nexport const appConfig: ApplicationConfig = {\n providers: [\n provideExhaustive({\n unstyled: true,\n pt: {\n button: {\n root: 'bg-teal-500 hover:bg-teal-700 active:bg-teal-900 cursor-pointer py-2 px-4 rounded-full border-0 flex gap-2',\n label: 'text-white font-bold text-lg',\n icon: 'text-white text-xl!'\n }\n }\n })\n ]\n};\n```",
|
|
43855
44060
|
"examples": null
|
|
43856
44061
|
}
|
|
43857
44062
|
]
|
|
@@ -43862,26 +44067,6 @@
|
|
|
43862
44067
|
"title": "Icons",
|
|
43863
44068
|
"description": "OpenNG Icons is the default icon library of ExhaustiveUI with over 250 open source icons.",
|
|
43864
44069
|
"sections": [
|
|
43865
|
-
{
|
|
43866
|
-
"id": "basic",
|
|
43867
|
-
"label": "Basic",
|
|
43868
|
-
"description": "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",
|
|
43869
|
-
"examples": null
|
|
43870
|
-
},
|
|
43871
|
-
{
|
|
43872
|
-
"id": "color",
|
|
43873
|
-
"label": "Color",
|
|
43874
|
-
"description": "Icon color is defined with the color property which is inherited from parent by default.",
|
|
43875
|
-
"examples": null
|
|
43876
|
-
},
|
|
43877
|
-
{
|
|
43878
|
-
"id": "constants",
|
|
43879
|
-
"label": "Constants",
|
|
43880
|
-
"description": "Constants API is available to reference icons easily when used programmatically.",
|
|
43881
|
-
"examples": {
|
|
43882
|
-
"typescript": "import { Component } from '@angular/core';\nimport { OpenngIcons, MenuItem } from '@exhaustive-ui/core/api';\n\n@Component({\n selector: 'openng-icons-constants-demo',\n templateUrl: './openng-icons-constants-demo.html'\n})\nexport class OpenngIconsConstantsDemo {\n items: MenuItem[];\n\n ngOnInit() {\n this.items = [\n {\n label: 'New',\n icon: OpenngIcons.PLUS,\n },\n {\n label: 'Delete',\n icon: OpenngIcons.TRASH\n }\n ];\n }\n}"
|
|
43883
|
-
}
|
|
43884
|
-
},
|
|
43885
44070
|
{
|
|
43886
44071
|
"id": "download",
|
|
43887
44072
|
"label": "Download",
|
|
@@ -43893,15 +44078,15 @@
|
|
|
43893
44078
|
{
|
|
43894
44079
|
"id": "import",
|
|
43895
44080
|
"label": "Import",
|
|
43896
|
-
"description": "CSS file of the icon library needs to be imported in styles.scss of your application.",
|
|
44081
|
+
"description": "CSS file of the icon library needs to be imported in `styles.scss` of your application.",
|
|
43897
44082
|
"examples": {
|
|
43898
44083
|
"scss": "@import \"@openng/icons/openng-icons.css\";"
|
|
43899
44084
|
}
|
|
43900
44085
|
},
|
|
43901
44086
|
{
|
|
43902
|
-
"id": "
|
|
43903
|
-
"label": "
|
|
43904
|
-
"description": "
|
|
44087
|
+
"id": "basic",
|
|
44088
|
+
"label": "Basic",
|
|
44089
|
+
"description": "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`",
|
|
43905
44090
|
"examples": null
|
|
43906
44091
|
},
|
|
43907
44092
|
{
|
|
@@ -43910,10 +44095,30 @@
|
|
|
43910
44095
|
"description": "Size of an icon is controlled with the font-size property of the element.",
|
|
43911
44096
|
"examples": null
|
|
43912
44097
|
},
|
|
44098
|
+
{
|
|
44099
|
+
"id": "color",
|
|
44100
|
+
"label": "Color",
|
|
44101
|
+
"description": "Icon color is defined with the `color` property which is inherited from parent by default.",
|
|
44102
|
+
"examples": null
|
|
44103
|
+
},
|
|
43913
44104
|
{
|
|
43914
44105
|
"id": "spin",
|
|
43915
44106
|
"label": "Spin",
|
|
43916
|
-
"description": "Special pi-spin class applies infinite rotation to an icon.",
|
|
44107
|
+
"description": "Special `pi-spin` class applies infinite rotation to an icon.",
|
|
44108
|
+
"examples": null
|
|
44109
|
+
},
|
|
44110
|
+
{
|
|
44111
|
+
"id": "constants",
|
|
44112
|
+
"label": "Constants",
|
|
44113
|
+
"description": "Constants API is available to reference icons easily when used programmatically.",
|
|
44114
|
+
"examples": {
|
|
44115
|
+
"typescript": "import { Component } from '@angular/core';\nimport { OpenngIcons, MenuItem } from '@exhaustive-ui/core/api';\n\n@Component({\n selector: 'openng-icons-constants-demo',\n templateUrl: './openng-icons-constants-demo.html'\n})\nexport class OpenngIconsConstantsDemo {\n items: MenuItem[];\n\n ngOnInit() {\n this.items = [\n {\n label: 'New',\n icon: OpenngIcons.PLUS,\n },\n {\n label: 'Delete',\n icon: OpenngIcons.TRASH\n }\n ];\n }\n}"
|
|
44116
|
+
}
|
|
44117
|
+
},
|
|
44118
|
+
{
|
|
44119
|
+
"id": "list",
|
|
44120
|
+
"label": "List",
|
|
44121
|
+
"description": "Here is the full list of icons. More icons will be added periodically and you may also\n[request new icons](https://github.com/openng-org/icons/issues) at the issue tracker.",
|
|
43917
44122
|
"examples": null
|
|
43918
44123
|
}
|
|
43919
44124
|
]
|
|
@@ -43925,27 +44130,27 @@
|
|
|
43925
44130
|
"description": "Use custom icons with ExhaustiveUI components.",
|
|
43926
44131
|
"sections": [
|
|
43927
44132
|
{
|
|
43928
|
-
"id": "
|
|
43929
|
-
"label": "
|
|
43930
|
-
"description": "
|
|
44133
|
+
"id": "material",
|
|
44134
|
+
"label": "Material",
|
|
44135
|
+
"description": "[Material icons](https://fonts.google.com/icons) is the official icon library based on Google Material Design.",
|
|
43931
44136
|
"examples": null
|
|
43932
44137
|
},
|
|
43933
44138
|
{
|
|
43934
|
-
"id": "
|
|
43935
|
-
"label": "
|
|
43936
|
-
"description": "
|
|
44139
|
+
"id": "fontawesome",
|
|
44140
|
+
"label": "Font Awesome",
|
|
44141
|
+
"description": "[Font Awesome](https://fontawesome.com/) is a popular icon library with a wide range of icons.",
|
|
43937
44142
|
"examples": null
|
|
43938
44143
|
},
|
|
43939
44144
|
{
|
|
43940
|
-
"id": "
|
|
43941
|
-
"label": "
|
|
43942
|
-
"description": "
|
|
44145
|
+
"id": "svg",
|
|
44146
|
+
"label": "SVG",
|
|
44147
|
+
"description": "Inline SVGs are embedded inside the dom.",
|
|
43943
44148
|
"examples": null
|
|
43944
44149
|
},
|
|
43945
44150
|
{
|
|
43946
|
-
"id": "
|
|
43947
|
-
"label": "
|
|
43948
|
-
"description": "
|
|
44151
|
+
"id": "image",
|
|
44152
|
+
"label": "Image",
|
|
44153
|
+
"description": "Any type of image can be used as an icon.",
|
|
43949
44154
|
"examples": null
|
|
43950
44155
|
}
|
|
43951
44156
|
]
|
|
@@ -43959,43 +44164,43 @@
|
|
|
43959
44164
|
{
|
|
43960
44165
|
"id": "basic",
|
|
43961
44166
|
"label": "Basic",
|
|
43962
|
-
"description": "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
|
|
44167
|
+
"description": "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\narbitrary 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\nthe element. Every component documentation has a dedicated section to document the available section names exposed via PT.",
|
|
43963
44168
|
"examples": null
|
|
43964
44169
|
},
|
|
43965
44170
|
{
|
|
43966
44171
|
"id": "global",
|
|
43967
44172
|
"label": "Global",
|
|
43968
|
-
"description": "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
|
|
44173
|
+
"description": "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\n`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.",
|
|
43969
44174
|
"examples": null
|
|
43970
44175
|
},
|
|
43971
44176
|
{
|
|
43972
44177
|
"id": "instance",
|
|
43973
44178
|
"label": "Instance",
|
|
43974
|
-
"description": "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.",
|
|
44179
|
+
"description": "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.",
|
|
43975
44180
|
"examples": null
|
|
43976
44181
|
},
|
|
43977
44182
|
{
|
|
43978
44183
|
"id": "introduction",
|
|
43979
44184
|
"label": "Introduction",
|
|
43980
|
-
"description": "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
|
|
44185
|
+
"description": "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\nthe API, the component author needs to develop and publish it with a new release.\n\nThe 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\nyou 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.\n\nEach 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\nstyling, 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\ndocument the available section names in the interactive PT Viewer.\n\n### Panel Example\n\nIn 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\navailable 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\nwith ExhaustiveUI. Visit the [Override](https://exhaustive-ui.com/tailwind) section at Tailwind integration for examples.",
|
|
43981
44186
|
"examples": null
|
|
43982
44187
|
},
|
|
43983
44188
|
{
|
|
43984
44189
|
"id": "lifecycle",
|
|
43985
44190
|
"label": "Lifecycle",
|
|
43986
|
-
"description": "Lifecycle hooks of components are exposed as pass through using the hooks property so that callback functions can be registered. Available callbacks are onBeforeInit
|
|
44191
|
+
"description": "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`,\n`onAfterContentInit`, `onAfterContentChecked`, `onAfterViewInit`, `onAfterViewChecked` and `onDestroy`. Refer to the Angular documentation for detailed information about lifecycle hooks.",
|
|
43987
44192
|
"examples": null
|
|
43988
44193
|
},
|
|
43989
44194
|
{
|
|
43990
44195
|
"id": "pcprefix",
|
|
43991
44196
|
"label": "Pcprefix",
|
|
43992
|
-
"description": "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
|
|
44197
|
+
"description": "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\nindicating the necessity for a nested structure. For example, the `badge` section is identified as `pcBadge` because the button component incorporates the badge component internally.",
|
|
43993
44198
|
"examples": null
|
|
43994
44199
|
},
|
|
43995
44200
|
{
|
|
43996
44201
|
"id": "ptoptions",
|
|
43997
44202
|
"label": "Ptoptions",
|
|
43998
|
-
"description": "The
|
|
44203
|
+
"description": "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.\n\nThe `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\n`false` for `mergeProps`.\n\n### Global Configuration\n\n```typescript\nimport { ApplicationConfig } from '@angular/core';\nimport { provideExhaustive } from '@exhaustive-ui/core/config';\n\nexport const appConfig: ApplicationConfig = {\n providers: [\n provideExhaustive({\n pt: {\n panel: {\n header: {\n 'data-custom': 'acme-panel',\n class: 'bg-primary text-primary-contrast'\n },\n content: 'font-medium'\n }\n }\n })\n ]\n};\n```\n\n### mergeSections: true, mergeProps: false (default)\n\n```typescript\nimport { Component } from '@angular/core';\nimport { Panel, PanelModule, PanelPassThrough } from '@exhaustive-ui/core/panel';\n\n@Component({\n selector: 'ptoptions-doc',\n template: \\\n```\n\n### mergeSections: true, mergeProps: true\n\n```typescript\nimport { Component } from '@angular/core';\nimport { Panel, PanelModule, PanelPassThrough } from '@exhaustive-ui/core/panel';\n\n@Component({\n selector: 'ptoptions-doc',\n template: \\\n```\n\n### mergeSections: false, mergeProps: true\n\n```typescript\nimport { Component } from '@angular/core';\nimport { Panel, PanelModule, PanelPassThrough } from '@exhaustive-ui/core/panel';\n\n@Component({\n selector: 'ptoptions-doc',\n template: \\\n```\n\n### mergeSections: false, mergeProps: false\n\n```typescript\nimport { Component } from '@angular/core';\nimport { Panel, PanelModule, PanelPassThrough } from '@exhaustive-ui/core/panel';\n\n@Component({\n selector: 'ptoptions-doc',\n template: \\\n```",
|
|
43999
44204
|
"examples": null
|
|
44000
44205
|
}
|
|
44001
44206
|
]
|
|
@@ -44007,33 +44212,43 @@
|
|
|
44007
44212
|
"description": "Integration between ExhaustiveUI and Tailwind CSS.",
|
|
44008
44213
|
"sections": [
|
|
44009
44214
|
{
|
|
44010
|
-
"id": "
|
|
44011
|
-
"label": "
|
|
44012
|
-
"description": "The
|
|
44013
|
-
"examples":
|
|
44014
|
-
"typescript": "import { Component, OnInit } from '@angular/core';\nimport { FormsModule } from '@angular/forms';\nimport { SelectModule } from '@exhaustive-ui/core/select';\n\n@Component({\n template: `\n <div class=\"card\">\n <p-select [(ngModel)]=\"animation\" [options]=\"animations\" placeholder=\"Select One\" class=\"w-full sm:w-44\" />\n <div class=\"py-8 overflow-hidden\">\n <div [ngClass]=\"dynamicAnimationClasses\"></div>\n </div>\n </div>\n <h3>Animations</h3>\n <div class=\"doc-tablewrapper\">\n <table class=\"doc-table\">\n <thead>\n <tr>\n <th>Class</th>\n <th>Property</th>\n </tr>\n </thead>\n <tbody>\n <tr>\n <td>animate-fadein</td>\n <td>fadein 0.15s linear</td>\n </tr>\n <tr>\n <td>animate-fadeout</td>\n <td>fadeout 0.15s linear</td>\n </tr>\n <tr>\n <td>animate-slidedown</td>\n <td>slidedown 0.45s ease-in-out</td>\n </tr>\n <tr>\n <td>animate-slideup</td>\n <td>slideup 0.45s cubic-bezier(0, 1, 0, 1)</td>\n </tr>\n <tr>\n <td>animate-scalein</td>\n <td>scalein 0.15s linear</td>\n </tr>\n <tr>\n <td>animate-fadeinleft</td>\n <td>fadeinleft 0.15s linear</td>\n </tr>\n <tr>\n <td>animate-fadeoutleft</td>\n <td>fadeoutleft 0.15s linear</td>\n </tr>\n <tr>\n <td>animate-fadeinright</td>\n <td>fadeinright 0.15s linear</td>\n </tr>\n <tr>\n <td>animate-fadeoutright</td>\n <td>fadeoutright 0.15s linear</td>\n </tr>\n <tr>\n <td>animate-fadeinup</td>\n <td>fadeinup 0.15s linear</td>\n </tr>\n <tr>\n <td>animate-fadeoutup</td>\n <td>fadeoutup 0.15s linear</td>\n </tr>\n <tr>\n <td>animate-fadeindown</td>\n <td>fadeindown 0.15s linear</td>\n </tr>\n <tr>\n <td>animate-fadeoutup</td>\n <td>fadeoutup 0.15s linear</td>\n </tr>\n <tr>\n <td>animate-width</td>\n <td>width 0.15s linear</td>\n </tr>\n <tr>\n <td>animate-flip</td>\n <td>flip 0.15s linear</td>\n </tr>\n <tr>\n <td>animate-flipup</td>\n <td>flipup 0.15s linear</td>\n </tr>\n <tr>\n <td>animate-flipleft</td>\n <td>fadein 0.15s linear</td>\n </tr>\n <tr>\n <td>animate-flipright</td>\n <td>flipright 0.15s linear</td>\n </tr>\n <tr>\n <td>animate-zoomin</td>\n <td>zoomin 0.15s linear</td>\n </tr>\n <tr>\n <td>animate-zoomindown</td>\n <td>zoomindown 0.15s linear</td>\n </tr>\n <tr>\n <td>animate-zoominleft</td>\n <td>zoominleft 0.15s linear</td>\n </tr>\n <tr>\n <td>animate-zoominright</td>\n <td>zoominright 0.15s linear</td>\n </tr>\n <tr>\n <td>animate-zoominup</td>\n <td>zoominup 0.15s linear</td>\n </tr>\n </tbody>\n </table>\n </div>\n <h3>Animation Duration</h3>\n <div class=\"doc-tablewrapper\">\n <table class=\"doc-table\">\n <thead>\n <tr>\n <th>Class</th>\n <th>Property</th>\n </tr>\n </thead>\n <tbody>\n <tr>\n <td>animate-duration-0</td>\n <td>animation-duration: 0s</td>\n </tr>\n <tr>\n <td>animate-duration-75</td>\n <td>animation-duration: 75ms</td>\n </tr>\n <tr>\n <td>animate-duration-100</td>\n <td>animation-duration: 100ms</td>\n </tr>\n <tr>\n <td>animate-duration-200</td>\n <td>animation-duration: 200ms</td>\n </tr>\n <tr>\n <td>animate-duration-300</td>\n <td>animation-duration: 300ms</td>\n </tr>\n <tr>\n <td>animate-duration-400</td>\n <td>animation-duration: 400ms</td>\n </tr>\n <tr>\n <td>animate-duration-500</td>\n <td>animation-duration: 500ms</td>\n </tr>\n <tr>\n <td>animate-duration-700</td>\n <td>animation-duration: 700ms</td>\n </tr>\n <tr>\n <td>animate-duration-1000</td>\n <td>animation-duration: 1000ms</td>\n </tr>\n <tr>\n <td>animate-duration-2000</td>\n <td>animation-duration: 2000ms</td>\n </tr>\n <tr>\n <td>animate-duration-3000</td>\n <td>animation-duration: 300ms</td>\n </tr>\n </tbody>\n </table>\n </div>\n <h3>Animation Delay</h3>\n <div class=\"doc-tablewrapper\">\n <table class=\"doc-table\">\n <thead>\n <tr>\n <th>Class</th>\n <th>Property</th>\n </tr>\n </thead>\n <tbody>\n <tr>\n <td>animate-delay-none</td>\n <td>animation-duration: 0s</td>\n </tr>\n <tr>\n <td>animate-delay-75</td>\n <td>animation-delay: 75ms</td>\n </tr>\n <tr>\n <td>animate-delay-100</td>\n <td>animation-delay: 100ms</td>\n </tr>\n <tr>\n <td>animate-delay-150</td>\n <td>animation-delay: 150ms</td>\n </tr>\n <tr>\n <td>animate-delay-200</td>\n <td>animation-delay: 200ms</td>\n </tr>\n <tr>\n <td>animate-delay-300</td>\n <td>animation-delay: 300ms</td>\n </tr>\n <tr>\n <td>animate-delay-400</td>\n <td>animation-delay: 400ms</td>\n </tr>\n <tr>\n <td>animate-delay-500</td>\n <td>animation-delay: 500ms</td>\n </tr>\n <tr>\n <td>animate-delay-700</td>\n <td>animation-delay: 700ms</td>\n </tr>\n <tr>\n <td>animate-delay-1000</td>\n <td>animation-delay: 1000ms</td>\n </tr>\n </tbody>\n </table>\n </div>\n <h3>Iteration Count</h3>\n <div class=\"doc-tablewrapper\">\n <table class=\"doc-table\">\n <thead>\n <tr>\n <th>Class</th>\n <th>Property</th>\n </tr>\n </thead>\n <tbody>\n <tr>\n <td>animate-infinite</td>\n <td>animation-iteration-count: infinite</td>\n </tr>\n <tr>\n <td>animate-once</td>\n <td>animation-iteration-count: 1</td>\n </tr>\n <tr>\n <td>animate-twice</td>\n <td>animation-iteration-count: 2</td>\n </tr>\n </tbody>\n </table>\n </div>\n <h3>Direction</h3>\n <div class=\"doc-tablewrapper\">\n <table class=\"doc-table\">\n <thead>\n <tr>\n <th>Class</th>\n <th>Property</th>\n </tr>\n </thead>\n <tbody>\n <tr>\n <td>animate-normal</td>\n <td>animation-direction: normal</td>\n </tr>\n <tr>\n <td>animate-reverse</td>\n <td>animation-direction: reverse</td>\n </tr>\n <tr>\n <td>animate-alternate</td>\n <td>animation-direction: alternate</td>\n </tr>\n <tr>\n <td>animate-alternate-reverse</td>\n <td>animation-direction: alternate-reverse</td>\n </tr>\n </tbody>\n </table>\n </div>\n <h3>Timing Function</h3>\n <div class=\"doc-tablewrapper\">\n <table class=\"doc-table\">\n <thead>\n <tr>\n <th>Class</th>\n <th>Property</th>\n </tr>\n </thead>\n <tbody>\n <tr>\n <td>animate-ease-linear</td>\n <td>animation-timing-function: linear</td>\n </tr>\n <tr>\n <td>animate-ease-in</td>\n <td>animation-timing-function: cubic-bezier(0.4, 0, 1, 1)</td>\n </tr>\n <tr>\n <td>animate-ease-out</td>\n <td>animation-timing-function: cubic-bezier(0, 0, 0.2, 1)</td>\n </tr>\n <tr>\n <td>animate-ease-in-out</td>\n <td>animation-timing-function: cubic-bezier(0.4, 0, 0.2, 1)</td>\n </tr>\n </tbody>\n </table>\n </div>\n <h3>Fill Mode</h3>\n <div class=\"doc-tablewrapper\">\n <table class=\"doc-table\">\n <thead>\n <tr>\n <th>Class</th>\n <th>Property</th>\n </tr>\n </thead>\n <tbody>\n <tr>\n <td>animate-fill-none</td>\n <td>animation-fill-mode: normal</td>\n </tr>\n <tr>\n <td>animate-fill-forwards</td>\n <td>animation-fill-mode: forwards</td>\n </tr>\n <tr>\n <td>animate-fill-backwards</td>\n <td>animation-fill-mode: backwards</td>\n </tr>\n <tr>\n <td>animate-fill-both</td>\n <td>animation-fill-mode: both</td>\n </tr>\n </tbody>\n </table>\n </div>\n <h3>Play State</h3>\n <div class=\"doc-tablewrapper\">\n <table class=\"doc-table\">\n <thead>\n <tr>\n <th>Class</th>\n <th>Property</th>\n </tr>\n </thead>\n <tbody>\n <tr>\n <td>animate-running</td>\n <td>animation-play-state: running</td>\n </tr>\n <tr>\n <td>animate-paused</td>\n <td>animation-play-state: paused</td>\n </tr>\n </tbody>\n </table>\n </div>\n <h3>Backface Visibility State</h3>\n <div class=\"doc-tablewrapper\">\n <table class=\"doc-table\">\n <thead>\n <tr>\n <th>Class</th>\n <th>Property</th>\n </tr>\n </thead>\n <tbody>\n <tr>\n <td>backface-visible</td>\n <td>backface-visibility: visible</td>\n </tr>\n <tr>\n <td>backface-hidden</td>\n <td>backface-visibility: hidden</td>\n </tr>\n </tbody>\n </table>\n </div>\n `,\n standalone: true,\n imports: [SelectModule, FormsModule]\n})\nexport class TailwindAnimationsDemo implements OnInit {\n animation: any = null;\n\n ngOnInit() {\n this.animations = [\n 'fadein',\n 'fadeout',\n 'slideup',\n 'scalein',\n 'fadeinleft',\n 'fadeoutleft',\n 'fadeinright',\n 'fadeoutright',\n 'fadeinup',\n 'fadeoutup',\n 'width',\n 'flipup',\n 'flipleft',\n 'flipright',\n 'zoomin',\n 'zoomindown',\n 'zoominleft',\n 'zoominright',\n 'zoominup'\n ];\n }\n}"
|
|
44015
|
-
}
|
|
44215
|
+
"id": "overview",
|
|
44216
|
+
"label": "Overview",
|
|
44217
|
+
"description": "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\nBootstrap, 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\nthat take this approach to build components specifically for Tailwind.\n\nTailwind 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\nlibrary. The core of ExhaustiveUI does not depend on Tailwind CSS.",
|
|
44218
|
+
"examples": null
|
|
44016
44219
|
},
|
|
44017
44220
|
{
|
|
44018
|
-
"id": "
|
|
44019
|
-
"label": "
|
|
44020
|
-
"description": "ExhaustiveUI color
|
|
44021
|
-
"examples":
|
|
44022
|
-
|
|
44023
|
-
|
|
44221
|
+
"id": "plugin",
|
|
44222
|
+
"label": "Plugin",
|
|
44223
|
+
"description": "The [@exhaustive-ui/tailwindcss](https://www.npmjs.com/package/@exhaustive-ui/tailwindcss) is a plugin to provide first class integration between ExhaustiveUI and Tailwind CSS. It\nis 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`,\n`text-muted-color`.\n\nIf you haven't already done so, start by integrating Tailwind into your project. Detailed steps for this process can be found in the Tailwind\n[documentation](https://tailwindcss.com/). After successfully installing Tailwind, proceed with the installation of the ExhaustiveUiTailwind plugin. This single npm package comes\nwith two libraries: the CSS version is compatible with Tailwind v4, the recommended version, while the JS version is designed for Tailwind v3.\n\n### Tailwind v4\n\nIn the CSS file that contains the tailwindcss import, add the `@exhaustive-ui/tailwindcss` import as well.\n\nFor a comprehensive starter guide, review the [ExhaustiveUI](https://github.com/e-xiste/exhaustive-ui) repository which demonstrates the integration.\n\n### Tailwind v3\n\nUse the plugins option in your Tailwind config file to configure the plugin.",
|
|
44224
|
+
"examples": null
|
|
44225
|
+
},
|
|
44226
|
+
{
|
|
44227
|
+
"id": "extensions",
|
|
44228
|
+
"label": "Extensions",
|
|
44229
|
+
"description": "The plugin extends the default configuration with a new set of utilities. All variants and breakpoints are supported e.g.\n`dark:sm:hover:bg-primary`.\n\n### Color Palette\n\nClass\nProperty\nprimary-[50-950]\nPrimary color palette.\nsurface-[0-950]\nSurface color palette.\nprimary\nDefault primary color.\nprimary-contrast\nDefault primary contrast color.\nprimary-emphasis\nDefault primary emphasis color.\nborder-surface\nDefault primary emphasis color.\nbg-emphasis\nEmphasis background e.g. hovered element.\nbg-highlight\nHighlight background.\nbg-highlight-emphasis\nHighlight background with emphasis.\nrounded-border\nBorder radius.\ntext-color\nText color with emphasis.\ntext-color-emphasis\nDefault primary emphasis color.\ntext-muted-color\nSecondary text color.\ntext-muted-color-emphasis\nSecondary text color with emphasis.",
|
|
44230
|
+
"examples": null
|
|
44024
44231
|
},
|
|
44025
44232
|
{
|
|
44026
44233
|
"id": "darkmode",
|
|
44027
|
-
"label": "
|
|
44028
|
-
"description": "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
|
|
44234
|
+
"label": "Dark Mode",
|
|
44235
|
+
"description": "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\ndark variant for seamless integration. Note that, this particular configuration isn't required if you're utilizing the default system color scheme.\n\nSuppose that, the darkModeSelector is set as `my-app-dark` in ExhaustiveUI.\n\n### Tailwind v4\n\nAdd a custom variant for dark with a custom selector.\n\n### Tailwind v3\n\nUse the plugins option in your Tailwind config file to configure the plugin.",
|
|
44029
44236
|
"examples": null
|
|
44030
44237
|
},
|
|
44031
44238
|
{
|
|
44032
|
-
"id": "
|
|
44033
|
-
"label": "
|
|
44034
|
-
"description": "
|
|
44239
|
+
"id": "override",
|
|
44240
|
+
"label": "Override",
|
|
44241
|
+
"description": "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.\n\n### Important\n\nUse the `!` important modifier to enforce the styling: Tailwind v4 places it at the end of the class name, Tailwind v3 at the start. This is not the recommend approach, and should be used as last resort to avoid adding\nunnecessary style classes to your bundle.\n\nTailwind v4\n\nTailwind v3\n\n### CSS Layer\n\nCSS Layer provides control over the css specificity so that Tailwind utilities can safely override components.\n\nTailwind v4\n\nEnsure `exhaustive` layer is after `theme` and `base`, but before the other Tailwind layers such as `utilities`.\n\nNo change in the CSS configuration is required.\n\nTailwind v3\n\nThe `exhaustive` layer should be between base and utilities.\n\nTailwind v3 does not use native `layer` so needs to be defined with CSS.",
|
|
44035
44242
|
"examples": null
|
|
44036
44243
|
},
|
|
44244
|
+
{
|
|
44245
|
+
"id": "color-palette",
|
|
44246
|
+
"label": "Color Palette",
|
|
44247
|
+
"description": "ExhaustiveUI color palette as utility classes.",
|
|
44248
|
+
"examples": {
|
|
44249
|
+
"typescript": "import { Component } from '@angular/core';\n\n@Component({\n template: `\n <div class=\"card\">\n <div class=\"flex flex-col gap-12\">\n <ul class=\"p-0 m-0 list-none flex sm:flex-col gap-4 flex-wrap sm:flex-nowrap\">\n <li *ngFor=\"let color of colors; let i = index\" [ngStyle]=\"{ 'min-width': '6rem' }\" class=\"flex-auto\">\n <span class=\"font-medium capitalize block mb-2 text-center sm:text-left\">{{ color }}</span>\n <div class=\"flex gap-4 flex-auto flex-col sm:flex-row\">\n <div *ngFor=\"let shade of shades\" [ngClass]=\"{ invisible: color === 'primary' && shade === 0 }\" class=\"flex flex-col items-center gap-1 flex-1\">\n <div class=\"rounded-sm h-8 w-full\" [ngStyle]=\"{ 'background-color': 'var(--p-' + color + '-' + shade + ')' }\"></div>\n <span class=\"text-sm text-surface-500 dark:text-surface-400 font-medium\">{{ shade }}</span>\n </div>\n </div>\n </li>\n </ul>\n <div class=\"flex gap-6 flex-wrap\">\n <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>\n <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>\n <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>\n </div>\n </div>\n </div>\n `,\n standalone: true,\n imports: []\n})\nexport class TailwindColorpaletteDemo {\n shades: number[] = [0, 50, 100, 200, 300, 400, 500, 600, 700, 800, 900, 950];\n colors: string[] = ['primary', 'surface'];\n}"
|
|
44250
|
+
}
|
|
44251
|
+
},
|
|
44037
44252
|
{
|
|
44038
44253
|
"id": "form",
|
|
44039
44254
|
"label": "Form",
|
|
@@ -44051,22 +44266,12 @@
|
|
|
44051
44266
|
}
|
|
44052
44267
|
},
|
|
44053
44268
|
{
|
|
44054
|
-
"id": "
|
|
44055
|
-
"label": "
|
|
44056
|
-
"description": "
|
|
44057
|
-
"examples":
|
|
44058
|
-
},
|
|
44059
|
-
|
|
44060
|
-
"id": "overview",
|
|
44061
|
-
"label": "Overview",
|
|
44062
|
-
"description": "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.",
|
|
44063
|
-
"examples": null
|
|
44064
|
-
},
|
|
44065
|
-
{
|
|
44066
|
-
"id": "plugin",
|
|
44067
|
-
"label": "Plugin",
|
|
44068
|
-
"description": "The @exhaustive-ui/tailwindcss is a plugin to provide first class integration between ExhaustiveUI and Tailwind CSS. It is designed to work both in styled and unstyled modes. In styled mode, for instance the semantic colors such as primary and surfaces are provided as Tailwind utilities e.g. bg-primary , text-surface-500 , text-muted-color . If you haven't already done so, start by integrating Tailwind into your project. Detailed steps for this process can be found in the Tailwind documentation . After successfully installing Tailwind, proceed with the installation of the ExhaustiveUiTailwind plugin. This single npm package comes with two libraries: the CSS version is compatible with Tailwind v4, the recommended version, while the JS version is designed for Tailwind v3. Tailwind v4 In the CSS file that contains the tailwindcss import, add the @exhaustive-ui/tailwindcss import as well. For a comprehensive starter guide, review the ExhaustiveUI repository which demonstrates the integration. Tailwind v3 Use the plugins option in your Tailwind config file to configure the plugin.",
|
|
44069
|
-
"examples": null
|
|
44269
|
+
"id": "animations",
|
|
44270
|
+
"label": "Animations",
|
|
44271
|
+
"description": "The plugin also adds extended animation utilities that can be used with the styleclass and animateonscroll directives.",
|
|
44272
|
+
"examples": {
|
|
44273
|
+
"typescript": "import { Component, OnInit } from '@angular/core';\nimport { FormsModule } from '@angular/forms';\nimport { SelectModule } from '@exhaustive-ui/core/select';\n\n@Component({\n template: `\n <div class=\"card\">\n <p-select [(ngModel)]=\"animation\" [options]=\"animations\" placeholder=\"Select One\" class=\"w-full sm:w-44\" />\n <div class=\"py-8 overflow-hidden\">\n <div [ngClass]=\"dynamicAnimationClasses\"></div>\n </div>\n </div>\n <h3>Animations</h3>\n <div class=\"doc-tablewrapper\">\n <table class=\"doc-table\">\n <thead>\n <tr>\n <th>Class</th>\n <th>Property</th>\n </tr>\n </thead>\n <tbody>\n <tr>\n <td>animate-fadein</td>\n <td>fadein 0.15s linear</td>\n </tr>\n <tr>\n <td>animate-fadeout</td>\n <td>fadeout 0.15s linear</td>\n </tr>\n <tr>\n <td>animate-slidedown</td>\n <td>slidedown 0.45s ease-in-out</td>\n </tr>\n <tr>\n <td>animate-slideup</td>\n <td>slideup 0.45s cubic-bezier(0, 1, 0, 1)</td>\n </tr>\n <tr>\n <td>animate-scalein</td>\n <td>scalein 0.15s linear</td>\n </tr>\n <tr>\n <td>animate-fadeinleft</td>\n <td>fadeinleft 0.15s linear</td>\n </tr>\n <tr>\n <td>animate-fadeoutleft</td>\n <td>fadeoutleft 0.15s linear</td>\n </tr>\n <tr>\n <td>animate-fadeinright</td>\n <td>fadeinright 0.15s linear</td>\n </tr>\n <tr>\n <td>animate-fadeoutright</td>\n <td>fadeoutright 0.15s linear</td>\n </tr>\n <tr>\n <td>animate-fadeinup</td>\n <td>fadeinup 0.15s linear</td>\n </tr>\n <tr>\n <td>animate-fadeoutup</td>\n <td>fadeoutup 0.15s linear</td>\n </tr>\n <tr>\n <td>animate-fadeindown</td>\n <td>fadeindown 0.15s linear</td>\n </tr>\n <tr>\n <td>animate-fadeoutup</td>\n <td>fadeoutup 0.15s linear</td>\n </tr>\n <tr>\n <td>animate-width</td>\n <td>width 0.15s linear</td>\n </tr>\n <tr>\n <td>animate-flip</td>\n <td>flip 0.15s linear</td>\n </tr>\n <tr>\n <td>animate-flipup</td>\n <td>flipup 0.15s linear</td>\n </tr>\n <tr>\n <td>animate-flipleft</td>\n <td>fadein 0.15s linear</td>\n </tr>\n <tr>\n <td>animate-flipright</td>\n <td>flipright 0.15s linear</td>\n </tr>\n <tr>\n <td>animate-zoomin</td>\n <td>zoomin 0.15s linear</td>\n </tr>\n <tr>\n <td>animate-zoomindown</td>\n <td>zoomindown 0.15s linear</td>\n </tr>\n <tr>\n <td>animate-zoominleft</td>\n <td>zoominleft 0.15s linear</td>\n </tr>\n <tr>\n <td>animate-zoominright</td>\n <td>zoominright 0.15s linear</td>\n </tr>\n <tr>\n <td>animate-zoominup</td>\n <td>zoominup 0.15s linear</td>\n </tr>\n </tbody>\n </table>\n </div>\n <h3>Animation Duration</h3>\n <div class=\"doc-tablewrapper\">\n <table class=\"doc-table\">\n <thead>\n <tr>\n <th>Class</th>\n <th>Property</th>\n </tr>\n </thead>\n <tbody>\n <tr>\n <td>animate-duration-0</td>\n <td>animation-duration: 0s</td>\n </tr>\n <tr>\n <td>animate-duration-75</td>\n <td>animation-duration: 75ms</td>\n </tr>\n <tr>\n <td>animate-duration-100</td>\n <td>animation-duration: 100ms</td>\n </tr>\n <tr>\n <td>animate-duration-200</td>\n <td>animation-duration: 200ms</td>\n </tr>\n <tr>\n <td>animate-duration-300</td>\n <td>animation-duration: 300ms</td>\n </tr>\n <tr>\n <td>animate-duration-400</td>\n <td>animation-duration: 400ms</td>\n </tr>\n <tr>\n <td>animate-duration-500</td>\n <td>animation-duration: 500ms</td>\n </tr>\n <tr>\n <td>animate-duration-700</td>\n <td>animation-duration: 700ms</td>\n </tr>\n <tr>\n <td>animate-duration-1000</td>\n <td>animation-duration: 1000ms</td>\n </tr>\n <tr>\n <td>animate-duration-2000</td>\n <td>animation-duration: 2000ms</td>\n </tr>\n <tr>\n <td>animate-duration-3000</td>\n <td>animation-duration: 300ms</td>\n </tr>\n </tbody>\n </table>\n </div>\n <h3>Animation Delay</h3>\n <div class=\"doc-tablewrapper\">\n <table class=\"doc-table\">\n <thead>\n <tr>\n <th>Class</th>\n <th>Property</th>\n </tr>\n </thead>\n <tbody>\n <tr>\n <td>animate-delay-none</td>\n <td>animation-duration: 0s</td>\n </tr>\n <tr>\n <td>animate-delay-75</td>\n <td>animation-delay: 75ms</td>\n </tr>\n <tr>\n <td>animate-delay-100</td>\n <td>animation-delay: 100ms</td>\n </tr>\n <tr>\n <td>animate-delay-150</td>\n <td>animation-delay: 150ms</td>\n </tr>\n <tr>\n <td>animate-delay-200</td>\n <td>animation-delay: 200ms</td>\n </tr>\n <tr>\n <td>animate-delay-300</td>\n <td>animation-delay: 300ms</td>\n </tr>\n <tr>\n <td>animate-delay-400</td>\n <td>animation-delay: 400ms</td>\n </tr>\n <tr>\n <td>animate-delay-500</td>\n <td>animation-delay: 500ms</td>\n </tr>\n <tr>\n <td>animate-delay-700</td>\n <td>animation-delay: 700ms</td>\n </tr>\n <tr>\n <td>animate-delay-1000</td>\n <td>animation-delay: 1000ms</td>\n </tr>\n </tbody>\n </table>\n </div>\n <h3>Iteration Count</h3>\n <div class=\"doc-tablewrapper\">\n <table class=\"doc-table\">\n <thead>\n <tr>\n <th>Class</th>\n <th>Property</th>\n </tr>\n </thead>\n <tbody>\n <tr>\n <td>animate-infinite</td>\n <td>animation-iteration-count: infinite</td>\n </tr>\n <tr>\n <td>animate-once</td>\n <td>animation-iteration-count: 1</td>\n </tr>\n <tr>\n <td>animate-twice</td>\n <td>animation-iteration-count: 2</td>\n </tr>\n </tbody>\n </table>\n </div>\n <h3>Direction</h3>\n <div class=\"doc-tablewrapper\">\n <table class=\"doc-table\">\n <thead>\n <tr>\n <th>Class</th>\n <th>Property</th>\n </tr>\n </thead>\n <tbody>\n <tr>\n <td>animate-normal</td>\n <td>animation-direction: normal</td>\n </tr>\n <tr>\n <td>animate-reverse</td>\n <td>animation-direction: reverse</td>\n </tr>\n <tr>\n <td>animate-alternate</td>\n <td>animation-direction: alternate</td>\n </tr>\n <tr>\n <td>animate-alternate-reverse</td>\n <td>animation-direction: alternate-reverse</td>\n </tr>\n </tbody>\n </table>\n </div>\n <h3>Timing Function</h3>\n <div class=\"doc-tablewrapper\">\n <table class=\"doc-table\">\n <thead>\n <tr>\n <th>Class</th>\n <th>Property</th>\n </tr>\n </thead>\n <tbody>\n <tr>\n <td>animate-ease-linear</td>\n <td>animation-timing-function: linear</td>\n </tr>\n <tr>\n <td>animate-ease-in</td>\n <td>animation-timing-function: cubic-bezier(0.4, 0, 1, 1)</td>\n </tr>\n <tr>\n <td>animate-ease-out</td>\n <td>animation-timing-function: cubic-bezier(0, 0, 0.2, 1)</td>\n </tr>\n <tr>\n <td>animate-ease-in-out</td>\n <td>animation-timing-function: cubic-bezier(0.4, 0, 0.2, 1)</td>\n </tr>\n </tbody>\n </table>\n </div>\n <h3>Fill Mode</h3>\n <div class=\"doc-tablewrapper\">\n <table class=\"doc-table\">\n <thead>\n <tr>\n <th>Class</th>\n <th>Property</th>\n </tr>\n </thead>\n <tbody>\n <tr>\n <td>animate-fill-none</td>\n <td>animation-fill-mode: normal</td>\n </tr>\n <tr>\n <td>animate-fill-forwards</td>\n <td>animation-fill-mode: forwards</td>\n </tr>\n <tr>\n <td>animate-fill-backwards</td>\n <td>animation-fill-mode: backwards</td>\n </tr>\n <tr>\n <td>animate-fill-both</td>\n <td>animation-fill-mode: both</td>\n </tr>\n </tbody>\n </table>\n </div>\n <h3>Play State</h3>\n <div class=\"doc-tablewrapper\">\n <table class=\"doc-table\">\n <thead>\n <tr>\n <th>Class</th>\n <th>Property</th>\n </tr>\n </thead>\n <tbody>\n <tr>\n <td>animate-running</td>\n <td>animation-play-state: running</td>\n </tr>\n <tr>\n <td>animate-paused</td>\n <td>animation-play-state: paused</td>\n </tr>\n </tbody>\n </table>\n </div>\n <h3>Backface Visibility State</h3>\n <div class=\"doc-tablewrapper\">\n <table class=\"doc-table\">\n <thead>\n <tr>\n <th>Class</th>\n <th>Property</th>\n </tr>\n </thead>\n <tbody>\n <tr>\n <td>backface-visible</td>\n <td>backface-visibility: visible</td>\n </tr>\n <tr>\n <td>backface-hidden</td>\n <td>backface-visibility: hidden</td>\n </tr>\n </tbody>\n </table>\n </div>\n `,\n standalone: true,\n imports: [SelectModule, FormsModule]\n})\nexport class TailwindAnimationsDemo implements OnInit {\n animation: any = null;\n\n ngOnInit() {\n this.animations = [\n 'fadein',\n 'fadeout',\n 'slideup',\n 'scalein',\n 'fadeinleft',\n 'fadeoutleft',\n 'fadeinright',\n 'fadeoutright',\n 'fadeinup',\n 'fadeoutup',\n 'width',\n 'flipup',\n 'flipleft',\n 'flipright',\n 'zoomin',\n 'zoomindown',\n 'zoominleft',\n 'zoominright',\n 'zoominup'\n ];\n }\n}"
|
|
44274
|
+
}
|
|
44070
44275
|
}
|
|
44071
44276
|
]
|
|
44072
44277
|
},
|
|
@@ -44077,43 +44282,39 @@
|
|
|
44077
44282
|
"description": "LLM-optimized documentation endpoints for ExhaustiveUI components.",
|
|
44078
44283
|
"sections": [
|
|
44079
44284
|
{
|
|
44080
|
-
"id": "
|
|
44081
|
-
"label": "
|
|
44082
|
-
"description": "The
|
|
44083
|
-
"examples":
|
|
44084
|
-
"command": "npx skills add https://exhaustive-ui.com\n\n# update to the latest docs\nnpx skills update exhaustive-ui"
|
|
44085
|
-
}
|
|
44285
|
+
"id": "llmstxt",
|
|
44286
|
+
"label": "/llms.txt",
|
|
44287
|
+
"description": "The [llms.txt](https://llmstxt.org/) file is an industry standard that helps AI models better understand and navigate the ExhaustiveUI documentation. It lists key pages in a\nstructured format, making it easier for LLMs to retrieve relevant information.\n\n[\n\n](/llms/llms.txt)",
|
|
44288
|
+
"examples": null
|
|
44086
44289
|
},
|
|
44087
44290
|
{
|
|
44088
44291
|
"id": "llmsfulltxt",
|
|
44089
|
-
"label": "
|
|
44090
|
-
"description": "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.",
|
|
44292
|
+
"label": "/llms-full.txt",
|
|
44293
|
+
"description": "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.\n\n[\n\n](/llms/llms-full.txt)",
|
|
44091
44294
|
"examples": null
|
|
44092
44295
|
},
|
|
44093
44296
|
{
|
|
44094
|
-
"id": "
|
|
44095
|
-
"label": "
|
|
44096
|
-
"description": "
|
|
44297
|
+
"id": "markdown",
|
|
44298
|
+
"label": ".md extension",
|
|
44299
|
+
"description": "Add a `.md` to a page's URL to display a Markdown version of that page.\n\n[\n\n](/llms/components/button.md)",
|
|
44097
44300
|
"examples": null
|
|
44098
44301
|
},
|
|
44099
44302
|
{
|
|
44100
|
-
"id": "
|
|
44101
|
-
"label": "
|
|
44102
|
-
"description": "
|
|
44103
|
-
"examples":
|
|
44104
|
-
"typescript": "{\n \"schemaVersion\": 1,\n \"entryPoints\": [\n {\n \"name\": \"button\",\n \"import\": \"@exhaustive-ui/core/button\",\n \"modules\": [\"ButtonModule\"],\n \"declarations\": [\n {\n \"kind\": \"component\",\n \"className\": \"Button\",\n \"selector\": \"p-button\",\n \"inputs\": [\n { \"name\": \"severity\", \"type\": \"ButtonSeverity\", \"values\": [\"success\", \"info\", \"warn\", \"danger\", \"secondary\", \"contrast\", \"help\", \"primary\"] },\n { \"name\": \"raised\", \"type\": \"boolean\", \"default\": \"false\", \"transform\": \"booleanAttribute\" }\n ],\n \"outputs\": [{ \"name\": \"onClick\", \"payload\": \"MouseEvent\" }],\n \"templates\": [{ \"name\": \"icon\", \"context\": \"ButtonIconTemplateContext\" }]\n }\n ]\n }\n ]\n}"
|
|
44105
|
-
}
|
|
44303
|
+
"id": "agentskill",
|
|
44304
|
+
"label": "Agent Skill",
|
|
44305
|
+
"description": "The markdown files above are also bundled as an [Agent Skill](https://agentskills.io), the `SKILL.md` format supported by coding agents such as Claude Code,\nCodex, 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.\n\nInstall it with the [skills CLI](https://skills.sh/docs/cli), which asks which agents to set it up for.\n\n```bash\nnpx skills add https://exhaustive-ui.com\n\n# update to the latest docs\nnpx skills update exhaustive-ui\n```\n\nBy 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\nagent's skills directory.\n\n[\n\n](/llms/exhaustive-ui-skill.zip)",
|
|
44306
|
+
"examples": null
|
|
44106
44307
|
},
|
|
44107
44308
|
{
|
|
44108
|
-
"id": "
|
|
44109
|
-
"label": "
|
|
44110
|
-
"description": "
|
|
44309
|
+
"id": "mcp",
|
|
44310
|
+
"label": "MCP Server",
|
|
44311
|
+
"description": "[@exhaustive-ui/mcp](https://www.npmjs.com/package/@exhaustive-ui/mcp) is a\n[Model Context Protocol](https://modelcontextprotocol.io) server that gives coding agents such as Claude Code, Cursor, Claude Desktop, VS Code Copilot and Codex\ntools 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\ncompiled API (unknown inputs or outputs, invalid literal values, unsupported two-way bindings, deprecated inputs, PrimeNG imports and selectors).\n\nThe 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\nin the package and used when the network is unavailable.\n\nRegister it with Claude Code:\n\n```bash\nclaude mcp add exhaustive-ui -s user -- npx -y @exhaustive-ui/mcp\n```\n\nOr add it to the MCP configuration of your client (`.cursor/mcp.json`, `claude_desktop_config.json`, `.vscode/mcp.json` with a `servers` key, ...):\n\n```typescript\n{\n \"mcpServers\": {\n \"exhaustive-ui\": {\n \"command\": \"npx\",\n \"args\": [\"-y\", \"@exhaustive-ui/mcp\"]\n }\n }\n}\n```\n\nThe 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\nprompts 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\n`EXHAUSTIVE_UI_MCP_OFFLINE=1` to only use the bundled snapshot. The package README lists every option.",
|
|
44111
44312
|
"examples": null
|
|
44112
44313
|
},
|
|
44113
44314
|
{
|
|
44114
|
-
"id": "
|
|
44115
|
-
"label": "
|
|
44116
|
-
"description": "
|
|
44315
|
+
"id": "manifest",
|
|
44316
|
+
"label": "Manifest",
|
|
44317
|
+
"description": "[/llms/manifest.json](/llms/manifest.json) describes every component, directive, NgModule, service and exported type as structured data, for tools that need exact facts rather than prose:\nMCP 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.\n\nEach 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,\ntemplates with their context type, methods, forms support and pass-through keys.\n\n```typescript\n{\n \"schemaVersion\": 1,\n \"entryPoints\": [\n {\n \"name\": \"button\",\n \"import\": \"@exhaustive-ui/core/button\",\n \"modules\": [\"ButtonModule\"],\n \"declarations\": [\n {\n \"kind\": \"component\",\n \"className\": \"Button\",\n \"selector\": \"p-button\",\n \"inputs\": [\n { \"name\": \"severity\", \"type\": \"ButtonSeverity\", \"values\": [\"success\", \"info\", \"warn\", \"danger\", \"secondary\", \"contrast\", \"help\", \"primary\"] },\n { \"name\": \"raised\", \"type\": \"boolean\", \"default\": \"false\", \"transform\": \"booleanAttribute\" }\n ],\n \"outputs\": [{ \"name\": \"onClick\", \"payload\": \"MouseEvent\" }],\n \"templates\": [{ \"name\": \"icon\", \"context\": \"ButtonIconTemplateContext\" }]\n }\n ]\n }\n ]\n}\n```",
|
|
44117
44318
|
"examples": null
|
|
44118
44319
|
}
|
|
44119
44320
|
]
|
|
@@ -44127,37 +44328,37 @@
|
|
|
44127
44328
|
{
|
|
44128
44329
|
"id": "colors",
|
|
44129
44330
|
"label": "Colors",
|
|
44130
|
-
"description": "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
|
|
44331
|
+
"description": "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.\n\n### Good Contrast\n\nColor 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.\n\nGOOD\nBAD\n\n### Vibration\n\nColor 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.\n\nVIBRATE\n\n### Dark Mode\n\nHighly saturated colors should be avoided when used within a dark design scheme as they cause eye strain. Instead desaturated colors should be preferred.\n\nIndigo 500\nIndigo 200",
|
|
44131
44332
|
"examples": null
|
|
44132
44333
|
},
|
|
44133
44334
|
{
|
|
44134
44335
|
"id": "formcontrols",
|
|
44135
44336
|
"label": "Formcontrols",
|
|
44136
|
-
"description": "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
|
|
44337
|
+
"description": "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\nwith space key as well to trigger.\n\n```html\n<button (click)=\"onButtonClick($event)\">Click></button>\n```\n\nOn the other hand, a fancy css based button using a div has no keyboard or screen reader support.\n\n```html\n<div class=\"fancy-button\" (click)=\"onButtonClick($event)\">Click</div>\n```\n\n`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\ncontrols should be preferred.\n\n```html\n<div class=\"fancy-button\" (click)=\"onButtonClick($event)\" (keydown)=\"onKeyDown($event)\" tabIndex=\"0\">Click</div>\n```\n\n### Relations\n\nForm components must be related to another element that describes what the form element is used for. This is usually achieved with the `label` element.\n\n```html\n<label for=\"myinput\">Username:</label>\n<input id=\"myinput\" type=\"text\" name=\"username\" />\n```",
|
|
44137
44338
|
"examples": null
|
|
44138
44339
|
},
|
|
44139
44340
|
{
|
|
44140
44341
|
"id": "introduction",
|
|
44141
44342
|
"label": "Introduction",
|
|
44142
|
-
"description": "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
|
|
44343
|
+
"description": "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\nto ensure content can be consumed by anyone.\n\n### Disabilities\n\nTypes of disabilities are diverse so you need to know your audience well and how they interact with the content created. There four main categories;\n\n### Visual Impairments\n\nBlindness, 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\ndevelopers are required to make sure content is readable by the readers. Popular readers are\n[NVDA](https://www.nvaccess.org), [JAWS](https://www.freedomscientific.com/Products/software/JAWS/) and\n[ChromeVox](https://www.chromevox.com).\n\n### Hearing Impairments\n\nDeafness 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\nproviding textual alternatives, transcripts and captions for content with audio.\n\n### Mobility Impairments\n\nPeople 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\ntrackpad remain as solutions for people who are not able to utilize a mouse.\n\n### Cognitive Impairments\n\nCognitive 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\nimpairments result in better design for any user.",
|
|
44143
44344
|
"examples": null
|
|
44144
44345
|
},
|
|
44145
44346
|
{
|
|
44146
44347
|
"id": "semantichtml",
|
|
44147
44348
|
"label": "Semantichtml",
|
|
44148
|
-
"description": "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
|
|
44349
|
+
"description": "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\n`div` elements with classes are used. Consider the following example that do not mean too much for readers.\n\n```html\n<div class=\"header\"/>\n <div class=\"header-text\">Header></div>\n</div>\n\n<div class=\"nav\"></div>\n\n<div class=\"main\">\n <div class=\"content\"></div>\n <div class=\"sidebar\"></div>\n</div>\n\n<div class=\"footer\"></div>\n```\n\nSame layout can be achieved using the semantic elements with screen reader support built-in.\n\n```html\n<header>\n <h1>Header</h1>\n</header>\n\n<nav></nav>\n\n<main>\n <article></article>\n <aside></aside>\n</main>\n\n<footer></footer>\n```",
|
|
44149
44350
|
"examples": null
|
|
44150
44351
|
},
|
|
44151
44352
|
{
|
|
44152
44353
|
"id": "waiaria",
|
|
44153
44354
|
"label": "Waiaria",
|
|
44154
|
-
"description": "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
|
|
44355
|
+
"description": "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\na 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\nmust provide keyboard and screen reader support, the latter case is where the WAI-ARIA is utilized.\n\nARIA 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\nelement like `aria-checked`, `aria-disabled`.\n\nConsider the following case of a native checkbox. It has built-in keyboard and screen reader support.\n\n```html\n<input type=\"checkbox\" value=\"Prime\" name=\"ui\" checked/>\n```\n\nA 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\nbe read by a reader.\n\n```html\n<div class=\"fancy-checkbox\">\n <i *ngIf=\"checked\" class=\"checked-icon\"></i>\n</div>\n```\n\nOne alternative is using ARIA roles for readers and use javascript for keyboard support. Notice the usage of\n`aria-labelledby` as a replacement of the `label` tag with for.\n\n```html\n<span id=\"chk-label\">Remember Me></span>\n<div class=\"fancy-checkbox\" role=\"checkbox\" aria-checked=\"false\" tabindex=\"0\" aria-labelledby=\"chk-label\" (click)=\"toggle()\" (keydown)=\"onKeyDown($event)\">\n <i *ngIf=\"checked\" class=\"checked-icon\"></i>\n</div>\n```\n\nHowever 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\nusage of\n`p-hidden-accessible`\nthat hides the elements from the user but not from the screen reader.\n\n```html\n<label for=\"chkbox\">Remember Me></label>\n<div class=\"fancy-checkbox\" (click)=\"toggle()\">\n <input class=\"p-hidden-accessible\" type=\"checkbox\" id=\"chkbox\" (focus)=\"updateParentVisuals()\" (blur)=\"updateParentVisuals()\" (keydown)=\"$event.keyCode === 32 && updateParentVisuals()\">\n <i *ngIf=\"checked\" class=\"checked-icon\"></i>\n</div>\n```\n\nA 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.\n\nRemember Me",
|
|
44155
44356
|
"examples": null
|
|
44156
44357
|
},
|
|
44157
44358
|
{
|
|
44158
44359
|
"id": "wcag",
|
|
44159
44360
|
"label": "Wcag",
|
|
44160
|
-
"description": "WCAG refers to Web Content Accessibility Guideline
|
|
44361
|
+
"description": "[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\nWeb Consortium). WCAG consists of recommendations for making the web content more accessible. ExhaustiveUI components aim high level of WCAG compliancy in the near future.\n\nVarious 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\n[Web Accessibility Directive](https://digital-strategy.ec.europa.eu/en/policies/web-accessibility) of the European Union.",
|
|
44161
44362
|
"examples": null
|
|
44162
44363
|
}
|
|
44163
44364
|
]
|
|
@@ -44171,19 +44372,19 @@
|
|
|
44171
44372
|
{
|
|
44172
44373
|
"id": "anchoredoverlays",
|
|
44173
44374
|
"label": "Anchoredoverlays",
|
|
44174
|
-
"description": "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
|
|
44375
|
+
"description": "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\n`.p-anchored-overlay-leave-active`\nclasses.",
|
|
44175
44376
|
"examples": null
|
|
44176
44377
|
},
|
|
44177
44378
|
{
|
|
44178
44379
|
"id": "collapsibles",
|
|
44179
44380
|
"label": "Collapsibles",
|
|
44180
|
-
"description": "Collapsible components have a content that is toggleable including Accordion, Panel, Fieldset, Stepper and PanelMenu. The enter and leave animations are defined with the
|
|
44381
|
+
"description": "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\n`.p-collapsible-leave-active`\nclasses.\n\nHeader I\n\nLorem 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\ncommodo 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\nid est laborum.\n\nHeader II\n\nSed 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.\nNemo 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.\n\nHeader III\n\nSed 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.\nNemo 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.",
|
|
44181
44382
|
"examples": null
|
|
44182
44383
|
},
|
|
44183
44384
|
{
|
|
44184
44385
|
"id": "dialog",
|
|
44185
44386
|
"label": "Dialog",
|
|
44186
|
-
"description": "Overlays such as Dialog and Drawer are positioned relative to the viewport and have their own animations
|
|
44387
|
+
"description": "Overlays such as Dialog and Drawer are positioned relative to the viewport and have their own animations.\n\nUpdate your information.\nUsername\nEmail",
|
|
44187
44388
|
"examples": null
|
|
44188
44389
|
},
|
|
44189
44390
|
{
|
|
@@ -44195,13 +44396,13 @@
|
|
|
44195
44396
|
{
|
|
44196
44397
|
"id": "introduction",
|
|
44197
44398
|
"label": "Introduction",
|
|
44198
|
-
"description": "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
|
|
44399
|
+
"description": "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\ndefault animations, this documentation covers the entire set of built-in animations.\n\nAnimations 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\nfunction. 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\ndemo purposes, this second approach is used throughout the next sections.",
|
|
44199
44400
|
"examples": null
|
|
44200
44401
|
},
|
|
44201
44402
|
{
|
|
44202
44403
|
"id": "reference",
|
|
44203
44404
|
"label": "Reference",
|
|
44204
|
-
"description": "List of class names of the CSS animations used by the components
|
|
44405
|
+
"description": "List of class names of the CSS animations used by the components.\n\nComponent\nEnter Class\nLeave Class\n`Accordion`\n.p-collapsible-enter-active\n.p-collapsible-leave-active\n`AutoComplete`\n.p-anchored-overlay-enter-active\n.p-anchored-overlay-leave-active\n`CascadeSelect`\n.p-anchored-overlay-enter-active\n.p-anchored-overlay-leave-active\n`ColorPicker`\n.p-anchored-overlay-enter-active\n.p-anchored-overlay-leave-active\n`ConfirmPopup`\n.p-anchored-overlay-enter-active\n.p-anchored-overlay-leave-active\n`ContextMenu`\n.p-anchored-overlay-enter-active\n.p-anchored-overlay-leave-active\n`DatePicker`\n.p-anchored-overlay-enter-active\n.p-anchored-overlay-leave-active\n`Dialog`\n.p-dialog-enter-active\n.p-dialog-leave-active\n`Drawer`\n.p-drawer-enter-active\n.p-drawer-leave-active\n`Fieldset`\n.p-collapsible-enter-active\n.p-collapsible-leave-active\n`Galleria`\n.p-galleria-enter-active\n.p-galleria-leave-active\n`Image`\n.p-image-original-enter-active\n.p-image-original-leave-active\n`Menu`\n.p-anchored-overlay-enter-active\n.p-anchored-overlay-leave-active\n`Message`\n.p-message-enter-active\n.p-message-leave-active\n`Modal Masks`\n.p-overlay-mask-enter-active\n.p-overlay-mask-leave-active\n`MultiSelect`\n.p-anchored-overlay-enter-active\n.p-anchored-overlay-leave-active\n`Panel`\n.p-collapsible-enter-active\n.p-collapsible-leave-active\n`PanelMenu`\n.p-collapsible-enter-active\n.p-collapsible-leave-active\n`Password`\n.p-anchored-overlay-enter-active\n.p-anchored-overlay-leave-active\n`Select`\n.p-anchored-overlay-enter-active\n.p-anchored-overlay-leave-active\n`Stepper`\n.p-collapsible-enter-active\n.p-collapsible-leave-active\n`TieredMenu`\n.p-anchored-overlay-enter-active\n.p-anchored-overlay-leave-active\n`Toast`\n.p-toast-message-enter-active\n.p-toast-message-leave-active\n`TreeSelect`\n.p-anchored-overlay-enter-active\n.p-anchored-overlay-leave-active",
|
|
44205
44406
|
"examples": null
|
|
44206
44407
|
}
|
|
44207
44408
|
]
|
|
@@ -44215,7 +44416,7 @@
|
|
|
44215
44416
|
{
|
|
44216
44417
|
"id": "configuration",
|
|
44217
44418
|
"label": "Configuration",
|
|
44218
|
-
"description": "The ExhaustiveUI components natively support Right-to-Left (RTL) text direction through a modern CSS implementation utilizing FlexBox and classes like
|
|
44419
|
+
"description": "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\nconfiguration is necessary; setting the document's text direction to RTL is sufficient to enable this feature.\n\nThe RTL setting can either be set using the `dir` attribute or with the `direction` style property.",
|
|
44219
44420
|
"examples": null
|
|
44220
44421
|
},
|
|
44221
44422
|
{
|
|
@@ -44235,25 +44436,25 @@
|
|
|
44235
44436
|
{
|
|
44236
44437
|
"id": "compatibility",
|
|
44237
44438
|
"label": "Compatibility",
|
|
44238
|
-
"description": "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
|
|
44439
|
+
"description": "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\nand is not a supported pairing here.\n\nNeither 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.",
|
|
44239
44440
|
"examples": null
|
|
44240
44441
|
},
|
|
44241
44442
|
{
|
|
44242
44443
|
"id": "migration",
|
|
44243
44444
|
"label": "Migration",
|
|
44244
|
-
"description": "PrimeFlex class names map closely onto Tailwind's, so most of the work is mechanical. PrimeTek's
|
|
44445
|
+
"description": "PrimeFlex class names map closely onto Tailwind's, so most of the work is mechanical. PrimeTek's\n[primeclt](https://www.npmjs.com/package/primeclt) ships a `pf2tw` command that does the conversion, and it works on any codebase — it rewrites class names and does not care\nwhich component library you use.\n\n```bash\nnpm install -g primeclt\n```\n\nRun `pf2tw` in a directory containing the files to convert.\n\n```bash\nprime pf2tw\n```\n\n`pf2tw` was written for Tailwind v3. Tailwind v4 renamed a few of the utilities it produces, for example `shadow-sm` to `shadow-xs`, `rounded` to `rounded-sm` and `flex-grow` to `grow`. On Tailwind\nv4, check the converted classes against the [renamed utilities](https://tailwindcss.com/docs/upgrade-guide#renamed-utilities) list of the Tailwind upgrade guide.\n\nA handful of PrimeFlex classes have no Tailwind counterpart and are left alone. Replace them with flexbox or grid utilities by hand:\n\n- formgrid\n- formgroup\n- formgroup-inline\n- col\n- col-fixed\n- field\n- field-checkbox\n- field-radiobutton\n- reset",
|
|
44245
44446
|
"examples": null
|
|
44246
44447
|
},
|
|
44247
44448
|
{
|
|
44248
44449
|
"id": "overview",
|
|
44249
44450
|
"label": "Overview",
|
|
44250
|
-
"description": "PrimeFlex was PrimeTek's lightweight CSS utility library, designed to accompany PrimeNG. PrimeTek stopped maintaining it before the relicensing, on the
|
|
44451
|
+
"description": "[PrimeFlex](https://primeflex.org) was PrimeTek's lightweight CSS utility library, designed to accompany PrimeNG. PrimeTek stopped maintaining it before the relicensing, on the\ngrounds that most applications already bring their own utility layer — Tailwind, Bootstrap or something in-house — and a second one only overlaps with it.\n\nExhaustiveUI 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\nupdates from us, and we suggest moving to Tailwind CSS.",
|
|
44251
44452
|
"examples": null
|
|
44252
44453
|
},
|
|
44253
44454
|
{
|
|
44254
44455
|
"id": "tailwindcss",
|
|
44255
44456
|
"label": "Tailwindcss",
|
|
44256
|
-
"description": "Tailwind CSS is the replacement we suggest. This documentation site is itself built with it, and we publish
|
|
44457
|
+
"description": "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\ntokens and puts the component styles in a cascade layer you can override cleanly.\n\nSee the [Tailwind CSS guide](https://exhaustive-ui.com/tailwind) for setup with either Tailwind v3 or v4, and the next section for converting existing PrimeFlex classes.",
|
|
44257
44458
|
"examples": null
|
|
44258
44459
|
}
|
|
44259
44460
|
]
|
|
@@ -44265,39 +44466,39 @@
|
|
|
44265
44466
|
"description": "Why ExhaustiveUI exists, what it commits to, and where it stops.",
|
|
44266
44467
|
"sections": [
|
|
44267
44468
|
{
|
|
44268
|
-
"id": "
|
|
44269
|
-
"label": "
|
|
44270
|
-
"description": "
|
|
44469
|
+
"id": "origin",
|
|
44470
|
+
"label": "Why This Fork Exists",
|
|
44471
|
+
"description": "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\n[their own announcement](https://primeui.dev/nextchapter), and it is worth reading. Maintaining a component library of this size for a decade, largely for free, is genuinely hard,\nand we do not think the decision was made lightly.\n\nIt 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.\n\nThis 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.",
|
|
44271
44472
|
"examples": null
|
|
44272
44473
|
},
|
|
44273
44474
|
{
|
|
44274
|
-
"id": "
|
|
44275
|
-
"label": "
|
|
44276
|
-
"description": "
|
|
44475
|
+
"id": "promises",
|
|
44476
|
+
"label": "What We Commit To",
|
|
44477
|
+
"description": "Four commitments, in the order we would want to read them if we were choosing a dependency:\n\n### MIT, with no second tier\n\nEvery 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\nrelicensing of it, because the code we inherited is MIT and so is everything we add to it.\n\n### We track Angular\n\nOur 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\ncan do for the applications built on it.\n\n### Bugs before features\n\nWe 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.\n\n### No surprises in your bundle\n\nThe library sends no telemetry, phones no home, and requires no account or key to use. What you install is what runs.",
|
|
44277
44478
|
"examples": null
|
|
44278
44479
|
},
|
|
44279
44480
|
{
|
|
44280
|
-
"id": "
|
|
44281
|
-
"label": "
|
|
44282
|
-
"description": "
|
|
44481
|
+
"id": "limits",
|
|
44482
|
+
"label": "What We Do Not Do",
|
|
44483
|
+
"description": "Naming the limits is what makes the commitments above worth anything. Here is what ExhaustiveUI is not.\n\n### There is no commercial support\n\nNo 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\naccordingly.\n\n### There are no premium templates, blocks or design tooling\n\nPrimeTek'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\nediting preset objects in code, which is documented in full.\n\n### We are not chasing feature parity with PrimeNG v22 and beyond\n\nPrimeNG 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\nancestor, not as a free copy of a paid product.\n\n### The bus factor is real\n\nThis 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\n[contribute](https://github.com/e-xiste/exhaustive-ui).",
|
|
44283
44484
|
"examples": null
|
|
44284
44485
|
},
|
|
44285
44486
|
{
|
|
44286
|
-
"id": "
|
|
44287
|
-
"label": "
|
|
44288
|
-
"description": "
|
|
44487
|
+
"id": "governance",
|
|
44488
|
+
"label": "How Decisions Are Made",
|
|
44489
|
+
"description": "Everything happens in the open, in the [repository](https://github.com/e-xiste/exhaustive-ui). There is no private roadmap and no internal issue tracker. What you see in the issues,\nthe discussions and the [roadmap](https://exhaustive-ui.com/roadmap) is the whole plan.\n\nContributors earn commit access by contributing — the [contribution guide](https://exhaustive-ui.com/contribution) describes the Contributor and Committer roles and roughly what it takes to reach them. We would rather\ngrow the number of people who can merge a fix than route everything through one person.\n\nBreaking 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\nmigration schematic, rather than dripping renames across releases.",
|
|
44289
44490
|
"examples": null
|
|
44290
44491
|
},
|
|
44291
44492
|
{
|
|
44292
|
-
"id": "
|
|
44293
|
-
"label": "
|
|
44294
|
-
"description": "
|
|
44493
|
+
"id": "trademark",
|
|
44494
|
+
"label": "PrimeNG and PrimeTek",
|
|
44495
|
+
"description": "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\nlibrary — is a trademark matter, not a technical one, and it is why we ship a [migration schematic](https://v1.optimus.openng.org/migration/primeng) rather than\nasking you to rewrite imports by hand.\n\nReferences 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\nwould be both dishonest and useless to anyone trying to find their way around a familiar API.\n\nThe code we forked was published under the MIT license, and we distribute it under those same terms, with the original copyright notices intact.",
|
|
44295
44496
|
"examples": null
|
|
44296
44497
|
},
|
|
44297
44498
|
{
|
|
44298
|
-
"id": "
|
|
44299
|
-
"label": "
|
|
44300
|
-
"description": "
|
|
44499
|
+
"id": "sustainability",
|
|
44500
|
+
"label": "Sustainability",
|
|
44501
|
+
"description": "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\nrisk we can see today.\n\nThe things that actually help, roughly in order of impact:\n\n- Reproducing and triaging issues. A bug with a minimal reproduction is several times more likely to get fixed.\n- Sending pull requests, especially for issues labelled `help-needed`.\n- Answering questions in discussions, so the same answer is not written five times.\n- Improving this documentation. Every page has a source file and every fix is welcome.\n- Telling your employer you depend on it. Sponsored maintenance time is worth more than any one-off donation.\n\nThe [contribution guide](https://exhaustive-ui.com/contribution) covers how to get started.",
|
|
44301
44502
|
"examples": null
|
|
44302
44503
|
}
|
|
44303
44504
|
]
|
|
@@ -44309,27 +44510,27 @@
|
|
|
44309
44510
|
"description": "Licensing, migration from PrimeNG, the ecosystem, and how support works.",
|
|
44310
44511
|
"sections": [
|
|
44311
44512
|
{
|
|
44312
|
-
"id": "
|
|
44313
|
-
"label": "
|
|
44314
|
-
"description": "
|
|
44513
|
+
"id": "project",
|
|
44514
|
+
"label": "The Project",
|
|
44515
|
+
"description": "### Is ExhaustiveUI free? Will it stay free?\n\nYes, 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\n[philosophy page](https://exhaustive-ui.com/philosophy) goes into what that does and does not buy you.\n\n### Is this an official PrimeNG fork? Are you affiliated with PrimeTek?\n\nNo. ExhaustiveUI is an independent community fork, not affiliated with, endorsed by, or sponsored by PrimeTek. It is a fork of\n[Optimus UI](https://github.com/openng-org/optimus-ui) (OpenNG), itself a repository seeded with PrimeNG's MIT licensed code and history, not a fork of the archived\n`primefaces/primeng` repository.\n\n### Which PrimeNG version is this forked from?\n\nPrimeNG 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\nnumber follows Angular's.\n\n### Who maintains it, and how is it funded?\n\nA small group of volunteers, with e-xiste covering hosting and the domain. We are deliberate about not implying more than that — see\n[sustainability](https://exhaustive-ui.com/philosophy) for the honest version and the ways that can change.\n\n### Why did the name change?\n\nTrademark, 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\nschematic rather than by asking you to rewrite imports by hand.",
|
|
44315
44516
|
"examples": null
|
|
44316
44517
|
},
|
|
44317
44518
|
{
|
|
44318
44519
|
"id": "migration",
|
|
44319
|
-
"label": "Migration",
|
|
44320
|
-
"description": "Which Angular versions are supported
|
|
44520
|
+
"label": "Compatibility & Migration",
|
|
44521
|
+
"description": "### Which Angular versions are supported?\n\nAngular 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\n[version compatibility table](https://exhaustive-ui.com/migration/update) in the update guide.\n\n### How do I migrate from PrimeNG? Is it automatic?\n\nMostly, 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\n`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,\nwith file and line numbers. The [migration guide](https://v1.optimus.openng.org/migration/primeng) covers the details and the manual cases.\n\n### I am on PrimeNG v20 or older. Can I migrate directly?\n\nNo. 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.\n\n### What happens to my PrimeNG license?\n\nNothing — 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\nover here.\n\n### I had an open PR on primefaces/primeng. Can I bring it here?\n\nYes, 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\ncleanly.\n\n### Can I run PrimeNG and ExhaustiveUI side by side?\n\nTechnically 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\nconfiguration.",
|
|
44321
44522
|
"examples": null
|
|
44322
44523
|
},
|
|
44323
44524
|
{
|
|
44324
|
-
"id": "
|
|
44325
|
-
"label": "
|
|
44326
|
-
"description": "
|
|
44525
|
+
"id": "ecosystem",
|
|
44526
|
+
"label": "Themes, Icons & Ecosystem",
|
|
44527
|
+
"description": "### Do the PrimeNG themes work?\n\nThe 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\nmigration schematic handles.\n\n### What about the Theme Designer, templates and blocks?\n\nThose 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\nfull under [styled mode](https://exhaustive-ui.com/theming/styled).\n\n### What replaced PrimeIcons?\n\n[OpenNG Icons](https://exhaustive-ui.com/icons), installed as `@openng/icons`. The `pi pi-{icon}` class names are unchanged, so templates do not need editing — only the package name and the\nstylesheet import, both of which the migration schematic rewrites.\n\n### What about PrimeFlex?\n\nPrimeFlex is not maintained here. We suggest Tailwind CSS instead, and ship `@exhaustive-ui/tailwindcss` for first-class integration — see the [Tailwind guide](https://exhaustive-ui.com/tailwind). The\n[PrimeFlex guide](https://exhaustive-ui.com/guides/primeflex) covers moving across.\n\n### Does ExhaustiveUI work with SSR?\n\nThis 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.",
|
|
44327
44528
|
"examples": null
|
|
44328
44529
|
},
|
|
44329
44530
|
{
|
|
44330
44531
|
"id": "support",
|
|
44331
|
-
"label": "Support",
|
|
44332
|
-
"description": "Is there commercial support
|
|
44532
|
+
"label": "Support & Contributing",
|
|
44533
|
+
"description": "### Is there commercial support?\n\nNo. 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.\n\n### How do I report a bug?\n\nOpen an issue on [GitHub](https://github.com/e-xiste/exhaustive-ui/issues) with a minimal reproduction — a StackBlitz from any demo on this site is ideal — plus your ExhaustiveUI,\nAngular and browser versions. A reproduction is the difference between a bug that gets fixed and one that sits in the backlog.\n\n### How do I request a feature?\n\nOpen a [discussion](https://github.com/e-xiste/exhaustive-ui/discussions). Requests are triaged and welcome, but in practice they ship when someone implements them. If it matters to\nyou, the [contribution guide](https://exhaustive-ui.com/contribution) is the fastest route.\n\n### Where do I ask questions?\n\nGitHub 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.\n\n### How does versioning work?\n\nSemantic versioning, with majors tracking Angular majors. Breaking changes are confined to majors and documented in the\n[GitHub releases](https://github.com/e-xiste/exhaustive-ui/releases).",
|
|
44333
44534
|
"examples": null
|
|
44334
44535
|
}
|
|
44335
44536
|
]
|
|
@@ -44338,41 +44539,111 @@
|
|
|
44338
44539
|
"name": "update",
|
|
44339
44540
|
"path": "migration/update",
|
|
44340
44541
|
"title": "Update ExhaustiveUI",
|
|
44341
|
-
"description": "Updating with ng update, Angular version compatibility, and what changes in v22
|
|
44542
|
+
"description": "Updating with ng update, Angular version compatibility, and a summary of what changes in v22.",
|
|
44342
44543
|
"sections": [
|
|
44343
44544
|
{
|
|
44344
|
-
"id": "
|
|
44345
|
-
"label": "
|
|
44346
|
-
"description": "
|
|
44347
|
-
"examples":
|
|
44348
|
-
"command": "ng update @angular/core@23 @angular/cli@23\nng update @exhaustive-ui/core@23"
|
|
44349
|
-
}
|
|
44545
|
+
"id": "overview",
|
|
44546
|
+
"label": "Overview",
|
|
44547
|
+
"description": "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\nnew 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.\n\nMajor 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.\n\nThis page is about updating a project that already uses ExhaustiveUI. To move an existing PrimeNG workspace across, see the\n[migration guide](https://v1.optimus.openng.org/migration/primeng) instead.",
|
|
44548
|
+
"examples": null
|
|
44350
44549
|
},
|
|
44351
44550
|
{
|
|
44352
|
-
"id": "
|
|
44353
|
-
"label": "
|
|
44354
|
-
"description": "Run ng update without arguments at any time to list the updates available in your workspace, ExhaustiveUI included
|
|
44551
|
+
"id": "updating",
|
|
44552
|
+
"label": "Updating",
|
|
44553
|
+
"description": "Run `ng update` without arguments at any time to list the updates available in your workspace, ExhaustiveUI included.\n\n```bash\nng update\n```\n\nTo 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 —\nthemes, locale, Tailwind CSS plugin and the internal runtime packages — is updated together and the suite cannot end up on mixed versions.\n\n```bash\nng update @exhaustive-ui/core\n```\n\nLike 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.",
|
|
44355
44554
|
"examples": null
|
|
44356
44555
|
},
|
|
44556
|
+
{
|
|
44557
|
+
"id": "angular-compatibility",
|
|
44558
|
+
"label": "Angular Version Compatibility",
|
|
44559
|
+
"description": "Each ExhaustiveUI major targets a single Angular major.\n\nTo move to a new major, update Angular first — the [Angular update guide](https://angular.dev/update-guide) covers that step — then update ExhaustiveUI to the matching major by\npassing the target version. For example, once Angular v23 and ExhaustiveUI v23 are out, from v22:\n\n```bash\nng update @angular/core@23 @angular/cli@23\nng update @exhaustive-ui/core@23\n```\n\nReview the release notes of the target version for breaking changes before you start.",
|
|
44560
|
+
"examples": null
|
|
44561
|
+
},
|
|
44562
|
+
{
|
|
44563
|
+
"id": "v22",
|
|
44564
|
+
"label": "Updating to v22",
|
|
44565
|
+
"description": "ExhaustiveUI v22 is the first major of the fork. It requires Angular 22 and moves the whole library to the Angular Signals API. Templates keep working as before; code that reaches into a component instance reads inputs with a call and\nwrites two-way properties with `.set()`, and components use OnPush change detection. `ng update` applies nine migrations to templates and code and reports what it left for review.\n\n```bash\nng update @angular/core@22 @angular/cli@22\nng update @exhaustive-ui/core@22\n```\n\nThe [migration guide to v22](https://exhaustive-ui.com/migration/v22) covers the update steps from an ExhaustiveUI prerelease, PrimeNG v21 or Optimus UI, each migration and its report, the code changes, and the behavior\nand type changes.",
|
|
44566
|
+
"examples": null
|
|
44567
|
+
},
|
|
44568
|
+
{
|
|
44569
|
+
"id": "release-notes",
|
|
44570
|
+
"label": "Release Notes",
|
|
44571
|
+
"description": "Every version is published with its notes on the [GitHub releases page](https://github.com/e-xiste/exhaustive-ui/releases), covering new features, fixes and any breaking changes or\nmanual steps a release requires. Check the notes for the target version before a major update.",
|
|
44572
|
+
"examples": null
|
|
44573
|
+
}
|
|
44574
|
+
]
|
|
44575
|
+
},
|
|
44576
|
+
{
|
|
44577
|
+
"name": "v22",
|
|
44578
|
+
"path": "migration/v22",
|
|
44579
|
+
"title": "Migrating to v22",
|
|
44580
|
+
"description": "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.",
|
|
44581
|
+
"sections": [
|
|
44357
44582
|
{
|
|
44358
44583
|
"id": "overview",
|
|
44359
44584
|
"label": "Overview",
|
|
44360
|
-
"description": "
|
|
44585
|
+
"description": "ExhaustiveUI v22 requires Angular 22 and moves every component and directive to the Angular Signals API. Templates bind as before: `[name]`, `[(name)]` and `(name)` keep working. Most of the work is done by\n`ng update`. What is left is code that reaches into a component instance, data mutated in place under OnPush components, and the few places the migrations report.\n\nThis guide covers three starting points:\n\n- **A v22 alpha or release candidate** of ExhaustiveUI: update to 22.0.0 with `ng update`, which runs the migrations. They leave code that is already migrated as it is, so running them again is safe.\n- **PrimeNG v21**: switch to ExhaustiveUI with the `migrate-from-primeng` schematic, then run the v22 migrations explicitly.\n- **Optimus UI v2**, which shares the PrimeNG v21 API: swap the packages and imports, then run the v22 migrations explicitly.\n\nUpdating later within v22, or to a future major, is covered by the [update guide](https://exhaustive-ui.com/migration/update). Every breaking change below is also listed in the\n[changelog](https://github.com/e-xiste/exhaustive-ui/blob/main/CHANGELOG.md).",
|
|
44361
44586
|
"examples": null
|
|
44362
44587
|
},
|
|
44363
44588
|
{
|
|
44364
|
-
"id": "
|
|
44365
|
-
"label": "
|
|
44366
|
-
"description": "
|
|
44589
|
+
"id": "prerequisites",
|
|
44590
|
+
"label": "Before you start",
|
|
44591
|
+
"description": "- **Angular 22.** The peer dependencies are `^22.0.0`. Update Angular first with the [Angular update guide](https://angular.dev/update-guide), and use the Node.js and TypeScript versions it requires.\n- **A clean git working tree.** Commit or stash your work, so the changes made by the migrations can be reviewed, and reverted, on their own.\n- **A build and test run that passes** before you start, so anything that breaks afterwards comes from the update.\n- **PrimeFlex**, if the project uses it: it is not part of the update. The `migrate-from-primeflex` schematic translates its classes to Tailwind CSS, as a separate step.",
|
|
44367
44592
|
"examples": null
|
|
44368
44593
|
},
|
|
44369
44594
|
{
|
|
44370
|
-
"id": "
|
|
44371
|
-
"label": "
|
|
44372
|
-
"description": "
|
|
44373
|
-
"examples":
|
|
44374
|
-
|
|
44375
|
-
|
|
44595
|
+
"id": "steps",
|
|
44596
|
+
"label": "Update steps",
|
|
44597
|
+
"description": "### From an ExhaustiveUI alpha or release candidate\n\nUpdate Angular, then ExhaustiveUI. Every installed `@exhaustive-ui/*` package moves to 22.0.0 together, and the migrations run.\n\n```bash\nng update @angular/core@22 @angular/cli@22\nng update @exhaustive-ui/core@22\n```\n\n### From PrimeNG v21\n\nUpdate Angular to 22, install ExhaustiveUI and run the `migrate-from-primeng` schematic. It swaps the `primeng`, `@primeuix/*` and PrimeIcons dependencies, rewrites the imports (`primeng/button` becomes\n`@exhaustive-ui/core/button`) and renames the configuration API (`providePrimeNG` becomes `provideExhaustive`). The workspace did not go through `ng update`, so run the v22 migrations explicitly afterwards.\n\n```bash\nng update @angular/core@22 @angular/cli@22\nnpm install @exhaustive-ui/core@22\nng generate @exhaustive-ui/core:migrate-from-primeng\nng update @exhaustive-ui/core --migrate-only --from=3.0.0\n```\n\nProjects on PrimeNG v20 or older upgrade to PrimeNG v21 first; the schematic checks the version and refuses otherwise.\n\n### From Optimus UI v2\n\nOptimus UI v2 has the PrimeNG v21 API under other package names. Replace its packages with their `@exhaustive-ui/*` counterparts (`@exhaustive-ui/core`, `@exhaustive-ui/themes`...), update the import paths\nto match, then run the v22 migrations explicitly.\n\n```bash\nng update @exhaustive-ui/core --migrate-only --from=3.0.0\n```\n\n### Then\n\n1. Read the report the migrations printed, see `Reviewing the report` below.\n2. Fix the TypeScript errors: most come from the Signals API and the removed TypeScript API.\n3. Check the screens that mutate data bound to a component, which no longer refresh under OnPush.\n4. Read the behavior changes, then build and run your tests.",
|
|
44598
|
+
"examples": null
|
|
44599
|
+
},
|
|
44600
|
+
{
|
|
44601
|
+
"id": "migrations",
|
|
44602
|
+
"label": "Automated migrations",
|
|
44603
|
+
"description": "`ng update` applies nine migrations to the templates (inline and external) and the TypeScript code of every project in the workspace. Each one only touches the ExhaustiveUI elements and APIs it knows, and reports what it cannot\nrewrite safely.\n\n- **styleclass-to-class**: `styleClass`/`[styleClass]` becomes `class`/`[class]` on the ~60 components whose deprecated `styleClass` input was removed, such as Tag, Card, Select, Table, DatePicker, Panel, AvatarGroup and InputGroupAddon.\n- **renamed-inputs**: Drawer `showCloseIcon` becomes `closable` and `ariaCloseLabel` becomes `closeAriaLabel`; Paginator `dropdownAppendTo` becomes `appendTo`; Password `maxLength` becomes `maxlength`; AutoComplete `minLength` becomes `minQueryLength`; TreeSelect `containerStyleClass`/`containerStyle` become `class`/`style`; TreeTable `virtualRowHeight` becomes `virtualScrollItemSize`; Listbox and MultiSelect `filterPlaceHolder` becomes `filterPlaceholder`; ImageCompare `ariaLabelledby` becomes `ariaLabelledBy`; Dialog `[content]`, which set the header template, becomes `[headerTemplate]`; the `pt*` pass-through aliases of pButton, pButtonLabel, pButtonIcon, pBadge, pInputText and pTooltip become `pButtonPT`, `pButtonLabelPT`, `pButtonIconPT`, `pBadgePT`, `pInputTextPT` and `pTooltipPT`; pBadge `size` on a plain element becomes `badgeSize`.\n- **renamed-outputs**: OrderList `onFilterEvent` becomes `onFilter`; Table `selectAllChange` becomes `onSelectAllChange`; MultiSelect `onPanelShow`/`onPanelHide` become `onShow`/`onHide`. The payloads are unchanged, so handlers reading `$event` keep working.\n- **renamed-templates**: the MultiSelect `removetokenicon` template becomes `chipicon`, with the same context.\n- **remove-dead-inputs**: removes the bindings of about eighty inputs that had already stopped doing anything, such as the `*TransitionOptions` inputs (replaced by `motionOptions`), `autoZIndex`/`baseZIndex` on sub menus, Table `frozenColumns`/`frozenWidth`, the ConfirmDialog aria labels and the `trackBy` inputs of DataView, OrderList and PickList.\n- **remove-dead-outputs**: removes Overlay `onAnimationStart`/`onAnimationDone` and MenubarSub `menuFocus`/`menuBlur`/`menuKeydown`.\n- **config-overlay-options-signal**: `Exhaustive.overlayOptions` is a signal. Assignments become `.set()` and reads become calls.\n- **config-input-style-to-variant**: the global `inputStyle` option becomes `inputVariant` (same values), in `provideExhaustive()`/`setConfig()` objects and on the `Exhaustive` service.\n- **removed-exports**: `Password_VALUE_ACCESSOR` becomes `PASSWORD_VALUE_ACCESSOR`; the removed `InplaceDisplay`/`InplaceContent` wrappers are dropped from imports and their elements become `<span>`.",
|
|
44604
|
+
"examples": null
|
|
44605
|
+
},
|
|
44606
|
+
{
|
|
44607
|
+
"id": "review",
|
|
44608
|
+
"label": "Reviewing the report",
|
|
44609
|
+
"description": "Each migration prints the files it changed, then the places it left for you, with the file and line. These are the cases it reports and what to do with them.\n\n- **Programmatic access to a removed or renamed name**, such as `drawer.showCloseIcon = true` or `table.selectAllChange.subscribe(...)`: use the new name, and the Signals API described below.\n- **A tag that binds both the old and the new name**: keep the new one and delete the old one, after checking which value you meant.\n- **A Table `[(selectAll)]` two-way binding**, which relied on the renamed `selectAllChange`: bind `[selectAll]=\"selectAll\"` and `(onSelectAllChange)=\"selectAll = $event.checked\"`.\n- **A MultiSelect that already projects a `chipicon` template** next to `removetokenicon`: keep one of them.\n- **A configuration object that sets both `inputStyle` and `inputVariant` , or a receiver the migration cannot prove to be the `Exhaustive` service: set `inputVariant` only.\n- Imports of rendering internals that are no longer exported**: the `SelectItem` option component of Select (the `SelectItem` interface of `@exhaustive-ui/core/api` is unchanged), Menu's `SafeHtmlPipe`, `MapperPipe`, `RadioControlRegistry` and `MenubarService`. Remove the import; the components no longer need them from you.\n\nCoding agents can check the result with the `validate_usage` tool of the `@exhaustive-ui/mcp` server, which names the replacement of every input removed or renamed in v22, and follow its `update_to_v22` prompt.",
|
|
44610
|
+
"examples": null
|
|
44611
|
+
},
|
|
44612
|
+
{
|
|
44613
|
+
"id": "signals",
|
|
44614
|
+
"label": "Code using a component instance",
|
|
44615
|
+
"description": "Every input is an `input()`, every two-way property a `model()`, every output an `output()` and every query a signal query. No `@Input`, `@Output`, `@ViewChild` or\n`@ContentChild` decorator is left. Templates are not affected, and the migrations do not rewrite this kind of code: the compiler points at each place.\n\n- Read an input by calling it: `table.first()`, not `table.first`.\n- Inputs can no longer be assigned from code. Bind them in the template to a field or a signal of your component, and change that instead.\n- Two-way properties are `model()` signals: write them with `.set()`, as in `drawer.visible.set(true)`. The value and change-event pairs became models, for example `first`, `rows` and `selection` on Table and TreeTable, and `visible` on Dialog, Drawer and Galleria. `[(x)]` bindings keep working.\n- Outputs are `OutputEmitterRef`s: `.subscribe()` still works, `.pipe()` and the other `EventEmitter` members do not. Use `outputToObservable()` when you need an observable.\n- Public child references of a component are signal queries too, and are read with a call.\n- The global configuration is a set of signals on the `Exhaustive` service: `config.ripple.set(true)`, `config.inputVariant()`.\n\n```typescript\n// Before\n@ViewChild(Table) table!: Table;\n@ViewChild(Drawer) drawer!: Drawer;\n\nreset() {\n const first = this.table.first;\n this.table.selection = [];\n this.drawer.visible = false;\n this.config.ripple = true;\n}\n\n// After\ntable = viewChild.required(Table);\ndrawer = viewChild.required(Drawer);\n\nreset() {\n const first = this.table().first();\n this.table().selection.set([]);\n this.drawer().visible.set(false);\n this.config.ripple.set(true);\n}\n```",
|
|
44616
|
+
"examples": null
|
|
44617
|
+
},
|
|
44618
|
+
{
|
|
44619
|
+
"id": "onpush",
|
|
44620
|
+
"label": "OnPush change detection",
|
|
44621
|
+
"description": "Every component uses `OnPush` change detection, except Table, TreeTable and DynamicDialog, which stay Eager on purpose because they render objects that applications commonly mutate in place. An OnPush component refreshes when one\nof its inputs gets a new value, when it handles an event, or when a signal it reads changes. It does not see a change made inside an array or an object it already holds.\n\nThe symptom is a component that does not update: options added with `push()` that do not appear in a Select, a Tree node renamed in place, a chart that keeps its old data. Give the component a new array or object, or keep the\ndata in a signal.\n\n```typescript\n// Before: the Select does not show the new option under OnPush\nthis.cities.push({ name: 'Paris', code: 'PRS' });\n\n// After: a new array\nthis.cities = [...this.cities, { name: 'Paris', code: 'PRS' }];\n\n// Or a signal, bound with [options]=\"cities()\"\ncities = signal<City[]>([]);\nthis.cities.update((cities) => [...cities, { name: 'Paris', code: 'PRS' }]);\n```\n\nTemplates use the built-in `@if`, `@for` and `@switch` control flow, and option lists, menus, Paginator and DatePicker reuse their rows when the data is replaced instead of recreating them. Replacing the\narray is therefore cheap, and no NG0955 or NG0956 warning comes from the library.",
|
|
44622
|
+
"examples": null
|
|
44623
|
+
},
|
|
44624
|
+
{
|
|
44625
|
+
"id": "removed-api",
|
|
44626
|
+
"label": "Removed TypeScript API",
|
|
44627
|
+
"description": "These removals have no migration: they only appear in TypeScript code, and the compiler points at each use.\n\n- `OverlayOptions.showTransitionOptions`/`hideTransitionOptions` and `DynamicDialogConfig.rtl`/`transitionOptions`: nothing read them. Use `motionOptions`.\n- `@exhaustive-ui/utils`: `classNames` becomes `cn`, `createStyleAsString` becomes `createStyleMarkup`, `createStyleTag` becomes `createStyleElement`, `mergeKeys` becomes `deepMerge`.\n- `@exhaustive-ui/styled`: `getDirective` on the theme service becomes `getComponent`.\n- Sub components that render the inside of a component (`ContextMenuSub`, `TieredMenuSub`, `MenuItemContent`, `MultiSelectItem`, `ToastItem`, `TableBody`, `TTBody`, `UITreeNode`, the Galleria parts...), `PARENT_INSTANCE` and the pre-signals helpers of `@exhaustive-ui/core/utils` are still exported in v22 but tagged `@internal`. They are not public API and can change in a minor release.",
|
|
44628
|
+
"examples": null
|
|
44629
|
+
},
|
|
44630
|
+
{
|
|
44631
|
+
"id": "behavior",
|
|
44632
|
+
"label": "Behavior changes",
|
|
44633
|
+
"description": "These changes compile without error but can change what users see, or what a test asserts. Most come from fixes of bugs inherited from PrimeNG and Optimus UI. The issue numbers in the changelog are Optimus UI's.\n\n### Forms\n\n- InputText: when `[invalid]` is bound, it alone decides the invalid style; the automatic `ng-invalid ng-dirty` border no longer applies on top of it.\n- InputNumber: a keystroke that would make the formatted value longer than `maxlength` is rejected instead of truncating the text. The native `min`/`max` attributes are gone; the bounds stay in `aria-valuemin`/`aria-valuemax`.\n- Select: a Select inside a disabled `<fieldset>` is disabled, except inside the fieldset's first `<legend>`, as for native controls.\n- Select, MultiSelect and CascadeSelect use the SVG spinner of Button as their default loading icon, instead of the `pi-spin` icon class.\n- PickList: moving items sets `source` and `target` to new arrays and emits `sourceChange`/`targetChange`, so `[(source)]`/`[(target)]` bindings follow.\n- TreeTable: the selection change can fire once per intermediate step while a checkbox propagates.\n- DatePicker: the `data-date` attribute of day cells uses a 1-based month.\n- AutoFocus: the native `autofocus` attribute is only rendered when autofocus is on; Button and the other components no longer carry it by default.\n\n### Overlays and menus\n\n- Overlays are placed against the viewport without its scrollbars, so an overlay at the right edge no longer goes under the vertical scrollbar.\n- Tooltip honours the global `overlayAppendTo` option.\n- TieredMenu: with `autoDisplay`, submenus open on hover from the start, without a first click. A popup TieredMenu gives the focus back to its trigger when an item is picked.\n- ContextMenu: showing a context menu closes any other one that is open.\n- ConfirmPopup: an `accepticon`/`rejecticon` template replaces the `acceptIcon`/`rejectIcon` class instead of rendering next to it, as in ConfirmDialog.\n\n### Accessibility markup\n\n- Stepper: the `tablist` role is on `p-step-list`. Splitter: the `separator` role is on the focusable gutter handle.\n- FocusTrap sentinels are no longer `aria-hidden`. ConfirmDialog no longer puts a `role` on the `p-dialog` host.\n- Table announces keyboard column and row moves through the new `aria.columnMoved` and `aria.rowMoved` translation keys. A custom `aria` translation without them falls back to English.\n\n### Theming and display\n\n- A token overridden under `colorScheme.light` wins over the preset's top-level token, as it already did in dark mode. A top-level override passed to `definePreset`, `updatePreset` or `usePreset` still wins.\n- MeterGroup: meter widths use the exact percentage; labels keep the rounded value.\n- ToggleSwitch has no `size` input any more: it had no effect.",
|
|
44634
|
+
"examples": null
|
|
44635
|
+
},
|
|
44636
|
+
{
|
|
44637
|
+
"id": "types",
|
|
44638
|
+
"label": "Type changes",
|
|
44639
|
+
"description": "Some types now describe what the components actually emit or accept. Code that relied on the old types may need a cast or a narrower check.\n\n- Table `onFilter`: `filters` is typed `FilterMetadata | FilterMetadata[]`.\n- TreeTable `TreeTableLazyLoadEvent`: `first` is a `number` and `last` an optional `number`, as in `TableLazyLoadEvent`.\n- CascadeSelect: `options` is typed as an array, and the value accepts an object.\n- Dialog and ConfirmDialog: `pt.root` is typed as the options of the root element.\n- Chart `onDataSelect` emits the new exported `ChartDataSelectEvent` type.\n- `Confirmation` accepts `draggable`, and DatePicker `hourFormat` also accepts a number.",
|
|
44640
|
+
"examples": null
|
|
44641
|
+
},
|
|
44642
|
+
{
|
|
44643
|
+
"id": "checklist",
|
|
44644
|
+
"label": "Checklist",
|
|
44645
|
+
"description": "- Angular 22 installed, and `ng update` (or `--migrate-only --from=3.0.0`) run on a clean working tree.\n- Every place listed in the migration report handled.\n- The project compiles: inputs are read with a call, two-way properties written with `.set()`, removed TypeScript API replaced.\n- No `styleClass`, removed input or `pt*` alias left in templates: `validate_usage` of the MCP server can check this.\n- Screens that change data bound to a component show the change: new arrays and objects, or signals, rather than in-place mutation.\n- Behavior changes reviewed against your tests and screenshots.\n- Signal Forms, if you adopt them: a required field shows as invalid before any interaction, because `[invalid]` cannot be bound next to `[formField]`. A fix is planned in a v22 minor release.",
|
|
44646
|
+
"examples": null
|
|
44376
44647
|
}
|
|
44377
44648
|
]
|
|
44378
44649
|
},
|
|
@@ -44383,27 +44654,27 @@
|
|
|
44383
44654
|
"description": "How to contribute to ExhaustiveUI.",
|
|
44384
44655
|
"sections": [
|
|
44385
44656
|
{
|
|
44386
|
-
"id": "
|
|
44387
|
-
"label": "
|
|
44388
|
-
"description": "
|
|
44657
|
+
"id": "introduction",
|
|
44658
|
+
"label": "Introduction",
|
|
44659
|
+
"description": "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.\n\n### Development Setup\n\nTo begin with, clone the ExhaustiveUI repository from GitHub:\n\n```typescript\ngit clone https://github.com/e-xiste/exhaustive-ui.git\ncd exhaustive-ui\n```\n\nThen run the documentation app in your local environment at `http://localhost:4200/`.\n\n```typescript\npnpm install\npnpm run dev\n```\n\n### Project Structure\n\nExhaustiveUI's project structure is organized as follows:\n\n```typescript\n- apps\n - docs // this documentation website\n - tailwind-playgrounds // Tailwind integration sandboxes\n- packages\n - core // components, directives and services\n - themes // built-in theme presets\n - styled // styled-mode theming engine\n - styles // base styles\n - tailwindcss // Tailwind CSS plugin\n - locale // i18n locales\n - motion // animation utilities\n - utils // shared helpers\n```",
|
|
44389
44660
|
"examples": null
|
|
44390
44661
|
},
|
|
44391
44662
|
{
|
|
44392
44663
|
"id": "helpneeded",
|
|
44393
|
-
"label": "
|
|
44394
|
-
"description": "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
|
|
44664
|
+
"label": "Help Needed",
|
|
44665
|
+
"description": "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:\n\n### Issue Triage\n\nHelp us manage issues by;\n\n- Reproducing reported bugs\n- Clarifying issue descriptions\n- Tagging issues with appropriate labels\n\n### Sending Pull Requests\n\nWe encourage you to send pull requests, especially for issues tagged with the `help-needed` label.\n\n### Community Support\n\nAssist other users by participating in the issue tracker and [GitHub discussions](https://github.com/e-xiste/exhaustive-ui/discussions). Your expertise can help others solve\nproblems and improve their experience with ExhaustiveUI.",
|
|
44395
44666
|
"examples": null
|
|
44396
44667
|
},
|
|
44397
44668
|
{
|
|
44398
|
-
"id": "
|
|
44399
|
-
"label": "
|
|
44400
|
-
"description": "ExhaustiveUI
|
|
44669
|
+
"id": "pathway",
|
|
44670
|
+
"label": "Pathway",
|
|
44671
|
+
"description": "ExhaustiveUI offers an organization structure involving contributors and the core team:\n\n### Contributor Role\n\nAfter 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.\n\n### Committer Role\n\nIf 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.",
|
|
44401
44672
|
"examples": null
|
|
44402
44673
|
},
|
|
44403
44674
|
{
|
|
44404
|
-
"id": "
|
|
44405
|
-
"label": "
|
|
44406
|
-
"description": "
|
|
44675
|
+
"id": "benefits",
|
|
44676
|
+
"label": "Benefits",
|
|
44677
|
+
"description": "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\nyourself as a professional.",
|
|
44407
44678
|
"examples": null
|
|
44408
44679
|
}
|
|
44409
44680
|
]
|