@exhaustive-ui/mcp 22.0.0-alpha.3 → 22.0.0-alpha.4

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
@@ -40,7 +40,7 @@
40
40
  {
41
41
  "id": "dynamic",
42
42
  "label": "Dynamic",
43
- "description": "AccordionPanel can be generated dynamically using the standard @for block.",
43
+ "description": "AccordionPanel can be generated dynamically using the standard @for block.",
44
44
  "examples": {
45
45
  "typescript": "import { Component } from '@angular/core';\nimport { AccordionModule } from '@exhaustive-ui/core/accordion';\n\n@Component({\n template: `\n <div class=\"card\">\n <p-accordion [value]=\"['0']\">\n @for (tab of tabs; track tab.title) {\n <p-accordion-panel [value]=\"tab.value\">\n <p-accordion-header>{{ tab.title }}</p-accordion-header>\n <p-accordion-content>\n <p class=\"m-0\">{{ tab.content }}</p>\n </p-accordion-content>\n </p-accordion-panel>\n }\n </p-accordion>\n </div>\n `,\n standalone: true,\n imports: [AccordionModule]\n})\nexport class AccordionDynamicDemo {\n tabs: any[];\n}"
46
46
  }
@@ -598,7 +598,7 @@
598
598
  {
599
599
  "id": "objects",
600
600
  "label": "Objects",
601
- "description": "AutoComplete can also work with objects using the optionLabel property that defines the label to display as a suggestion. The value passed to the model would still be the object instance of a suggestion. Here is an example with a Country object that has name and code fields such as &#123;name: \"United States\", code:\"USA\"&#125; .",
601
+ "description": "AutoComplete can also work with objects using the optionLabel property that defines the label to display as a suggestion. The value passed to the model would still be the object instance of a suggestion. Here is an example with a Country object that has name and code fields such as {name: \"United States\", code:\"USA\"} .",
602
602
  "examples": {
603
603
  "typescript": "import { Component, OnInit, inject } from '@angular/core';\nimport { FormsModule } from '@angular/forms';\nimport { AutoCompleteModule } from '@exhaustive-ui/core/autocomplete';\nimport { CountryService } from '@/service/countryservice';\nimport { Country } from '@/domain/customer';\n\ninterface AutoCompleteCompleteEvent {\n originalEvent: Event;\n query: string;\n}\n\n@Component({\n template: `\n <div class=\"card flex justify-center\">\n <p-autocomplete [(ngModel)]=\"selectedCountry\" [suggestions]=\"filteredCountries\" (completeMethod)=\"filterCountry($event)\" optionLabel=\"name\" />\n </div>\n `,\n standalone: true,\n imports: [AutoCompleteModule, FormsModule],\n providers: [CountryService]\n})\nexport class AutocompleteObjectsDemo implements OnInit {\n private countryService = inject(CountryService);\n countries: any[] | undefined;\n selectedCountry: any;\n filteredCountries: any[] | undefined;\n\n ngOnInit() {\n this.countryService.getCountries().then((countries) => {\n this.countries = countries;\n });\n }\n\n filterCountry(event: AutoCompleteCompleteEvent) {\n let filtered: any[] = [];\n let query = event.query;\n \n for (let i = 0; i < (this.countries as any[]).length; i++) {\n let country = (this.countries as any[])[i];\n if (country.name.toLowerCase().indexOf(query.toLowerCase()) == 0) {\n filtered.push(country);\n }\n }\n \n this.filteredCountries = filtered;\n }\n}"
604
604
  }
@@ -9333,7 +9333,7 @@
9333
9333
  {
9334
9334
  "id": "format",
9335
9335
  "label": "Format",
9336
- "description": "Default date format is mm/dd/yy which can be customized using the dateFormat property. Following options can be a part of the format. d - day of month (no leading zero) dd - day of month (two digit) o - day of the year (no leading zeros) oo - day of the year (three digit) D - day name short DD - day name long m - month of year (no leading zero) mm - month of year (two digit) M - month name short MM - month name long y - year (two digit) yy - year (four digit) &#64; - Unix timestamp (ms since 01/01/1970) ! - Windows ticks (100ns since 01/01/0001) '...' - literal text '' - single quote anything else - literal text",
9336
+ "description": "Default date format is mm/dd/yy which can be customized using the dateFormat property. Following options can be a part of the format. d - day of month (no leading zero) dd - day of month (two digit) o - day of the year (no leading zeros) oo - day of the year (three digit) D - day name short DD - day name long m - month of year (no leading zero) mm - month of year (two digit) M - month name short MM - month name long y - year (two digit) yy - year (four digit) @ - Unix timestamp (ms since 01/01/1970) ! - Windows ticks (100ns since 01/01/0001) '...' - literal text '' - single quote anything else - literal text",
9337
9337
  "examples": {
9338
9338
  "typescript": "import { Component } from '@angular/core';\nimport { FormsModule } from '@angular/forms';\nimport { DatePickerModule } from '@exhaustive-ui/core/datepicker';\n\n@Component({\n template: `\n <div class=\"card flex justify-center\">\n <p-datepicker [(ngModel)]=\"date\" dateFormat=\"dd.mm.yy\" />\n </div>\n `,\n standalone: true,\n imports: [DatePickerModule, FormsModule]\n})\nexport class DatepickerFormatDemo {\n date: Date | undefined;\n}"
9339
9339
  }
@@ -18837,7 +18837,7 @@
18837
18837
  {
18838
18838
  "id": "dragdrop",
18839
18839
  "label": "dragdrop-doc",
18840
- "description": "Items can be reordered using drag and drop by enabling dragdrop property. Depends on &#64;angular/cdk package.",
18840
+ "description": "Items can be reordered using drag and drop by enabling dragdrop property. Depends on @angular/cdk package.",
18841
18841
  "examples": {
18842
18842
  "typescript": "import { Component, OnInit } from '@angular/core';\nimport { FormsModule } from '@angular/forms';\nimport { ListboxModule } from '@exhaustive-ui/core/listbox';\n\n@Component({\n template: `\n <div class=\"card flex justify-center\">\n <p-listbox [options]=\"cities\" [(ngModel)]=\"selectedCity\" optionLabel=\"name\" [dragdrop]=\"true\" class=\"w-full md:w-56\" />\n </div>\n `,\n standalone: true,\n imports: [ListboxModule, FormsModule]\n})\nexport class ListboxDragdropDemo implements OnInit {\n cities!: any[];\n selectedCity!: any;\n\n ngOnInit() {\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 }\n}"
18843
18843
  }
@@ -19804,7 +19804,7 @@
19804
19804
  {
19805
19805
  "id": "mcp",
19806
19806
  "label": "MCP Server",
19807
- "description": "&#64;exhaustive-ui/mcp is a Model Context Protocol server that gives coding agents such as Claude Code, Cursor, Claude Desktop, VS Code Copilot and Codex tools to query this documentation instead of guessing from PrimeNG memory: list and search components, read a component's docs and API, fetch a complete code example, read the setup guides, and validate an Angular template against the compiled API (unknown inputs or outputs, invalid literal values, unsupported two-way bindings, deprecated inputs, PrimeNG imports and selectors). The server reads the files described on this page from the live site, so it always reflects the deployed documentation without reinstalling the package, and keeps them in memory for 15 minutes. A snapshot of the same files is bundled in the package and used when the network is unavailable. Register it with Claude Code: Or add it to the MCP configuration of your client ( .cursor/mcp.json , claude_desktop_config.json , .vscode/mcp.json with a servers key, ...): The server exposes the list , search , get_component , get_guide , get_example , get_setup , validate_usage and version tools, the Markdown files of this page as MCP resources, and prompts for the usual tasks (use a component, build a form, theme a component, migrate from PrimeNG, audit usage). Set EXHAUSTIVE_UI_DOCS_URL to read another deployment of the docs, for instance a local ng serve , and EXHAUSTIVE_UI_MCP_OFFLINE=1 to only use the bundled snapshot. The package README lists every option.",
19807
+ "description": "@exhaustive-ui/mcp is a Model Context Protocol server that gives coding agents such as Claude Code, Cursor, Claude Desktop, VS Code Copilot and Codex tools to query this documentation instead of guessing from PrimeNG memory: list and search components, read a component's docs and API, fetch a complete code example, read the setup guides, and validate an Angular template against the compiled API (unknown inputs or outputs, invalid literal values, unsupported two-way bindings, deprecated inputs, PrimeNG imports and selectors). The server reads the files described on this page from the live site, so it always reflects the deployed documentation without reinstalling the package, and keeps them in memory for 15 minutes. A snapshot of the same files is bundled in the package and used when the network is unavailable. Register it with Claude Code: Or add it to the MCP configuration of your client ( .cursor/mcp.json , claude_desktop_config.json , .vscode/mcp.json with a servers key, ...): The server exposes the list , search , get_component , get_guide , get_example , get_setup , validate_usage and version tools, the Markdown files of this page as MCP resources, and prompts for the usual tasks (use a component, build a form, theme a component, migrate from PrimeNG, audit usage). Set EXHAUSTIVE_UI_DOCS_URL to read another deployment of the docs, for instance a local ng serve , and EXHAUSTIVE_UI_MCP_OFFLINE=1 to only use the bundled snapshot. The package README lists every option.",
19808
19808
  "examples": null
19809
19809
  }
19810
19810
  ],
@@ -23851,7 +23851,7 @@
23851
23851
  {
23852
23852
  "id": "dragdrop",
23853
23853
  "label": "dragdrop-doc",
23854
- "description": "Items can be reordered using drag and drop by enabling dragdrop property. Depends on &#64;angular/cdk package.",
23854
+ "description": "Items can be reordered using drag and drop by enabling dragdrop property. Depends on @angular/cdk package.",
23855
23855
  "examples": {
23856
23856
  "typescript": "import { Component, OnInit, inject, signal } from '@angular/core';\nimport { OrderListModule } from '@exhaustive-ui/core/orderlist';\nimport { ProductService } from '@/service/productservice';\nimport { Product } from '@/domain/product';\n\n@Component({\n template: `\n <div class=\"card sm:flex sm:justify-center\">\n <p-orderlist [value]=\"products()\" dataKey=\"id\" [dragdrop]=\"true\" [responsive]=\"true\" breakpoint=\"575px\" scrollHeight=\"20rem\">\n <ng-template let-option let-selected=\"selected\" #item>\n <div class=\"flex flex-wrap p-1 items-center gap-4 w-full\">\n <img class=\"w-12 shrink-0 rounded\" src=\"https://exhaustive-ui.com/demo/product/{{ option.image }}\" [alt]=\"option.name\" />\n <div class=\"flex-1 flex flex-col\">\n <span class=\"font-medium text-sm\">{{ option.name }}</span>\n <span\n [ngClass]=\"{\n 'text-sm': true,\n 'text-surface-500': !selected,\n 'dark:text-surface-400': !selected,\n 'text-inherit': selected\n }\"\n >{{ option.category }}</span\n >\n </div>\n <span class=\"font-bold sm:ml-8\">{{ '$' + option.price }}</span>\n </div>\n </ng-template>\n </p-orderlist>\n </div>\n `,\n standalone: true,\n imports: [OrderListModule],\n providers: [ProductService]\n})\nexport class OrderlistDragdropDemo implements OnInit {\n private productService = inject(ProductService);\n products = signal<Product[]>([]);\n\n ngOnInit() {\n this.productService.getProductsSmall().then((cars) => {\n this.products.set(cars);\n });\n }\n\n getSeverity(status: string) {\n switch (status) {\n case 'INSTOCK':\n return 'success';\n case 'LOWSTOCK':\n return 'warning';\n case 'OUTOFSTOCK':\n return 'danger';\n }\n }\n}"
23857
23857
  }
@@ -27018,7 +27018,7 @@
27018
27018
  {
27019
27019
  "id": "basic",
27020
27020
  "label": "Basic",
27021
- "description": "PickList is used as a controlled input with source and target properties. Content of a list item needs to be defined with the item template that receives an object in the list as parameter. Drag & drop functionality depends on &#64;angular/cdk package.",
27021
+ "description": "PickList is used as a controlled input with source and target properties. Content of a list item needs to be defined with the item template that receives an object in the list as parameter. Drag & drop functionality depends on @angular/cdk package.",
27022
27022
  "examples": {
27023
27023
  "typescript": "import { Component, OnInit, inject, signal } from '@angular/core';\nimport { PickListModule } from '@exhaustive-ui/core/picklist';\nimport { ProductService } from '@/service/productservice';\nimport { Product } from '@/domain/product';\n\n@Component({\n template: `\n <div class=\"card\">\n <p-picklist [source]=\"sourceProducts()\" [target]=\"targetProducts()\" [dragdrop]=\"true\" [responsive]=\"true\" breakpoint=\"1400px\">\n <ng-template let-item #item>\n {{ item.name }}\n </ng-template>\n </p-picklist>\n </div>\n `,\n standalone: true,\n imports: [PickListModule],\n providers: [ProductService]\n})\nexport class PicklistBasicDemo implements OnInit {\n private productService = inject(ProductService);\n sourceProducts = signal<Product[]>([]);\n targetProducts = signal<Product[]>([]);\n\n ngOnInit() {\n this.carService.getProductsSmall().then((products) => {\n this.sourceProducts.set(products);\n });\n }\n}"
27024
27024
  }
@@ -33678,7 +33678,7 @@
33678
33678
  {
33679
33679
  "id": "toggleclass",
33680
33680
  "label": "Toggle Class",
33681
- "description": "StyleClass has two modes, toggleClass to simply add-remove a class and enter/leave animations. The target element to change the styling is defined with the selector property that accepts any valid CSS selector or keywords including &#64;next , prev , parent , grandparent",
33681
+ "description": "StyleClass has two modes, toggleClass to simply add-remove a class and enter/leave animations. The target element to change the styling is defined with the selector property that accepts any valid CSS selector or keywords including @next , prev , parent , grandparent",
33682
33682
  "examples": {
33683
33683
  "typescript": "import { Component } from '@angular/core';\nimport { ButtonModule } from '@exhaustive-ui/core/button';\nimport { InputTextModule } from '@exhaustive-ui/core/inputtext';\n\n@Component({\n template: `\n <div class=\"card flex flex-col items-center\">\n <p-button label=\"Toggle Display\" pStyleClass=\"@next\" toggleClass=\"hidden\" />\n <input type=\"text\" pInputText class=\"hidden mt-4\" />\n </div>\n `,\n standalone: true,\n imports: [ButtonModule, InputTextModule]\n})\nexport class StyleclassToggleclassDemo {}"
33684
33684
  }
@@ -35312,7 +35312,7 @@
35312
35312
  {
35313
35313
  "id": "dynamic",
35314
35314
  "label": "Dynamic",
35315
- "description": "Tabs can be generated dynamically using the standard &#64;for block.",
35315
+ "description": "Tabs can be generated dynamically using the standard @for block.",
35316
35316
  "examples": {
35317
35317
  "typescript": "import { Component, OnInit } from '@angular/core';\nimport { TabsModule } from '@exhaustive-ui/core/tabs';\n\n@Component({\n template: `\n <div class=\"card\">\n <p-tabs value=\"0\">\n <p-tablist>\n @for (tab of tabs; track tab.value) {\n <p-tab [value]=\"tab.value\">{{ tab.title }}</p-tab>\n }\n </p-tablist>\n <p-tabpanels>\n @for (tab of tabs; track tab.value) {\n <p-tabpanel [value]=\"tab.value\">\n <p class=\"m-0\">{{ tab.content }}</p>\n </p-tabpanel>\n }\n </p-tabpanels>\n </p-tabs>\n </div>\n `,\n standalone: true,\n imports: [TabsModule]\n})\nexport class TabsDynamicDemo implements OnInit {\n ngOnInit() {\n this.tabs = [\n { title: 'Tab 1', value: '0', content: 'Tab 1 Content' },\n { title: 'Tab 2', value: '1', content: 'Tab 2 Content' },\n { title: 'Tab 3', value: '2', content: 'Tab 3 Content' }\n ];\n }\n}"
35318
35318
  }
@@ -42866,62 +42866,62 @@
42866
42866
  "description": "Setting up ExhaustiveUI in an Angular CLI project.",
42867
42867
  "sections": [
42868
42868
  {
42869
- "id": "download-",
42870
- "label": "Download-",
42869
+ "id": "download",
42870
+ "label": "Download",
42871
42871
  "description": "Prefer to wire things up yourself? Install the packages from the npm registry directly. The next section covers the provider setup that ng add would have written for you.",
42872
42872
  "examples": {
42873
42873
  "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"
42874
42874
  }
42875
42875
  },
42876
42876
  {
42877
- "id": "examples-",
42878
- "label": "Examples-",
42877
+ "id": "examples",
42878
+ "label": "Examples",
42879
42879
  "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.",
42880
42880
  "examples": null
42881
42881
  },
42882
42882
  {
42883
- "id": "icons-",
42884
- "label": "Icons-",
42885
- "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-&#123;icon&#125; classes from OpenNG Icons , and component defaults such as the DatePicker arrows reference them too. Install it if you want the demos to look the way they do here. Then import the stylesheet, either from your global stylesheet or from the styles array in angular.json .",
42883
+ "id": "icons",
42884
+ "label": "Icons",
42885
+ "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 OpenNG Icons , and component defaults such as the DatePicker arrows reference them too. Install it if you want the demos to look the way they do here. Then import the stylesheet, either from your global stylesheet or from the styles array in angular.json .",
42886
42886
  "examples": null
42887
42887
  },
42888
42888
  {
42889
- "id": "nextsteps-",
42890
- "label": "Nextsteps-",
42889
+ "id": "nextsteps",
42890
+ "label": "Nextsteps",
42891
42891
  "description": "Once you have ExhaustiveUI up and running, we recommend exploring the following resources to gain a deeper understanding of the library. Global configuration Styled mode and unstyled mode Tailwind CSS integration Pass Through for direct access to the underlying elements Philosophy — what this project promises, and what it does not FAQ",
42892
42892
  "examples": null
42893
42893
  },
42894
42894
  {
42895
- "id": "ngadd-",
42896
- "label": "Ngadd-",
42897
- "description": "The recommended way to add ExhaustiveUI to an Angular CLI workspace is a single command. The schematic asks which theme preset you want and then does the rest: adds &#64;exhaustive-ui/core and &#64;exhaustive-ui/themes to your dependencies wires provideExhaustive into your root providers with the chosen preset, in app.config.ts or your root NgModule installs the packages Pass the preset up front to skip the prompt, or skip the install step if you want to run it yourself: If the schematic cannot find a providers array to update it prints the three manual steps instead of guessing, so nothing in your workspace is rewritten unexpectedly. If it detects an existing primeng dependency it changes nothing and fails with an error rather than reporting success, and points you at the migration guide , which covers the migrate-from-primeng schematic. It does not run that schematic for you. The Angular CLI installs &#64;exhaustive-ui/core before the schematic runs, so the dependency stays in your package.json — the migration schematic needs it there.",
42895
+ "id": "ngadd",
42896
+ "label": "Ngadd",
42897
+ "description": "The recommended way to add ExhaustiveUI to an Angular CLI workspace is a single command. The schematic asks which theme preset you want and then does the rest: adds @exhaustive-ui/core and @exhaustive-ui/themes to your dependencies wires provideExhaustive into your root providers with the chosen preset, in app.config.ts or your root NgModule installs the packages Pass the preset up front to skip the prompt, or skip the install step if you want to run it yourself: If the schematic cannot find a providers array to update it prints the three manual steps instead of guessing, so nothing in your workspace is rewritten unexpectedly. If it detects an existing primeng dependency it changes nothing and fails with an error rather than reporting success, and points you at the migration guide , which covers the migrate-from-primeng schematic. It does not run that schematic for you. The Angular CLI installs @exhaustive-ui/core before the schematic runs, so the dependency stays in your package.json — the migration schematic needs it there.",
42898
42898
  "examples": {
42899
42899
  "command": "ng add @exhaustive-ui/core"
42900
42900
  }
42901
42901
  },
42902
42902
  {
42903
- "id": "prerequisites-",
42904
- "label": "Prerequisites-",
42905
- "description": "ExhaustiveUI v22 targets Angular v22. Any workspace created with the Angular CLI works, standalone or NgModule based. Angular v22, including &#64;angular/cdk , &#64;angular/forms and &#64;angular/router RxJS v7.8.1 or newer A package manager of your choice — npm, yarn or pnpm Already using PrimeNG? Do not follow this page. The migration guide covers moving an existing PrimeNG v21 workspace, once updated to Angular v22, across with the migrate-from-primeng schematic, which is a separate command from the ng add below.",
42903
+ "id": "prerequisites",
42904
+ "label": "Prerequisites",
42905
+ "description": "ExhaustiveUI v22 targets Angular v22. Any workspace created with the Angular CLI works, standalone or NgModule based. Angular v22, including @angular/cdk , @angular/forms and @angular/router RxJS v7.8.1 or newer A package manager of your choice — npm, yarn or pnpm Already using PrimeNG? Do not follow this page. The migration guide covers moving an existing PrimeNG v21 workspace, once updated to Angular v22, across with the migrate-from-primeng schematic, which is a separate command from the ng add below.",
42906
42906
  "examples": null
42907
42907
  },
42908
42908
  {
42909
- "id": "provider-",
42910
- "label": "Provider-",
42909
+ "id": "provider",
42910
+ "label": "Provider",
42911
42911
  "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.",
42912
42912
  "examples": {
42913
42913
  "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};"
42914
42914
  }
42915
42915
  },
42916
42916
  {
42917
- "id": "verify-",
42918
- "label": "Verify-",
42917
+ "id": "verify",
42918
+ "label": "Verify",
42919
42919
  "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 corresponding component.",
42920
42920
  "examples": null
42921
42921
  },
42922
42922
  {
42923
- "id": "versioncompatibility-",
42924
- "label": "Versioncompatibility-",
42923
+ "id": "versioncompatibility",
42924
+ "label": "Versioncompatibility",
42925
42925
  "description": "Each ExhaustiveUI major targets a single Angular major. Install the version matching your workspace, and see the update guide when moving to a newer one.",
42926
42926
  "examples": null
42927
42927
  }
@@ -42934,32 +42934,32 @@
42934
42934
  "description": "Application wide configuration for ExhaustiveUI.",
42935
42935
  "sections": [
42936
42936
  {
42937
- "id": "csp-",
42938
- "label": "Csp-",
42937
+ "id": "csp",
42938
+ "label": "Csp",
42939
42939
  "description": "The nonce value to use on dynamically generated style elements in core.",
42940
42940
  "examples": {
42941
42941
  "typescript": "provideExhaustive({\n csp: {\n nonce: '...'\n }\n})"
42942
42942
  }
42943
42943
  },
42944
42944
  {
42945
- "id": "dynamic-",
42946
- "label": "Dynamic-",
42945
+ "id": "dynamic",
42946
+ "label": "Dynamic",
42947
42947
  "description": "Inject the Exhaustive to your application to update the initial configuration at runtime.",
42948
42948
  "examples": {
42949
42949
  "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}"
42950
42950
  }
42951
42951
  },
42952
42952
  {
42953
- "id": "filtermode-",
42954
- "label": "Filtermode-",
42953
+ "id": "filtermode",
42954
+ "label": "Filtermode",
42955
42955
  "description": "Default filter modes to display on DataTable filter menus.",
42956
42956
  "examples": {
42957
42957
  "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}"
42958
42958
  }
42959
42959
  },
42960
42960
  {
42961
- "id": "inputvariant-",
42962
- "label": "Inputvariant-",
42961
+ "id": "inputvariant",
42962
+ "label": "Inputvariant",
42963
42963
  "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 variant.",
42964
42964
  "examples": null
42965
42965
  },
@@ -42972,7 +42972,7 @@
42972
42972
  {
42973
42973
  "id": "locale/repository",
42974
42974
  "label": "Repository",
42975
- "description": "Ready to use settings for locales are available as the &#64;exhaustive-ui/locale package, maintained in the ExhaustiveUI repository. We'd appreciate if you could contribute translations to the repository and share them with the rest of the community.",
42975
+ "description": "Ready to use settings for locales are available as the @exhaustive-ui/locale package, maintained in the ExhaustiveUI repository. We'd appreciate if you could contribute translations to the repository and share them with the rest of the community.",
42976
42976
  "examples": {
42977
42977
  "typescript": "import { de } from '@exhaustive-ui/locale/js/de.js';\n\nprovideExhaustive({\n translation: de\n})"
42978
42978
  }
@@ -42994,38 +42994,38 @@
42994
42994
  }
42995
42995
  },
42996
42996
  {
42997
- "id": "overlayappendto-",
42998
- "label": "Overlayappendto-",
42997
+ "id": "overlayappendto",
42998
+ "label": "Overlayappendto",
42999
42999
  "description": "Defines the default location of the overlays; self refers to the host element and body targets the document body. Defaults to self .",
43000
43000
  "examples": null
43001
43001
  },
43002
43002
  {
43003
- "id": "provider-",
43004
- "label": "Provider-",
43003
+ "id": "provider",
43004
+ "label": "Provider",
43005
43005
  "description": "The initial configuration is defined by the provideExhaustive provider during application startup.",
43006
43006
  "examples": {
43007
43007
  "typescript": "import { ApplicationConfig } from '@angular/core';\nimport { provideAnimationsAsync } from '@angular/platform-browser/animations/async';\nimport { provideExhaustive } from '@exhaustive-ui/core/config';\n\nexport const appConfig: ApplicationConfig = {\n providers: [\n provideAnimationsAsync(),\n provideExhaustive({ /* options */ })\n ]\n};"
43008
43008
  }
43009
43009
  },
43010
43010
  {
43011
- "id": "ripple-",
43012
- "label": "Ripple-",
43011
+ "id": "ripple",
43012
+ "label": "Ripple",
43013
43013
  "description": "Ripple is an optional animation for the supported components such as buttons. It is disabled by default.",
43014
43014
  "examples": {
43015
43015
  "typescript": "provideExhaustive({\n ripple: true\n})"
43016
43016
  }
43017
43017
  },
43018
43018
  {
43019
- "id": "theme-",
43020
- "label": "Theme-",
43019
+ "id": "theme",
43020
+ "label": "Theme",
43021
43021
  "description": "ExhaustiveUI provides 4 predefined themes out of the box; Aura, Material, Lara and Nora. See the theming documentation for details.",
43022
43022
  "examples": {
43023
43023
  "typescript": "import { ApplicationConfig } from '@angular/core';\nimport { provideAnimationsAsync } from '@angular/platform-browser/animations/async';\nimport { provideExhaustive } from '@exhaustive-ui/core/config';\n\nimport Aura from '@exhaustive-ui/themes/aura';\n\nexport const appConfig: ApplicationConfig = {\n providers: [\n provideAnimationsAsync(),\n provideExhaustive({\n theme: {\n preset: Aura,\n options: {\n prefix: 'p',\n darkModeSelector: 'system',\n cssLayer: false\n }\n }\n })\n ]\n};"
43024
43024
  }
43025
43025
  },
43026
43026
  {
43027
- "id": "zindex-",
43028
- "label": "Zindex-",
43027
+ "id": "zindex",
43028
+ "label": "Zindex",
43029
43029
  "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 layout where header section is fixed. In a case like this, dropdown needs to be displayed below the application header but a modal dialog should be displayed above. ExhaustiveUI configuration offers the zIndex property to customize the default values for components categories. Default values are described below and can be customized when setting up ExhaustiveUI.",
43030
43030
  "examples": {
43031
43031
  "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}"
@@ -43040,172 +43040,172 @@
43040
43040
  "description": "Choose from a variety of pre-styled themes or develop your own.",
43041
43041
  "sections": [
43042
43042
  {
43043
- "id": "architecture-",
43044
- "label": "Architecture-",
43043
+ "id": "architecture",
43044
+ "label": "Architecture",
43045
43045
  "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 parts; base and preset . The base is the style rules with CSS variables as placeholders whereas the preset is a set of design tokens to feed a base by mapping the tokens to CSS variables. A base may be configured with different presets, currently Aura, Material, Lara and Nora are the available built-in options. The core of the styled mode architecture is based on a concept named design token , a preset defines the token configuration in 3 tiers; primitive , semantic and component . Primitive Tokens Primitive tokens have no context, a color palette is a good example for a primitive token such as blue-50 to blue-900 . A token named blue-500 may be used as the primary color, the background of a message however on its own, the name of the token does not indicate context. Usually they are utilized by the semantic tokens. Semantic Tokens Semantic tokens define content and their names indicate where they are utilized, a well known example of a semantic token is the primary.color . Semantic tokens map to primitive tokens or other semantic tokens. The colorScheme token group is a special variable to define tokens based on the color scheme active in the application, this allows defining different tokens based on the color scheme like dark mode. Component Tokens Component tokens are isolated tokens per component such as inputtext.background or button.color that map to the semantic tokens. As an example, button.background component token maps to the primary.color semantic token which maps to the green.500 primitive token. Best Practices Use primitive tokens when defining the core color palette and semantic tokens to specify the common design elements such as focus ring, primary colors and surfaces. Components tokens should only be used when customizing a specific component. By defining your own design tokens as a custom preset, you'll be able to define your own style without touching CSS. Overriding the ExhaustiveUI components using style classes is not a best practice and should be the last resort, design tokens are the suggested approach.",
43046
43046
  "examples": null
43047
43047
  },
43048
43048
  {
43049
- "id": "bootstrap-",
43050
- "label": "Bootstrap-",
43049
+ "id": "bootstrap",
43050
+ "label": "Bootstrap",
43051
43051
  "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.",
43052
43052
  "examples": null
43053
43053
  },
43054
43054
  {
43055
- "id": "colors-",
43056
- "label": "Colors-",
43055
+ "id": "colors",
43056
+ "label": "Colors",
43057
43057
  "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. @for (color of colors; track color) { {{ color }} @for (shade of shades; track shade) { {{ shade }} } }",
43058
43058
  "examples": null
43059
43059
  },
43060
43060
  {
43061
- "id": "colorscheme-",
43062
- "label": "Colorscheme-",
43061
+ "id": "colorscheme",
43062
+ "label": "Colorscheme",
43063
43063
  "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. Common Pitfall When customizing an existing preset, your token overrides may be ignored if you don't properly account for color scheme variations. If the original preset defines a token using the colorScheme property, but your customization only provides a direct value, your override will be ignored because the colorScheme property takes precedence over direct values and the system will continue using the preset's scheme-specific values. When customizing tokens that are not defined with colorScheme in the original preset, your customizations will be applied successfully regardless of how you structure them; whether direct or under colorScheme. Best Practices Check how tokens are defined in the preset before customizing from the source . Always maintain the same structure (direct value or colorScheme) as the original preset. Consider both light and dark mode values when overriding scheme-dependent tokens. This approach ensures your customizations will be applied correctly regardless of the user's selected color scheme.",
43064
43064
  "examples": null
43065
43065
  },
43066
43066
  {
43067
- "id": "component-",
43068
- "label": "Component-",
43067
+ "id": "component",
43068
+ "label": "Component",
43069
43069
  "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. This configuration is global and applies to all card components, in case you need to customize a particular component on a page locally, view the Scoped CSS section for an example.",
43070
43070
  "examples": null
43071
43071
  },
43072
43072
  {
43073
- "id": "darkmode-",
43074
- "label": "Darkmode-",
43073
+ "id": "darkmode",
43074
+ "label": "Darkmode",
43075
43075
  "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 .my-app-dark so that ExhaustiveUI can fit in seamlessly with your color scheme. Following is a very basic example implementation of a dark mode switch, you may extend it further by involving prefers-color-scheme to retrieve it from the system initially and use localStorage to make it stateful. See this article for more information. In case you prefer to use dark mode all the time, apply the darkModeSelector initially and never change it. It is also possible to disable dark mode completely using false or none as the value of the selector.",
43076
43076
  "examples": null
43077
43077
  },
43078
43078
  {
43079
- "id": "definepreset-",
43080
- "label": "Definepreset-",
43079
+ "id": "definepreset",
43080
+ "label": "Definepreset",
43081
43081
  "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.",
43082
43082
  "examples": null
43083
43083
  },
43084
43084
  {
43085
- "id": "dt-",
43086
- "label": "Dt-",
43085
+ "id": "dt",
43086
+ "label": "Dt",
43087
43087
  "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.",
43088
43088
  "examples": null
43089
43089
  },
43090
43090
  {
43091
- "id": "extend-",
43092
- "label": "Extend-",
43091
+ "id": "extend",
43092
+ "label": "Extend",
43093
43093
  "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 default tokens. The example preset configuration adds a new accent button with custom button.accent.color and button.accent.inverse.color tokens. It is also possible to add tokens globally to share them within the components.",
43094
43094
  "examples": null
43095
43095
  },
43096
43096
  {
43097
- "id": "focusring-",
43098
- "label": "Focusring-",
43097
+ "id": "focusring",
43098
+ "label": "Focusring",
43099
43099
  "description": "Focus ring defines the outline width, style, color and offset. Let's use a thicker ring with the primary color for the outline.",
43100
43100
  "examples": null
43101
43101
  },
43102
43102
  {
43103
- "id": "font-",
43104
- "label": "Font-",
43103
+ "id": "font",
43104
+ "label": "Font",
43105
43105
  "description": "There is no design for fonts as UI components inherit their font settings from the application.",
43106
43106
  "examples": null
43107
43107
  },
43108
43108
  {
43109
- "id": "forms-",
43110
- "label": "Forms-",
43109
+ "id": "forms",
43110
+ "label": "Forms",
43111
43111
  "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 dropdown.hover.border.color and textarea.hover.border.color would receive the change.",
43112
43112
  "examples": null
43113
43113
  },
43114
43114
  {
43115
- "id": "libraries-",
43116
- "label": "Libraries-",
43115
+ "id": "libraries",
43116
+ "label": "Libraries",
43117
43117
  "description": "Example layer configuration for the popular CSS libraries.",
43118
43118
  "examples": null
43119
43119
  },
43120
43120
  {
43121
- "id": "noir-",
43122
- "label": "Noir-",
43121
+ "id": "noir",
43122
+ "label": "Noir",
43123
43123
  "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 primary color;",
43124
43124
  "examples": null
43125
43125
  },
43126
43126
  {
43127
- "id": "options-",
43128
- "label": "Options-",
43127
+ "id": "options",
43128
+ "label": "Options",
43129
43129
  "description": "The options property defines the how the CSS would be generated from the design tokens of the preset. prefix The prefix of the CSS variables, defaults to p . For instance, the primary.color design token would be var(--p-primary-color) . darkModeSelector The CSS rule to encapsulate the CSS variables of the dark mode, the default is the system to generate {{ '@' }}media (prefers-color-scheme: dark) . If you need to make the dark mode toggleable based on the user selection define a class selector such as .app-dark and toggle this class at the document root. See the dark mode toggle section for an example. cssLayer Defines whether the styles should be defined inside a CSS layer by default or not. A CSS layer would be handy to declare a custom cascade layer for easier customization if necessary. The default is false .",
43130
43130
  "examples": null
43131
43131
  },
43132
43132
  {
43133
- "id": "palette-",
43134
- "label": "Palette-",
43133
+ "id": "palette",
43134
+ "label": "Palette",
43135
43135
  "description": "Returns shades and tints of a given color from 50 to 950 as an array.",
43136
43136
  "examples": null
43137
43137
  },
43138
43138
  {
43139
- "id": "presets-",
43140
- "label": "Presets-",
43139
+ "id": "presets",
43140
+ "label": "Presets",
43141
43141
  "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 and Nora is inspired by enterprise applications. Visit the source code to learn more about the structure of presets. You may use them out of the box with modifications or utilize them as reference in case you need to build your own presets from scratch.",
43142
43142
  "examples": null
43143
43143
  },
43144
43144
  {
43145
- "id": "primary-",
43146
- "label": "Primary-",
43145
+ "id": "primary",
43146
+ "label": "Primary",
43147
43147
  "description": "The primary defines the main color palette, default value maps to the emerald primitive token. Let's setup to use indigo instead.",
43148
43148
  "examples": null
43149
43149
  },
43150
43150
  {
43151
- "id": "reset-",
43152
- "label": "Reset-",
43151
+ "id": "reset",
43152
+ "label": "Reset",
43153
43153
  "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 and defining the layer order. This way, your Reset CSS does not get in the way of ExhaustiveUI components.",
43154
43154
  "examples": null
43155
43155
  },
43156
43156
  {
43157
- "id": "scale-",
43158
- "label": "Scale-",
43157
+ "id": "scale",
43158
+ "label": "Scale",
43159
43159
  "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 14px as the base so it may differ from your application if your base font size is different.",
43160
43160
  "examples": null
43161
43161
  },
43162
43162
  {
43163
- "id": "scopedtokens-",
43164
- "label": "Scopedtokens-",
43163
+ "id": "scopedtokens",
43164
+ "label": "Scopedtokens",
43165
43165
  "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. This approach is recommended over the ::ng-deep as it offers a cleaner API while avoiding the hassle of CSS rule overrides.",
43166
43166
  "examples": null
43167
43167
  },
43168
43168
  {
43169
- "id": "specificity-",
43170
- "label": "Specificity-",
43171
- "description": "The &#64;layer is a standard CSS feature to define cascade layers for a customizable order of precedence. If you need to become more familiar with layers, visit the documentation at MDN to begin with. The cssLayer is disabled by default, when it is enabled at theme configuration, ExhaustiveUI wraps the built-in style classes under the exhaustive cascade layer to make the library styles easy to override. CSS in your app without a layer has the highest CSS specificity, so you'll be able to override styles regardless of the location or how strong a class is written.",
43169
+ "id": "specificity",
43170
+ "label": "Specificity",
43171
+ "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 MDN to begin with. The cssLayer is disabled by default, when it is enabled at theme configuration, ExhaustiveUI wraps the built-in style classes under the exhaustive cascade layer to make the library styles easy to override. CSS in your app without a layer has the highest CSS specificity, so you'll be able to override styles regardless of the location or how strong a class is written.",
43172
43172
  "examples": null
43173
43173
  },
43174
43174
  {
43175
- "id": "surface-",
43176
- "label": "Surface-",
43175
+ "id": "surface",
43176
+ "label": "Surface",
43177
43177
  "description": "The color scheme palette that varies between light and dark modes is specified with the surface tokens. Example below uses zinc for light mode and slategray for dark mode. With this setting, light mode, would have a grayscale tone and dark mode would include bluish tone.",
43178
43178
  "examples": null
43179
43179
  },
43180
43180
  {
43181
- "id": "theme-",
43182
- "label": "Theme-",
43181
+ "id": "theme",
43182
+ "label": "Theme",
43183
43183
  "description": "The theme property is used to customize the initial theme.",
43184
43184
  "examples": {
43185
43185
  "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};"
43186
43186
  }
43187
43187
  },
43188
43188
  {
43189
- "id": "updatepreset-",
43190
- "label": "Updatepreset-",
43189
+ "id": "updatepreset",
43190
+ "label": "Updatepreset",
43191
43191
  "description": "Merges the provided tokens to the current preset, an example would be changing the primary color palette dynamically.",
43192
43192
  "examples": null
43193
43193
  },
43194
43194
  {
43195
- "id": "updateprimarypalette-",
43196
- "label": "Updateprimarypalette-",
43195
+ "id": "updateprimarypalette",
43196
+ "label": "Updateprimarypalette",
43197
43197
  "description": "Updates the primary colors, this is a shorthand to do the same update using updatePreset .",
43198
43198
  "examples": null
43199
43199
  },
43200
43200
  {
43201
- "id": "updatesurfacepalette-",
43202
- "label": "Updatesurfacepalette-",
43201
+ "id": "updatesurfacepalette",
43202
+ "label": "Updatesurfacepalette",
43203
43203
  "description": "Updates the surface colors, this is a shorthand to do the same update using updatePreset .",
43204
43204
  "examples": null
43205
43205
  },
43206
43206
  {
43207
- "id": "usepreset-",
43208
- "label": "Usepreset-",
43207
+ "id": "usepreset",
43208
+ "label": "Usepreset",
43209
43209
  "description": "Replaces the current presets entirely, common use case is changing the preset dynamically at runtime.",
43210
43210
  "examples": null
43211
43211
  }
@@ -43218,28 +43218,28 @@
43218
43218
  "description": "Theming ExhaustiveUI with alternative styling approaches.",
43219
43219
  "sections": [
43220
43220
  {
43221
- "id": "architecture-",
43222
- "label": "Architecture-",
43221
+ "id": "architecture",
43222
+ "label": "Architecture",
43223
43223
  "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 included. Here is an example of an Unstyled Select, the core functionality and accessibility is provided whereas styling is not included.",
43224
43224
  "examples": null
43225
43225
  },
43226
43226
  {
43227
- "id": "example-",
43228
- "label": "Example-",
43227
+ "id": "example",
43228
+ "label": "Example",
43229
43229
  "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 variants such as p-outlined: , p-vertical for the ExhaustiveUI components. The example below demonstrates how to style a button component with Tailwind CSS using PassThrough attributes. Before you begin, refer to the pass through section in the button documentation to familiarize yourself with the component's internal structure and PassThrough attributes. In this example, we'll target the root , label and icon elements to apply custom styles.",
43230
43230
  "examples": null
43231
43231
  },
43232
43232
  {
43233
- "id": "global-",
43234
- "label": "Global-",
43233
+ "id": "global",
43234
+ "label": "Global",
43235
43235
  "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 with its own pt property.",
43236
43236
  "examples": {
43237
43237
  "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};"
43238
43238
  }
43239
43239
  },
43240
43240
  {
43241
- "id": "setup-",
43242
- "label": "Setup-",
43241
+ "id": "setup",
43242
+ "label": "Setup",
43243
43243
  "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.",
43244
43244
  "examples": null
43245
43245
  }
@@ -43252,56 +43252,56 @@
43252
43252
  "description": "OpenNG Icons is the default icon library of ExhaustiveUI with over 250 open source icons.",
43253
43253
  "sections": [
43254
43254
  {
43255
- "id": "basic-",
43256
- "label": "Basic-",
43257
- "description": "OpenNG Icons use the pi pi-&#123;icon&#125; syntax such as pi pi-check . A standalone icon can be displayed using an element such as i or span",
43255
+ "id": "basic",
43256
+ "label": "Basic",
43257
+ "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",
43258
43258
  "examples": null
43259
43259
  },
43260
43260
  {
43261
- "id": "color-",
43262
- "label": "Color-",
43261
+ "id": "color",
43262
+ "label": "Color",
43263
43263
  "description": "Icon color is defined with the color property which is inherited from parent by default.",
43264
43264
  "examples": null
43265
43265
  },
43266
43266
  {
43267
- "id": "constants-",
43268
- "label": "Constants-",
43267
+ "id": "constants",
43268
+ "label": "Constants",
43269
43269
  "description": "Constants API is available to reference icons easily when used programmatically.",
43270
43270
  "examples": {
43271
43271
  "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}"
43272
43272
  }
43273
43273
  },
43274
43274
  {
43275
- "id": "download-",
43276
- "label": "Download-",
43275
+ "id": "download",
43276
+ "label": "Download",
43277
43277
  "description": "The icon library is available at npm, run the following command to download it to your project.",
43278
43278
  "examples": {
43279
43279
  "command": "npm install @openng/icons"
43280
43280
  }
43281
43281
  },
43282
43282
  {
43283
- "id": "import-",
43284
- "label": "Import-",
43283
+ "id": "import",
43284
+ "label": "Import",
43285
43285
  "description": "CSS file of the icon library needs to be imported in styles.scss of your application.",
43286
43286
  "examples": {
43287
43287
  "scss": "@import \"@openng/icons/openng-icons.css\";"
43288
43288
  }
43289
43289
  },
43290
43290
  {
43291
- "id": "list-",
43292
- "label": "List-",
43291
+ "id": "list",
43292
+ "label": "List",
43293
43293
  "description": "Here is the full list of icons. More icons will be added periodically and you may also request new icons at the issue tracker.",
43294
43294
  "examples": null
43295
43295
  },
43296
43296
  {
43297
- "id": "size-",
43298
- "label": "Size-",
43297
+ "id": "size",
43298
+ "label": "Size",
43299
43299
  "description": "Size of an icon is controlled with the font-size property of the element.",
43300
43300
  "examples": null
43301
43301
  },
43302
43302
  {
43303
- "id": "spin-",
43304
- "label": "Spin-",
43303
+ "id": "spin",
43304
+ "label": "Spin",
43305
43305
  "description": "Special pi-spin class applies infinite rotation to an icon.",
43306
43306
  "examples": null
43307
43307
  }
@@ -43314,26 +43314,26 @@
43314
43314
  "description": "Use custom icons with ExhaustiveUI components.",
43315
43315
  "sections": [
43316
43316
  {
43317
- "id": "fontawesome-",
43318
- "label": "Fontawesome-",
43317
+ "id": "fontawesome",
43318
+ "label": "Fontawesome",
43319
43319
  "description": "Font Awesome is a popular icon library with a wide range of icons.",
43320
43320
  "examples": null
43321
43321
  },
43322
43322
  {
43323
- "id": "image-",
43324
- "label": "Image-",
43323
+ "id": "image",
43324
+ "label": "Image",
43325
43325
  "description": "Any type of image can be used as an icon.",
43326
43326
  "examples": null
43327
43327
  },
43328
43328
  {
43329
- "id": "material-",
43330
- "label": "Material-",
43329
+ "id": "material",
43330
+ "label": "Material",
43331
43331
  "description": "Material icons is the official icon library based on Google Material Design.",
43332
43332
  "examples": null
43333
43333
  },
43334
43334
  {
43335
- "id": "svg-",
43336
- "label": "Svg-",
43335
+ "id": "svg",
43336
+ "label": "Svg",
43337
43337
  "description": "Inline SVGs are embedded inside the dom.",
43338
43338
  "examples": null
43339
43339
  }
@@ -43346,44 +43346,44 @@
43346
43346
  "description": "Pass Through Props allow direct access to the underlying elements for complete customization.",
43347
43347
  "sections": [
43348
43348
  {
43349
- "id": "basic-",
43350
- "label": "Basic-",
43349
+ "id": "basic",
43350
+ "label": "Basic",
43351
43351
  "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 arbitrary properties to apply to the element such as styling, aria, data-* or custom attributes. If the value is a string or a function that returns a string, it is considered as a class definition and added to the class attribute of the element. Every component documentation has a dedicated section to document the available section names exposed via PT.",
43352
43352
  "examples": null
43353
43353
  },
43354
43354
  {
43355
- "id": "global-",
43356
- "label": "Global-",
43355
+ "id": "global",
43356
+ "label": "Global",
43357
43357
  "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 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.",
43358
43358
  "examples": null
43359
43359
  },
43360
43360
  {
43361
- "id": "instance-",
43362
- "label": "Instance-",
43361
+ "id": "instance",
43362
+ "label": "Instance",
43363
43363
  "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.",
43364
43364
  "examples": null
43365
43365
  },
43366
43366
  {
43367
- "id": "introduction-",
43368
- "label": "Introduction-",
43367
+ "id": "introduction",
43368
+ "label": "Introduction",
43369
43369
  "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 the API, the component author needs to develop and publish it with a new release. The pass through feature is a key element to implement this vision by exposing the component internals in order to apply arbitrary attributes and listeners to the DOM elements. The primary advantage of this approach is that it frees you from being restricted by the main component API. We recommend considering the pass-through feature whenever you need to tailor a component that lacks a built-in feature for your specific requirement. Each component has a special pt property to define an object with keys corresponding to the available DOM elements. A value of a key can either be a string, an object or a function to define the arbitrary properties such as styling, aria, data-* or custom attributes for the element. If the value is a string or a function that returns a string, it serves as a shorthand for a style class definition. Every component documentation has a dedicated segment to document the available section names in the interactive PT Viewer. Panel Example In this example, a Panel is customized with various options through pt . The styling is overriden with Tailwind CSS and header receives custom attributes along with a click event. The attributes passed to the header are not available in the component API, thanks to PassThrough feature, this is no longer an issue as you are not limited to the component api. Note that, you may avoid the ! based overrides in Tailwind classes if you setup CSS Layers with ExhaustiveUI. Visit the Override section at Tailwind integration for examples.",
43370
43370
  "examples": null
43371
43371
  },
43372
43372
  {
43373
- "id": "lifecycle-",
43374
- "label": "Lifecycle-",
43373
+ "id": "lifecycle",
43374
+ "label": "Lifecycle",
43375
43375
  "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 , onAfterContentInit , onAfterContentChecked , onAfterViewInit , onAfterViewChecked and onDestroy . Refer to the Angular documentation for detailed information about lifecycle hooks.",
43376
43376
  "examples": null
43377
43377
  },
43378
43378
  {
43379
- "id": "pcprefix-",
43380
- "label": "Pcprefix-",
43379
+ "id": "pcprefix",
43380
+ "label": "Pcprefix",
43381
43381
  "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 indicating the necessity for a nested structure. For example, the badge section is identified as pcBadge because the button component incorporates the badge component internally.",
43382
43382
  "examples": null
43383
43383
  },
43384
43384
  {
43385
- "id": "ptoptions-",
43386
- "label": "Ptoptions-",
43385
+ "id": "ptoptions",
43386
+ "label": "Ptoptions",
43387
43387
  "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. The mergeSections defines whether the sections from the main configuration gets added and the mergeProps controls whether to override or merge the defined props. Defaults are true for mergeSections and false for mergeProps . Global Configuration mergeSections: true, mergeProps: false (default) mergeSections: true, mergeProps: true mergeSections: false, mergeProps: true mergeSections: false, mergeProps: false",
43388
43388
  "examples": null
43389
43389
  }
@@ -43396,56 +43396,64 @@
43396
43396
  "description": "Integration between ExhaustiveUI and Tailwind CSS.",
43397
43397
  "sections": [
43398
43398
  {
43399
- "id": "animations-",
43400
- "label": "Animations-",
43399
+ "id": "animations",
43400
+ "label": "Animations",
43401
43401
  "description": "The plugin also adds extended animation utilities that can be used with the styleclass and animateonscroll directives.",
43402
- "examples": null
43402
+ "examples": {
43403
+ "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}"
43404
+ }
43403
43405
  },
43404
43406
  {
43405
- "id": "colorpalette-",
43406
- "label": "Colorpalette-",
43407
+ "id": "colorpalette",
43408
+ "label": "Colorpalette",
43407
43409
  "description": "ExhaustiveUI color palette as utility classes.",
43408
- "examples": null
43410
+ "examples": {
43411
+ "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 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}"
43412
+ }
43409
43413
  },
43410
43414
  {
43411
- "id": "darkmode-",
43412
- "label": "Darkmode-",
43415
+ "id": "darkmode",
43416
+ "label": "Darkmode",
43413
43417
  "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 dark variant for seamless integration. Note that, this particular configuration isn't required if you're utilizing the default system color scheme. Suppose that, the darkModeSelector is set as my-app-dark in ExhaustiveUI. Tailwind v4 Add a custom variant for dark with a custom selector. Tailwind v3 Use the plugins option in your Tailwind config file to configure the plugin.",
43414
43418
  "examples": null
43415
43419
  },
43416
43420
  {
43417
- "id": "extensions-",
43418
- "label": "Extensions-",
43421
+ "id": "extensions",
43422
+ "label": "Extensions",
43419
43423
  "description": "The plugin extends the default configuration with a new set of utilities. All variants and breakpoints are supported e.g. dark:sm:hover:bg-primary . Color Palette Class Property primary-[50-950] Primary color palette. surface-[0-950] Surface color palette. primary Default primary color. primary-contrast Default primary contrast color. primary-emphasis Default primary emphasis color. border-surface Default primary emphasis color. bg-emphasis Emphasis background e.g. hovered element. bg-highlight Highlight background. bg-highlight-emphasis Highlight background with emphasis. rounded-border Border radius. text-color Text color with emphasis. text-color-emphasis Default primary emphasis color. text-muted-color Secondary text color. text-muted-color-emphasis Secondary text color with emphasis.",
43420
43424
  "examples": null
43421
43425
  },
43422
43426
  {
43423
- "id": "form-",
43424
- "label": "Form-",
43427
+ "id": "form",
43428
+ "label": "Form",
43425
43429
  "description": "Using Tailwind utilities for the responsive layout of a form with ExhaustiveUI components.",
43426
- "examples": null
43430
+ "examples": {
43431
+ "typescript": "import { Component, OnInit } from '@angular/core';\nimport { FormsModule } from '@angular/forms';\nimport { DatePickerModule } from '@exhaustive-ui/core/datepicker';\nimport { SelectModule } from '@exhaustive-ui/core/select';\nimport { InputTextModule } from '@exhaustive-ui/core/inputtext';\nimport { Country } from '@/domain/customer';\n\n@Component({\n template: `\n <div class=\"card flex sm:justify-center\">\n <div class=\"flex flex-col gap-6 w-full sm:w-auto\">\n <div class=\"flex flex-col sm:flex-row sm:items-center gap-6\">\n <div class=\"flex-auto\">\n <label for=\"firstname\" class=\"block font-semibold mb-2\">Firstname</label>\n <input type=\"text\" pInputText id=\"firstname\" class=\"w-full\" />\n </div>\n <div class=\"flex-auto\">\n <label for=\"lastname\" class=\"block font-semibold mb-2\">Lastname</label>\n <input type=\"text\" pInputText id=\"lastname\" class=\"w-full\" />\n </div>\n </div>\n <div class=\"flex flex-col sm:flex-row sm:items-center gap-6\">\n <div class=\"flex-1\">\n <label for=\"date\" class=\"block font-semibold mb-2\">Date</label>\n <p-datepicker inputId=\"date\" class=\"w-full\" />\n </div>\n <div class=\"flex-1\">\n <label for=\"country\" class=\"block font-semibold mb-2\">Country</label>\n <p-select [options]=\"countries\" [(ngModel)]=\"selectedCountry\" optionLabel=\"name\" [showClear]=\"true\" placeholder=\"Select a Country\">\n <ng-template pTemplate=\"selectedItem\">\n <div class=\"flex items-center gap-2\" *ngIf=\"selectedCountry\">\n <img src=\"https://exhaustive-ui.com/demo/flag/flag_placeholder.png\" [class]=\"'flag flag-' + selectedCountry.code.toLowerCase()\" style=\"width: 18px\" />\n <div>{{ selectedCountry.name }}</div>\n </div>\n </ng-template>\n <ng-template let-country pTemplate=\"item\">\n <div class=\"flex items-center gap-2\">\n <img src=\"https://exhaustive-ui.com/demo/flag/flag_placeholder.png\" [class]=\"'flag flag-' + country.code.toLowerCase()\" style=\"width: 18px\" />\n <div>{{ country.name }}</div>\n </div>\n </ng-template>\n </p-select>\n </div>\n </div>\n <div class=\"flex-auto\">\n <label for=\"message\" class=\"block font-semibold mb-2\">Message</label>\n <textarea pTextarea id=\"message\" class=\"w-full\" rows=\"4\"></textarea>\n </div>\n </div>\n </div>\n `,\n standalone: true,\n imports: [DatePickerModule, SelectModule, InputTextModule, FormsModule]\n})\nexport class TailwindFormDemo implements OnInit {\n countries: any[] | undefined;\n selectedCountry: string | undefined;\n\n ngOnInit() {\n this.countries = [\n { name: 'Australia', code: 'AU' },\n { name: 'Brazil', code: 'BR' },\n { name: 'China', code: 'CN' },\n { name: 'Egypt', code: 'EG' },\n { name: 'France', code: 'FR' },\n { name: 'Germany', code: 'DE' },\n { name: 'India', code: 'IN' },\n { name: 'Japan', code: 'JP' },\n { name: 'Spain', code: 'ES' },\n { name: 'United States', code: 'US' }\n ];\n }\n}"
43432
+ }
43427
43433
  },
43428
43434
  {
43429
- "id": "headless-",
43430
- "label": "Headless-",
43435
+ "id": "headless",
43436
+ "label": "Headless",
43431
43437
  "description": "A headless ExhaustiveUI dialog with a custom UI.",
43432
- "examples": null
43438
+ "examples": {
43439
+ "typescript": "import { Component } from '@angular/core';\nimport { ButtonModule } from '@exhaustive-ui/core/button';\nimport { DialogModule } from '@exhaustive-ui/core/dialog';\nimport { InputTextModule } from '@exhaustive-ui/core/inputtext';\n\n@Component({\n template: `\n <div class=\"card flex justify-center\">\n <p-button (click)=\"showDialog()\" icon=\"pi pi-user\" label=\"Login\" />\n <p-dialog maskStyleClass=\"backdrop-blur-sm\" [(visible)]=\"visible\" styleClass=\"!border-0 !bg-transparent\">\n <ng-template pTemplate=\"headless\">\n <div class=\"flex flex-col px-8 py-8 gap-6 rounded-2xl\" style=\"border-radius: 12px; background-image: radial-gradient(circle at left top, var(--p-primary-400), var(--p-primary-700))\">\n <svg width=\"31\" height=\"33\" viewBox=\"0 0 31 33\" fill=\"none\" xmlns=\"http://www.w3.org/2000/svg\" class=\"block mx-auto\">\n <path d=\"M15.1934 0V0V0L0.0391235 5.38288L2.35052 25.3417L15.1934 32.427V32.427V32.427L28.0364 25.3417L30.3478 5.38288L15.1934 0Z\" fill=\"var(--p-primary-color)\" />\n <mask id=\"mask0_1_52\" style=\"mask-type:luminance\" maskUnits=\"userSpaceOnUse\" x=\"0\" y=\"0\" width=\"31\" height=\"33\">\n <path d=\"M15.1934 0V0V0L0.0391235 5.38288L2.35052 25.3417L15.1934 32.427V32.427V32.427L28.0364 25.3417L30.3478 5.38288L15.1934 0Z\" fill=\"var(--ground-background)\" />\n </mask>\n <g mask=\"url(#mask0_1_52)\">\n <path fill-rule=\"evenodd\" clip-rule=\"evenodd\" d=\"M15.1935 0V3.5994V3.58318V20.0075V20.0075V32.427V32.427L28.0364 25.3417L30.3478 5.38288L15.1935 0Z\" fill=\"var(--p-primary-color)\" />\n </g>\n <path d=\"M19.6399 15.3776L18.1861 15.0547L19.3169 16.6695V21.6755L23.1938 18.4458V12.9554L21.4169 13.6013L19.6399 15.3776Z\" fill=\"var(--ground-background)\" />\n <path d=\"M10.5936 15.3776L12.0474 15.0547L10.9166 16.6695V21.6755L7.03966 18.4458V12.9554L8.81661 13.6013L10.5936 15.3776Z\" fill=\"var(--ground-background)\" />\n <path\n fill-rule=\"evenodd\"\n clip-rule=\"evenodd\"\n d=\"M11.3853 16.9726L12.6739 15.0309L13.4793 15.5163H16.7008L17.5061 15.0309L18.7947 16.9726V24.254L17.8283 25.7103L16.7008 26.843H13.4793L12.3518 25.7103L11.3853 24.254V16.9726Z\"\n fill=\"var(--ground-background)\"\n />\n <path d=\"M19.3168 24.7437L21.4168 22.6444V20.5451L19.3168 22.3214V24.7437Z\" fill=\"var(--ground-background)\" />\n <path d=\"M10.9166 24.7437L8.81662 22.6444V20.5451L10.9166 22.3214V24.7437Z\" fill=\"var(--ground-background)\" />\n <path\n fill-rule=\"evenodd\"\n clip-rule=\"evenodd\"\n d=\"M13.0167 5.68861L11.7244 8.7568L13.8244 14.8932H14.7936V5.68861H13.0167ZM15.4397 5.68861V14.8932H16.5706L18.5091 8.7568L17.2167 5.68861H15.4397Z\"\n fill=\"var(--ground-background)\"\n />\n <path d=\"M13.8244 14.8932L6.87813 12.3094L5.90888 8.27235L11.8859 8.7568L13.9859 14.8932H13.8244Z\" fill=\"var(--ground-background)\" />\n <path d=\"M16.5706 14.8932L23.5169 12.3094L24.4861 8.27235L18.3476 8.7568L16.4091 14.8932H16.5706Z\" fill=\"var(--ground-background)\" />\n <path d=\"M18.8321 8.27235L22.2245 7.94938L19.9629 5.68861H17.7013L18.8321 8.27235Z\" fill=\"var(--ground-background)\" />\n <path d=\"M11.4013 8.27235L8.00893 7.94938L10.2705 5.68861H12.5321L11.4013 8.27235Z\" fill=\"var(--ground-background)\" />\n </svg>\n <div class=\"inline-flex flex-col gap-2\">\n <label for=\"username\" class=\"text-primary-50 font-semibold\">Username</label>\n <input pInputText id=\"username\" class=\"!bg-white/20 !border-0 !p-4 !text-primary-50 w-80\" />\n </div>\n <div class=\"inline-flex flex-col gap-2\">\n <label for=\"password\" class=\"text-primary-50 font-semibold\">Password</label>\n <input pInputText id=\"password\" class=\"!bg-white/20 !border-0 !p-4 !text-primary-50 w-80\" type=\"password\" />\n </div>\n <div class=\"flex items-center gap-4\">\n <p-button label=\"Cancel\" (click)=\"closeDialog()\" [text]=\"true\" styleClass=\"!p-4 w-full !text-primary-50 !border !border-white/30 hover:!bg-white/10\" class=\"w-full\" />\n <p-button label=\"Sign-In\" (click)=\"closeDialog()\" [text]=\"true\" styleClass=\"!p-4 w-full !text-primary-50 !border !border-white/30 hover:!bg-white/10\" class=\"w-full\" />\n </div>\n </div>\n </ng-template>\n </p-dialog>\n </div>\n `,\n standalone: true,\n imports: [ButtonModule, DialogModule, InputTextModule]\n})\nexport class TailwindHeadlessDemo {\n visible: boolean = false;\n\n showDialog() {\n this.visible = true;\n }\n\n closeDialog() {\n this.visible = false;\n }\n}"
43440
+ }
43433
43441
  },
43434
43442
  {
43435
- "id": "override-",
43436
- "label": "Override-",
43443
+ "id": "override",
43444
+ "label": "Override",
43437
43445
  "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. Important Use the ! as a prefix to enforce the styling. This is not the recommend approach, and should be used as last resort to avoid adding unnecessary style classes to your bundle. Tailwind v4 Tailwind v3 CSS Layer CSS Layer provides control over the css specificity so that Tailwind utilities can safely override components. Tailwind v4 Ensure exhaustive layer is after theme and base , but before the other Tailwind layers such as utilities . No change in the CSS configuration is required. Tailwind v3 The exhaustive layer should be between base and utilities. Tailwind v3 does not use native layer so needs to be defined with CSS.",
43438
43446
  "examples": null
43439
43447
  },
43440
43448
  {
43441
- "id": "overview-",
43442
- "label": "Overview-",
43449
+ "id": "overview",
43450
+ "label": "Overview",
43443
43451
  "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.",
43444
43452
  "examples": null
43445
43453
  },
43446
43454
  {
43447
- "id": "plugin-",
43448
- "label": "Plugin-",
43455
+ "id": "plugin",
43456
+ "label": "Plugin",
43449
43457
  "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, 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.",
43450
43458
  "examples": null
43451
43459
  }
@@ -43458,43 +43466,43 @@
43458
43466
  "description": "LLM-optimized documentation endpoints for ExhaustiveUI components.",
43459
43467
  "sections": [
43460
43468
  {
43461
- "id": "agentskill-",
43462
- "label": "Agentskill-",
43469
+ "id": "agentskill",
43470
+ "label": "Agentskill",
43463
43471
  "description": "The markdown files above are also bundled as an Agent Skill , the SKILL.md format supported by coding agents such as Claude Code, Codex, Cursor and OpenCode. Once installed, the agent reads the component docs, API tables and guides from disk whenever it works on ExhaustiveUI code, instead of fetching them from this site each time. Install it with the skills CLI , which asks which agents to set it up for. By default the skill is installed into the current project, so your team gets it too. Add -g to install it for your user instead. You can also download the zip and extract it into a folder named exhaustive-ui in your agent's skills directory.",
43464
43472
  "examples": {
43465
43473
  "command": "npx skills add https://exhaustive-ui.com\n\n# update to the latest docs\nnpx skills update exhaustive-ui"
43466
43474
  }
43467
43475
  },
43468
43476
  {
43469
- "id": "llmsfulltxt-",
43470
- "label": "Llmsfulltxt-",
43477
+ "id": "llmsfulltxt",
43478
+ "label": "Llmsfulltxt",
43471
43479
  "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.",
43472
43480
  "examples": null
43473
43481
  },
43474
43482
  {
43475
- "id": "llmstxt-",
43476
- "label": "Llmstxt-",
43483
+ "id": "llmstxt",
43484
+ "label": "Llmstxt",
43477
43485
  "description": "The llms.txt file is an industry standard that helps AI models better understand and navigate the ExhaustiveUI documentation. It lists key pages in a structured format, making it easier for LLMs to retrieve relevant information.",
43478
43486
  "examples": null
43479
43487
  },
43480
43488
  {
43481
- "id": "manifest-",
43482
- "label": "Manifest-",
43489
+ "id": "manifest",
43490
+ "label": "Manifest",
43483
43491
  "description": "/llms/manifest.json describes every component, directive, NgModule, service and exported type as structured data, for tools that need exact facts rather than prose: MCP servers, code generators, linters and design tool integrations. It is generated from the Angular metadata in the compiled library, so selectors and inputs match what the compiler accepts. Each entry point lists its import path, NgModule, services and exported types. Each component or directive lists its selector, inputs with type, allowed values, default, transform and two-way binding, outputs with payload type, templates with their context type, methods, forms support and pass-through keys.",
43484
43492
  "examples": {
43485
43493
  "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}"
43486
43494
  }
43487
43495
  },
43488
43496
  {
43489
- "id": "markdownextension-",
43490
- "label": "Markdownextension-",
43497
+ "id": "markdownextension",
43498
+ "label": "Markdownextension",
43491
43499
  "description": "Add a .md to a page's URL to display a Markdown version of that page.",
43492
43500
  "examples": null
43493
43501
  },
43494
43502
  {
43495
- "id": "mcp-",
43496
- "label": "Mcp-",
43497
- "description": "&#64;exhaustive-ui/mcp is a Model Context Protocol server that gives coding agents such as Claude Code, Cursor, Claude Desktop, VS Code Copilot and Codex tools to query this documentation instead of guessing from PrimeNG memory: list and search components, read a component's docs and API, fetch a complete code example, read the setup guides, and validate an Angular template against the compiled API (unknown inputs or outputs, invalid literal values, unsupported two-way bindings, deprecated inputs, PrimeNG imports and selectors). The server reads the files described on this page from the live site, so it always reflects the deployed documentation without reinstalling the package, and keeps them in memory for 15 minutes. A snapshot of the same files is bundled in the package and used when the network is unavailable. Register it with Claude Code: Or add it to the MCP configuration of your client ( .cursor/mcp.json , claude_desktop_config.json , .vscode/mcp.json with a servers key, ...): The server exposes the list , search , get_component , get_guide , get_example , get_setup , validate_usage and version tools, the Markdown files of this page as MCP resources, and prompts for the usual tasks (use a component, build a form, theme a component, migrate from PrimeNG, audit usage). Set EXHAUSTIVE_UI_DOCS_URL to read another deployment of the docs, for instance a local ng serve , and EXHAUSTIVE_UI_MCP_OFFLINE=1 to only use the bundled snapshot. The package README lists every option.",
43503
+ "id": "mcp",
43504
+ "label": "Mcp",
43505
+ "description": "@exhaustive-ui/mcp is a Model Context Protocol server that gives coding agents such as Claude Code, Cursor, Claude Desktop, VS Code Copilot and Codex tools to query this documentation instead of guessing from PrimeNG memory: list and search components, read a component's docs and API, fetch a complete code example, read the setup guides, and validate an Angular template against the compiled API (unknown inputs or outputs, invalid literal values, unsupported two-way bindings, deprecated inputs, PrimeNG imports and selectors). The server reads the files described on this page from the live site, so it always reflects the deployed documentation without reinstalling the package, and keeps them in memory for 15 minutes. A snapshot of the same files is bundled in the package and used when the network is unavailable. Register it with Claude Code: Or add it to the MCP configuration of your client ( .cursor/mcp.json , claude_desktop_config.json , .vscode/mcp.json with a servers key, ...): The server exposes the list , search , get_component , get_guide , get_example , get_setup , validate_usage and version tools, the Markdown files of this page as MCP resources, and prompts for the usual tasks (use a component, build a form, theme a component, migrate from PrimeNG, audit usage). Set EXHAUSTIVE_UI_DOCS_URL to read another deployment of the docs, for instance a local ng serve , and EXHAUSTIVE_UI_MCP_OFFLINE=1 to only use the bundled snapshot. The package README lists every option.",
43498
43506
  "examples": null
43499
43507
  }
43500
43508
  ]
@@ -43506,38 +43514,38 @@
43506
43514
  "description": "ExhaustiveUI has WCAG 2.1 AA level compliance.",
43507
43515
  "sections": [
43508
43516
  {
43509
- "id": "colors-",
43510
- "label": "Colors-",
43517
+ "id": "colors",
43518
+ "label": "Colors",
43511
43519
  "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. Good Contrast Color contrast between the background and the foreground content should be sufficient enough to ensure readability. Example below displays two cases with good and bad samples. GOOD BAD Vibration Color vibration is leads to an illusion of motion due to choosing colors that have low visibility against each other. Color combinations need to be picked with caution to avoid vibration. VIBRATE Dark Mode Highly saturated colors should be avoided when used within a dark design scheme as they cause eye strain. Instead desaturated colors should be preferred. Indigo 500 Indigo 200",
43512
43520
  "examples": null
43513
43521
  },
43514
43522
  {
43515
- "id": "formcontrols-",
43516
- "label": "Formcontrols-",
43523
+ "id": "formcontrols",
43524
+ "label": "Formcontrols",
43517
43525
  "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 with space key as well to trigger. On the other hand, a fancy css based button using a div has no keyboard or screen reader support. tabindex is required to make a div element accessible in addition to use a keydown to bring the keyboard support back. To avoid the overload and implementing functionality that is already provided by the browser, native form controls should be preferred. Relations Form components must be related to another element that describes what the form element is used for. This is usually achieved with the label element.",
43518
43526
  "examples": null
43519
43527
  },
43520
43528
  {
43521
- "id": "introduction-",
43522
- "label": "Introduction-",
43529
+ "id": "introduction",
43530
+ "label": "Introduction",
43523
43531
  "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 to ensure content can be consumed by anyone. Disabilities Types of disabilities are diverse so you need to know your audience well and how they interact with the content created. There four main categories; Visual Impairments Blindness, low-level vision or color blindness are the common types of visual impairments. Screen magnifiers and the color blind mode are usually built-in features of the browsers whereas for people who rely on screen readers, page developers are required to make sure content is readable by the readers. Popular readers are NVDA , JAWS and ChromeVox . Hearing Impairments Deafness or hearing loss refers to the inability to hear sounds totally or partially. People with hearing impairments use assistive devices however it may not be enough when interacting with a web page. Common implementation is providing textual alternatives, transcripts and captions for content with audio. Mobility Impairments People with mobility impairments have disabilities related to movement due to loss of a limb, paralysis or other varying reasons. Assistive technologies like a head pointer is a device to interact with a screen whereas keyboard or a trackpad remain as solutions for people who are not able to utilize a mouse. Cognitive Impairments Cognitive impairments have a wider range that includes people with learning disabilities, depression and dyslexia. A well designed content also leads to better user experience for people without disabilities so designing for cognitive impairments result in better design for any user.",
43524
43532
  "examples": null
43525
43533
  },
43526
43534
  {
43527
- "id": "semantichtml-",
43528
- "label": "Semantichtml-",
43535
+ "id": "semantichtml",
43536
+ "label": "Semantichtml",
43529
43537
  "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 div elements with classes are used. Consider the following example that do not mean too much for readers. Same layout can be achieved using the semantic elements with screen reader support built-in.",
43530
43538
  "examples": null
43531
43539
  },
43532
43540
  {
43533
- "id": "waiaria-",
43534
- "label": "Waiaria-",
43541
+ "id": "waiaria",
43542
+ "label": "Waiaria",
43535
43543
  "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 a datepicker or colorpicker has been improved over the past years many web developers still utilize UI components derived from standard HTML elements created by them or by other projects like ExhaustiveUI. These types of components must provide keyboard and screen reader support, the latter case is where the WAI-ARIA is utilized. ARIA consists of roles, properties and attributes. Roles define what the element is mainly used for e.g. checkbox , dialog , tablist whereas States and Properties define the metadata of the element like aria-checked , aria-disabled . Consider the following case of a native checkbox. It has built-in keyboard and screen reader support. A fancy checkbox with css animations might look more appealing but accessibility might be lacking. Checkbox below may display a checked font icon with animations however it is not tabbable, cannot be checked with space key and cannot be read by a reader. One alternative is using ARIA roles for readers and use javascript for keyboard support. Notice the usage of aria-labelledby as a replacement of the label tag with for. However the best practice is combining semantic HTML for accessibility while keeping the design for UX. This approach involves hiding a native checkbox for accessibility and using javascript events to update its state. Notice the usage of p-sr-only that hides the elements from the user but not from the screen reader. A working sample is the ExhaustiveUI checkbox that is tabbable, keyboard accessible and is compliant with a screen reader. Instead of ARIA roles it relies on a hidden native checkbox. Remember Me",
43536
43544
  "examples": null
43537
43545
  },
43538
43546
  {
43539
- "id": "wcag-",
43540
- "label": "Wcag-",
43547
+ "id": "wcag",
43548
+ "label": "Wcag",
43541
43549
  "description": "WCAG refers to Web Content Accessibility Guideline , a standard managed by the WAI (Web Accessibility Initiative) of W3C (World Wide Web Consortium). WCAG consists of recommendations for making the web content more accessible. ExhaustiveUI components aim high level of WCAG compliancy in the near future. Various countries around the globe have governmental policies regarding web accessibility as well. Most well known of these are Section 508 in the US and Web Accessibility Directive of the European Union.",
43542
43550
  "examples": null
43543
43551
  }
@@ -43550,38 +43558,38 @@
43550
43558
  "description": "Built-in CSS animations for ExhaustiveUI components.",
43551
43559
  "sections": [
43552
43560
  {
43553
- "id": "anchoredoverlays-",
43554
- "label": "Anchoredoverlays-",
43561
+ "id": "anchoredoverlays",
43562
+ "label": "Anchoredoverlays",
43555
43563
  "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 .p-anchored-overlay-leave-active classes.",
43556
43564
  "examples": null
43557
43565
  },
43558
43566
  {
43559
- "id": "collapsibles-",
43560
- "label": "Collapsibles-",
43567
+ "id": "collapsibles",
43568
+ "label": "Collapsibles",
43561
43569
  "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 .p-collapsible-leave-active classes. Header I Lorem ipsum dolor sit amet, consectetur adipiscing elit, sed do eiusmod tempor incididunt ut labore et dolore magna aliqua. Ut enim ad minim veniam, quis nostrud exercitation ullamco laboris nisi ut aliquip ex ea commodo consequat. Duis aute irure dolor in reprehenderit in voluptate velit esse cillum dolore eu fugiat nulla pariatur. Excepteur sint occaecat cupidatat non proident, sunt in culpa qui officia deserunt mollit anim id est laborum. Header II Sed ut perspiciatis unde omnis iste natus error sit voluptatem accusantium doloremque laudantium, totam rem aperiam, eaque ipsa quae ab illo inventore veritatis et quasi architecto beatae vitae dicta sunt explicabo. Nemo enim ipsam voluptatem quia voluptas sit aspernatur aut odit aut fugit, sed quia consequuntur magni dolores eos qui ratione voluptatem sequi nesciunt. Consectetur, adipisci velit, sed quia non numquam eius modi. Header III Sed ut perspiciatis unde omnis iste natus error sit voluptatem accusantium doloremque laudantium, totam rem aperiam, eaque ipsa quae ab illo inventore veritatis et quasi architecto beatae vitae dicta sunt explicabo. Nemo enim ipsam voluptatem quia voluptas sit aspernatur aut odit aut fugit, sed quia consequuntur magni dolores eos qui ratione voluptatem sequi nesciunt. Consectetur, adipisci velit, sed quia non numquam eius modi.",
43562
43570
  "examples": null
43563
43571
  },
43564
43572
  {
43565
- "id": "dialog-",
43566
- "label": "Dialog-",
43573
+ "id": "dialog",
43574
+ "label": "Dialog",
43567
43575
  "description": "Overlays such as Dialog and Drawer are positioned relative to the viewport and have their own animations. Update your information. Username Email",
43568
43576
  "examples": null
43569
43577
  },
43570
43578
  {
43571
- "id": "disable-",
43572
- "label": "Disable-",
43579
+ "id": "disable",
43580
+ "label": "Disable",
43573
43581
  "description": "Individual animations can be reduced and even disabled completely using the animation duration.",
43574
43582
  "examples": null
43575
43583
  },
43576
43584
  {
43577
- "id": "introduction-",
43578
- "label": "Introduction-",
43579
- "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 default animations, this documentation covers the entire set of built-in animations. Animations are defined using a combination of style classes and keyframes. The ⁠ .&#123;classname&#125;-enter-active and ⁠ .&#123;classname&#125;-leave-active classes specify the animation name, duration, and easing function. You can customize animations globally by overriding the default animation classes, affecting all components. Alternatively, you can apply scoped classes to individual components to modify their animations independently. For demo purposes, this second approach is used throughout the next sections.",
43585
+ "id": "introduction",
43586
+ "label": "Introduction",
43587
+ "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 default animations, this documentation covers the entire set of built-in animations. Animations are defined using a combination of style classes and keyframes. The ⁠ .{classname}-enter-active and ⁠ .{classname}-leave-active classes specify the animation name, duration, and easing function. You can customize animations globally by overriding the default animation classes, affecting all components. Alternatively, you can apply scoped classes to individual components to modify their animations independently. For demo purposes, this second approach is used throughout the next sections.",
43580
43588
  "examples": null
43581
43589
  },
43582
43590
  {
43583
- "id": "reference-",
43584
- "label": "Reference-",
43591
+ "id": "reference",
43592
+ "label": "Reference",
43585
43593
  "description": "List of class names of the CSS animations used by the components. Component Enter Class Leave Class Accordion .p-collapsible-enter-active .p-collapsible-leave-active AutoComplete .p-anchored-overlay-enter-active .p-anchored-overlay-leave-active CascadeSelect .p-anchored-overlay-enter-active .p-anchored-overlay-leave-active ColorPicker .p-anchored-overlay-enter-active .p-anchored-overlay-leave-active ConfirmPopup .p-anchored-overlay-enter-active .p-anchored-overlay-leave-active ContextMenu .p-anchored-overlay-enter-active .p-anchored-overlay-leave-active DatePicker .p-anchored-overlay-enter-active .p-anchored-overlay-leave-active Dialog .p-dialog-enter-active .p-dialog-leave-active Drawer .p-drawer-enter-active .p-drawer-leave-active Fieldset .p-collapsible-enter-active .p-collapsible-leave-active Galleria .p-galleria-enter-active .p-galleria-leave-active Image .p-image-original-enter-active .p-image-original-leave-active Menu .p-anchored-overlay-enter-active .p-anchored-overlay-leave-active Message .p-message-enter-active .p-message-leave-active Modal Masks .p-overlay-mask-enter-active .p-overlay-mask-leave-active MultiSelect .p-anchored-overlay-enter-active .p-anchored-overlay-leave-active Panel .p-collapsible-enter-active .p-collapsible-leave-active PanelMenu .p-collapsible-enter-active .p-collapsible-leave-active Password .p-anchored-overlay-enter-active .p-anchored-overlay-leave-active Select .p-anchored-overlay-enter-active .p-anchored-overlay-leave-active Stepper .p-collapsible-enter-active .p-collapsible-leave-active TieredMenu .p-anchored-overlay-enter-active .p-anchored-overlay-leave-active Toast .p-toast-message-enter-active .p-toast-message-leave-active TreeSelect .p-anchored-overlay-enter-active .p-anchored-overlay-leave-active",
43586
43594
  "examples": null
43587
43595
  }
@@ -43594,14 +43602,14 @@
43594
43602
  "description": "Right-to-left support for ExhaustiveUI components.",
43595
43603
  "sections": [
43596
43604
  {
43597
- "id": "configuration-",
43598
- "label": "Configuration-",
43605
+ "id": "configuration",
43606
+ "label": "Configuration",
43599
43607
  "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 configuration is necessary; setting the document's text direction to RTL is sufficient to enable this feature. The RTL setting can either be set using the dir attribute or with the direction style property.",
43600
43608
  "examples": null
43601
43609
  },
43602
43610
  {
43603
- "id": "limitations-",
43604
- "label": "Limitations-",
43611
+ "id": "limitations",
43612
+ "label": "Limitations",
43605
43613
  "description": "RTL is widely supported by the UI suite except the Galleria and Carousel components. These components will be enhanced with a modern implementation in upcoming versions with built-in support for RTL.",
43606
43614
  "examples": null
43607
43615
  }
@@ -43614,27 +43622,27 @@
43614
43622
  "description": "Moving from PrimeFlex to Tailwind CSS.",
43615
43623
  "sections": [
43616
43624
  {
43617
- "id": "compatibility-",
43618
- "label": "Compatibility-",
43625
+ "id": "compatibility",
43626
+ "label": "Compatibility",
43619
43627
  "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 and is not a supported pairing here. Neither version is tested against ExhaustiveUI releases, so treat this as \"should work\", not as a supported configuration. The migration below is the path we actually maintain.",
43620
43628
  "examples": null
43621
43629
  },
43622
43630
  {
43623
- "id": "migration-",
43624
- "label": "Migration-",
43631
+ "id": "migration",
43632
+ "label": "Migration",
43625
43633
  "description": "PrimeFlex class names map closely onto Tailwind's, so most of the work is mechanical. PrimeTek's primeclt ships a pf2tw command that does the conversion, and it works on any codebase — it rewrites class names and does not care which component library you use. Run pf2tw in a directory containing the files to convert. A handful of PrimeFlex classes have no Tailwind counterpart and are left alone. Replace them with flexbox or grid utilities by hand: formgrid formgroup formgroup-inline col col-fixed field field-checkbox field-radiobutton reset",
43626
43634
  "examples": null
43627
43635
  },
43628
43636
  {
43629
- "id": "overview-",
43630
- "label": "Overview-",
43637
+ "id": "overview",
43638
+ "label": "Overview",
43631
43639
  "description": "PrimeFlex was PrimeTek's lightweight CSS utility library, designed to accompany PrimeNG. PrimeTek stopped maintaining it before the relicensing, on the grounds that most applications already bring their own utility layer — Tailwind, Bootstrap or something in-house — and a second one only overlaps with it. ExhaustiveUI does not maintain PrimeFlex either, and for the same reason. Nothing in this library depends on it, and no component requires it. If your application already uses PrimeFlex it will keep working, but it will not receive updates from us, and we suggest moving to Tailwind CSS.",
43632
43640
  "examples": null
43633
43641
  },
43634
43642
  {
43635
- "id": "tailwindcss-",
43636
- "label": "Tailwindcss-",
43637
- "description": "Tailwind CSS is the replacement we suggest. This documentation site is itself built with it, and we publish &#64;exhaustive-ui/tailwindcss for first-class integration — a plugin that teaches Tailwind about the theme's design tokens and puts the component styles in a cascade layer you can override cleanly. See the Tailwind CSS guide for setup with either Tailwind v3 or v4, and the next section for converting existing PrimeFlex classes.",
43643
+ "id": "tailwindcss",
43644
+ "label": "Tailwindcss",
43645
+ "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 tokens and puts the component styles in a cascade layer you can override cleanly. See the Tailwind CSS guide for setup with either Tailwind v3 or v4, and the next section for converting existing PrimeFlex classes.",
43638
43646
  "examples": null
43639
43647
  }
43640
43648
  ]
@@ -43646,38 +43654,38 @@
43646
43654
  "description": "Why ExhaustiveUI exists, what it commits to, and where it stops.",
43647
43655
  "sections": [
43648
43656
  {
43649
- "id": "governance-",
43650
- "label": "Governance-",
43657
+ "id": "governance",
43658
+ "label": "Governance",
43651
43659
  "description": "Everything happens in the open, in the repository . There is no private roadmap and no internal issue tracker. What you see in the issues, the discussions and the roadmap is the whole plan. Contributors earn commit access by contributing — the contribution guide describes the Contributor and Committer roles and roughly what it takes to reach them. We would rather grow the number of people who can merge a fix than route everything through one person. Breaking changes are avoided within a major and documented when a major requires them. Where we inherited a name that no longer fits — the CSS cascade layer, the package scope, the icon library — we changed it once, at v1, with a migration schematic, rather than dripping renames across releases.",
43652
43660
  "examples": null
43653
43661
  },
43654
43662
  {
43655
- "id": "limits-",
43656
- "label": "Limits-",
43663
+ "id": "limits",
43664
+ "label": "Limits",
43657
43665
  "description": "Naming the limits is what makes the commitments above worth anything. Here is what ExhaustiveUI is not. There is no commercial support No SLA, no support contract, no guaranteed response time. Issues and discussions are answered by volunteers when they have time. If your organisation needs contractual guarantees, this project cannot provide them and you should plan accordingly. There are no premium templates, blocks or design tooling PrimeTek's application templates, block library and visual theme designer are their commercial products. They are not part of what was MIT licensed, so they are not part of this fork and will not be reimplemented. Theming here means editing preset objects in code, which is documented in full. We are not chasing feature parity with PrimeNG v22 and beyond PrimeNG continues under its own license and its own roadmap. ExhaustiveUI diverges from v21 forward. Some things they add, we will not have. Some things we fix, they will not. Treat the two as separate libraries that share an ancestor, not as a free copy of a paid product. The bus factor is real This is maintained by a small group of people in their own time. We would rather say that plainly than imply a larger organisation stands behind it. The best way to change that number is to contribute .",
43658
43666
  "examples": null
43659
43667
  },
43660
43668
  {
43661
- "id": "origin-",
43662
- "label": "Origin-",
43669
+ "id": "origin",
43670
+ "label": "Origin",
43663
43671
  "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 their own announcement , and it is worth reading. Maintaining a component library of this size for a decade, largely for free, is genuinely hard, and we do not think the decision was made lightly. It did, however, leave a lot of applications on a library with no further open source releases. ExhaustiveUI exists for those applications. It is a community fork of the last MIT licensed version of PrimeNG, v21, and it stays MIT. This is not an official fork and it is not endorsed by PrimeTek. It is a separate repository, seeded with PrimeNG's code and history, maintained by people who depend on it.",
43664
43672
  "examples": null
43665
43673
  },
43666
43674
  {
43667
- "id": "promises-",
43668
- "label": "Promises-",
43675
+ "id": "promises",
43676
+ "label": "Promises",
43669
43677
  "description": "Four commitments, in the order we would want to read them if we were choosing a dependency: MIT, with no second tier Every package we publish is MIT licensed. There is no paid edition, no enterprise build, no feature held back behind a subscription, and no plan to introduce one. If that ever changed, it would be a fork of this project rather than a relicensing of it, because the code we inherited is MIT and so is everything we add to it. We track Angular Our release cadence follows Angular's. When a new Angular major lands, the priority is a compatible ExhaustiveUI major — before new features, before refactors. Staying upgradeable is the single most valuable thing a component library can do for the applications built on it. Bugs before features We inherited a large backlog along with the code. Fixing what is broken ranks above adding what is missing. Feature requests are triaged and welcome, but they generally ship when someone in the community implements them. No surprises in your bundle The library sends no telemetry, phones no home, and requires no account or key to use. What you install is what runs.",
43670
43678
  "examples": null
43671
43679
  },
43672
43680
  {
43673
- "id": "sustainability-",
43674
- "label": "Sustainability-",
43681
+ "id": "sustainability",
43682
+ "label": "Sustainability",
43675
43683
  "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 risk we can see today. The things that actually help, roughly in order of impact: Reproducing and triaging issues. A bug with a minimal reproduction is several times more likely to get fixed. Sending pull requests, especially for issues labelled help-needed . Answering questions in discussions, so the same answer is not written five times. Improving this documentation. Every page has a source file and every fix is welcome. Telling your employer you depend on it. Sponsored maintenance time is worth more than any one-off donation. The contribution guide covers how to get started.",
43676
43684
  "examples": null
43677
43685
  },
43678
43686
  {
43679
- "id": "trademark-",
43680
- "label": "Trademark-",
43687
+ "id": "trademark",
43688
+ "label": "Trademark",
43681
43689
  "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 library — is a trademark matter, not a technical one, and it is why we ship a migration schematic rather than asking you to rewrite imports by hand. References to PrimeNG remain throughout this documentation and the source, and they are deliberate. Attribution is the point: this library is PrimeTek's decade of work plus whatever the community adds on top. Pretending otherwise would be both dishonest and useless to anyone trying to find their way around a familiar API. The code we forked was published under the MIT license, and we distribute it under those same terms, with the original copyright notices intact.",
43682
43690
  "examples": null
43683
43691
  }
@@ -43690,31 +43698,73 @@
43690
43698
  "description": "Licensing, migration from PrimeNG, the ecosystem, and how support works.",
43691
43699
  "sections": [
43692
43700
  {
43693
- "id": "ecosystem-",
43694
- "label": "Ecosystem-",
43695
- "description": "Do the PrimeNG themes work? The built-in presets do — Aura, Material, Lara and Nora ship in &#64;exhaustive-ui/themes and are configured the same way. A preset you wrote yourself against PrimeNG v21 will work after the import paths are updated, which the migration schematic handles. What about the Theme Designer, templates and blocks? Those are PrimeTek's commercial products. They were never MIT licensed, so they are not part of this fork and we will not be reimplementing them. Theming in ExhaustiveUI means editing preset objects in code, which is documented in full under styled mode . What replaced PrimeIcons? OpenNG Icons , installed as &#64;openng/icons . The pi pi-&#123;icon&#125; class names are unchanged, so templates do not need editing — only the package name and the stylesheet import, both of which the migration schematic rewrites. What about PrimeFlex? PrimeFlex is not maintained here. We suggest Tailwind CSS instead, and ship &#64;exhaustive-ui/tailwindcss for first-class integration — see the Tailwind guide . The PrimeFlex guide covers moving across. Does ExhaustiveUI work with SSR? This documentation site is itself an Angular SSR application built on ExhaustiveUI, prerendered at build time. So yes, and any regression there tends to be noticed quickly.",
43701
+ "id": "ecosystem",
43702
+ "label": "Ecosystem",
43703
+ "description": "Do the PrimeNG themes work? The built-in presets do — Aura, Material, Lara and Nora ship in @exhaustive-ui/themes and are configured the same way. A preset you wrote yourself against PrimeNG v21 will work after the import paths are updated, which the migration schematic handles. What about the Theme Designer, templates and blocks? Those are PrimeTek's commercial products. They were never MIT licensed, so they are not part of this fork and we will not be reimplementing them. Theming in ExhaustiveUI means editing preset objects in code, which is documented in full under styled mode . What replaced PrimeIcons? OpenNG Icons , installed as @openng/icons . The pi pi-{icon} class names are unchanged, so templates do not need editing — only the package name and the stylesheet import, both of which the migration schematic rewrites. What about PrimeFlex? PrimeFlex is not maintained here. We suggest Tailwind CSS instead, and ship @exhaustive-ui/tailwindcss for first-class integration — see the Tailwind guide . The PrimeFlex guide covers moving across. Does ExhaustiveUI work with SSR? This documentation site is itself an Angular SSR application built on ExhaustiveUI, prerendered at build time. So yes, and any regression there tends to be noticed quickly.",
43696
43704
  "examples": null
43697
43705
  },
43698
43706
  {
43699
- "id": "migration-",
43700
- "label": "Migration-",
43701
- "description": "Which Angular versions are supported? Angular v22: ExhaustiveUI v22 requires Angular v22. Our majors follow Angular's — when a new Angular major ships, a compatible ExhaustiveUI major is the first thing we work on. See the version compatibility table in the update guide. How do I migrate from PrimeNG? Is it automatic? Mostly, but not through ng add , which only sets up new projects and fails without changing anything when it finds an existing primeng dependency. Install &#64;exhaustive-ui/core , then run ng generate &#64;exhaustive-ui/core:migrate-from-primeng in a PrimeNG v21 workspace updated to Angular v22: packages swapped, imports rewritten, dependencies installed. It then prints a report of anything it could not rewrite, with file and line numbers. The migration guide covers the details and the manual cases. I am on PrimeNG v20 or older. Can I migrate directly? No. Upgrade to PrimeNG v21 first, using PrimeNG's own migration guides, then update Angular to v22 and run the schematic. The schematic checks the version and refuses rather than producing a half-migrated workspace. What happens to my PrimeNG license? Nothing — it is unrelated. A PrimeNG v22 commercial license covers PrimeNG. ExhaustiveUI needs no license at all. If you hold a PrimeTek subscription for their templates or theme designer, those remain their products and do not carry over here. I had an open PR on primefaces/primeng. Can I bring it here? Yes, and we would like you to. Append .patch to your original pull request URL and apply it with git am — the contributing guide in the repository walks through it, including what to do when the patch no longer applies cleanly. Can I run PrimeNG and ExhaustiveUI side by side? Technically yes, since the package names and the CSS cascade layer differ, but you will ship two copies of the same components and two theme runtimes. Treat it as a temporary state during migration rather than a supported configuration.",
43707
+ "id": "migration",
43708
+ "label": "Migration",
43709
+ "description": "Which Angular versions are supported? Angular v22: ExhaustiveUI v22 requires Angular v22. Our majors follow Angular's — when a new Angular major ships, a compatible ExhaustiveUI major is the first thing we work on. See the version compatibility table in the update guide. How do I migrate from PrimeNG? Is it automatic? Mostly, but not through ng add , which only sets up new projects and fails without changing anything when it finds an existing primeng dependency. Install @exhaustive-ui/core , then run ng generate @exhaustive-ui/core:migrate-from-primeng in a PrimeNG v21 workspace updated to Angular v22: packages swapped, imports rewritten, dependencies installed. It then prints a report of anything it could not rewrite, with file and line numbers. The migration guide covers the details and the manual cases. I am on PrimeNG v20 or older. Can I migrate directly? No. Upgrade to PrimeNG v21 first, using PrimeNG's own migration guides, then update Angular to v22 and run the schematic. The schematic checks the version and refuses rather than producing a half-migrated workspace. What happens to my PrimeNG license? Nothing — it is unrelated. A PrimeNG v22 commercial license covers PrimeNG. ExhaustiveUI needs no license at all. If you hold a PrimeTek subscription for their templates or theme designer, those remain their products and do not carry over here. I had an open PR on primefaces/primeng. Can I bring it here? Yes, and we would like you to. Append .patch to your original pull request URL and apply it with git am — the contributing guide in the repository walks through it, including what to do when the patch no longer applies cleanly. Can I run PrimeNG and ExhaustiveUI side by side? Technically yes, since the package names and the CSS cascade layer differ, but you will ship two copies of the same components and two theme runtimes. Treat it as a temporary state during migration rather than a supported configuration.",
43702
43710
  "examples": null
43703
43711
  },
43704
43712
  {
43705
- "id": "project-",
43706
- "label": "Project-",
43713
+ "id": "project",
43714
+ "label": "Project",
43707
43715
  "description": "Is ExhaustiveUI free? Will it stay free? Yes, and yes. Every package is MIT licensed, and the code we forked was MIT too, so relicensing it is not something we could do even if we wanted to. There is no paid tier and none is planned. The philosophy page goes into what that does and does not buy you. Is this an official PrimeNG fork? Are you affiliated with PrimeTek? No. ExhaustiveUI is an independent community fork, not affiliated with, endorsed by, or sponsored by PrimeTek. It is a fork of Optimus UI (OpenNG), itself a repository seeded with PrimeNG's MIT licensed code and history, not a fork of the archived primefaces/primeng repository. Which PrimeNG version is this forked from? PrimeNG v21, the last version published under the MIT license, by way of Optimus UI v2. ExhaustiveUI v22 is that codebase, rebranded and migrated to the Angular Signals API, with the fixes that have landed since; its major version number follows Angular's. Who maintains it, and how is it funded? A small group of volunteers, with e-xiste covering hosting and the domain. We are deliberate about not implying more than that — see sustainability for the honest version and the ways that can change. Why did the name change? Trademark, twice over. PrimeNG, PrimeFaces and PrimeFlex are PrimeTek's marks, and Optimus UI is OpenNG's, so the packages and the CSS cascade layer needed a name of their own. That is also why the rename from PrimeNG is handled by a schematic rather than by asking you to rewrite imports by hand.",
43708
43716
  "examples": null
43709
43717
  },
43710
43718
  {
43711
- "id": "support-",
43712
- "label": "Support-",
43719
+ "id": "support",
43720
+ "label": "Support",
43713
43721
  "description": "Is there commercial support? No. There is no SLA, no support contract and no guaranteed response time. Issues and discussions are answered by volunteers when they have time. If your organisation needs contractual guarantees, this project cannot offer them. How do I report a bug? Open an issue on GitHub with a minimal reproduction — a StackBlitz from any demo on this site is ideal — plus your ExhaustiveUI, Angular and browser versions. A reproduction is the difference between a bug that gets fixed and one that sits in the backlog. How do I request a feature? Open a discussion . Requests are triaged and welcome, but in practice they ship when someone implements them. If it matters to you, the contribution guide is the fastest route. Where do I ask questions? GitHub Discussions is the primary place. There is no chat server; a written question with a reproduction gets a better answer than a real-time one. How does versioning work? Semantic versioning, with majors tracking Angular majors. Breaking changes are confined to majors and documented in the GitHub releases .",
43714
43722
  "examples": null
43715
43723
  }
43716
43724
  ]
43717
43725
  },
43726
+ {
43727
+ "name": "update",
43728
+ "path": "migration/update",
43729
+ "title": "Update ExhaustiveUI",
43730
+ "description": "Updating with ng update, Angular version compatibility, and what changes in v22 (Signals API, OnPush, automated migrations).",
43731
+ "sections": [
43732
+ {
43733
+ "id": "major-versions",
43734
+ "label": "Major-versions",
43735
+ "description": "Each ExhaustiveUI major targets a single Angular major. To move to a new major, update Angular first — the Angular update guide covers that step — then update ExhaustiveUI to the matching major by passing the target version. For example, once Angular v23 and ExhaustiveUI v23 are out, from v22: Review the release notes of the target version for breaking changes before you start.",
43736
+ "examples": {
43737
+ "command": "ng update @angular/core@23 @angular/cli@23\nng update @exhaustive-ui/core@23"
43738
+ }
43739
+ },
43740
+ {
43741
+ "id": "ng-update",
43742
+ "label": "Ng-update",
43743
+ "description": "Run ng update without arguments at any time to list the updates available in your workspace, ExhaustiveUI included. To update within the current major, pass the main package. The Angular CLI resolves the rest: @exhaustive-ui/core declares all its companion packages as a group, so every installed @exhaustive-ui/* package — themes, locale, Tailwind CSS plugin and the internal runtime packages — is updated together and the suite cannot end up on mixed versions. Like any ng update run, the command expects a clean git working tree so its changes can be reviewed or reverted in isolation — commit or stash your work first.",
43744
+ "examples": null
43745
+ },
43746
+ {
43747
+ "id": "overview",
43748
+ "label": "Overview",
43749
+ "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 new version. ExhaustiveUI supports ng update , the Angular CLI's own update mechanism, which bumps every installed ExhaustiveUI package in one step and runs any automated code migrations shipped with the new version. Major versions follow Angular's: when a new Angular major ships, a matching ExhaustiveUI major is released for it. Minor and patch releases stay within the same Angular major and are drop-in updates. This page is about updating a project that already uses ExhaustiveUI. To move an existing PrimeNG workspace across, see the migration guide instead.",
43750
+ "examples": null
43751
+ },
43752
+ {
43753
+ "id": "release-notes",
43754
+ "label": "Release-notes",
43755
+ "description": "Every version is published with its notes on the GitHub releases page , covering new features, fixes and any breaking changes or manual steps a release requires. Check the notes for the target version before a major update.",
43756
+ "examples": null
43757
+ },
43758
+ {
43759
+ "id": "v22",
43760
+ "label": "V22",
43761
+ "description": "ExhaustiveUI v22 is the first major of the fork. It requires Angular v22 and moves the whole library to the Angular Signals API. Templates keep working as before: inputs are still bound with [name] , two-way bindings with [(name)] , and outputs with (name) . What changes is code that reaches into a component instance. Inputs are signal inputs: read them as component.name() rather than component.name , and set them through a template binding rather than by assignment. Two-way properties such as visible , value or selection are model() signals; call .set() on them from code. Template and child queries are signal queries ( contentChild() , viewChild() , ...), read with a call as well. Components use OnPush change detection, except Table, TreeTable and DynamicDialog. State shared with them should be passed through inputs or signals rather than mutated in place. Templates use the built-in @if / @for control flow, and option lists, menus and paginators track rows by position, so replacing the model no longer recreates every row. Run the update with ng update ; it applies the automated migrations shipped with v22 to your templates and code: styleclass-to-class : styleClass becomes the native class attribute on the components that dropped the input. renamed-inputs : deprecated aliases are renamed to their replacement, e.g. showCloseIcon to closable on Drawer, minLength to minQueryLength on AutoComplete, virtualRowHeight to virtualScrollItemSize on TreeTable. remove-dead-inputs and remove-dead-outputs : bindings of inputs and outputs that already had no effect are removed. config-overlay-options-signal : overlayOptions on the global configuration is a signal; assignments become .set() and reads become calls. Each migration prints the files it changed and the places it left for you to review, with file and line numbers.",
43762
+ "examples": {
43763
+ "command": "ng update @angular/core@22 @angular/cli@22\nng update @exhaustive-ui/core@22"
43764
+ }
43765
+ }
43766
+ ]
43767
+ },
43718
43768
  {
43719
43769
  "name": "contribution",
43720
43770
  "path": "contribution",
@@ -43722,26 +43772,26 @@
43722
43772
  "description": "How to contribute to ExhaustiveUI.",
43723
43773
  "sections": [
43724
43774
  {
43725
- "id": "benefits-",
43726
- "label": "Benefits-",
43775
+ "id": "benefits",
43776
+ "label": "Benefits",
43727
43777
  "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 yourself as a professional.",
43728
43778
  "examples": null
43729
43779
  },
43730
43780
  {
43731
- "id": "helpneeded-",
43732
- "label": "Helpneeded-",
43781
+ "id": "helpneeded",
43782
+ "label": "Helpneeded",
43733
43783
  "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: Issue Triage Help us manage issues by; Reproducing reported bugs Clarifying issue descriptions Tagging issues with appropriate labels Sending Pull Requests We encourage you to send pull requests, especially for issues tagged with the help-needed label. Community Support Assist other users by participating in the issue tracker and GitHub discussions . Your expertise can help others solve problems and improve their experience with ExhaustiveUI.",
43734
43784
  "examples": null
43735
43785
  },
43736
43786
  {
43737
- "id": "introduction-",
43738
- "label": "Introduction-",
43787
+ "id": "introduction",
43788
+ "label": "Introduction",
43739
43789
  "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. Development Setup To begin with, clone the ExhaustiveUI repository from GitHub: Then run the documentation app in your local environment at http://localhost:4200/ . Project Structure ExhaustiveUI's project structure is organized as follows:",
43740
43790
  "examples": null
43741
43791
  },
43742
43792
  {
43743
- "id": "pathway-",
43744
- "label": "Pathway-",
43793
+ "id": "pathway",
43794
+ "label": "Pathway",
43745
43795
  "description": "ExhaustiveUI offers an organization structure involving contributors and the core team: Contributor Role After a certain period of frequent contributions, a community member is offered the Contributor role. On average, it may take about three months, but the exact duration can vary depending on the individual commitment. Committer Role If a contributor actively participates in the codebase and PRs, their role may be upgraded to a Committer level, providing direct commit access to the ExhaustiveUI codebase.",
43746
43796
  "examples": null
43747
43797
  }