@exhaustive-ui/mcp 22.0.0 → 22.0.1
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/data/components.json +112 -6
- package/data/llms-full.txt +259 -15
- package/data/llms.txt +2 -0
- package/data/manifest.json +1 -1
- package/data/pages/contribution.md +5 -0
- package/data/pages/faq.md +6 -1
- package/data/pages/installation.md +7 -6
- package/data/pages/optimus.md +107 -0
- package/data/pages/philosophy.md +1 -2
- package/data/pages/primeng.md +120 -0
- package/data/pages/update.md +2 -2
- package/data/pages/v22.md +7 -4
- package/data/snapshot.json +3 -3
- package/dist/index.mjs +2 -2
- package/dist/index.mjs.map +1 -1
- package/package.json +1 -1
package/data/components.json
CHANGED
|
@@ -43694,7 +43694,7 @@
|
|
|
43694
43694
|
{
|
|
43695
43695
|
"id": "prerequisites",
|
|
43696
43696
|
"label": "Prerequisites",
|
|
43697
|
-
"description": "ExhaustiveUI v22 targets Angular v22. Any workspace created with the Angular CLI works, standalone or NgModule based.\n\n- Angular v22, including `@angular/cdk`, `@angular/forms` and `@angular/router`; the form components work with template-driven forms, reactive forms and Signal Forms (`@angular/forms/signals`)\n- RxJS v7.8.1 or newer\n- A package manager of your choice — npm, yarn or pnpm\n\nAlready using PrimeNG? Do not follow this page. The [migration guide](https://
|
|
43697
|
+
"description": "ExhaustiveUI v22 targets Angular v22. Any workspace created with the Angular CLI works, standalone or NgModule based.\n\n- Angular v22, including `@angular/cdk`, `@angular/forms` and `@angular/router`; the form components work with template-driven forms, reactive forms and Signal Forms (`@angular/forms/signals`)\n- RxJS v7.8.1 or newer\n- A package manager of your choice — npm, yarn or pnpm\n\nAlready using PrimeNG? Do not follow this page. The [migration guide](https://exhaustive-ui.com/migration/primeng) covers moving an existing PrimeNG v21 workspace, once updated to Angular v22, across with the\n`migrate-from-primeng` schematic, which is a separate command from the `ng add` below. On Optimus UI v2, follow the [Optimus UI migration guide](https://exhaustive-ui.com/migration/optimus) and its\n`migrate-from-optimus` schematic instead.",
|
|
43698
43698
|
"examples": null
|
|
43699
43699
|
},
|
|
43700
43700
|
{
|
|
@@ -43706,7 +43706,7 @@
|
|
|
43706
43706
|
{
|
|
43707
43707
|
"id": "ngadd",
|
|
43708
43708
|
"label": "Install",
|
|
43709
|
-
"description": "The recommended way to add ExhaustiveUI to an Angular CLI workspace is a single command.\n\n```bash\nng add @exhaustive-ui/core\n```\n\nThe schematic asks which theme preset you want and then does the rest:\n\n- adds `@exhaustive-ui/core` and `@exhaustive-ui/themes` to your dependencies\n- wires `provideExhaustive` into your root providers with the chosen preset, in `app.config.ts` or your root NgModule\n- installs the packages\n\nPass the preset up front to skip the prompt, or skip the install step if you want to run it yourself:\n\n```bash\n# Choose the preset without the prompt — Aura, Lara, Material or Nora\nng add @exhaustive-ui/core --theme=Lara\n\n# Wire everything up but do not run the package install\nng add @exhaustive-ui/core --skip-install\n\n# Target a specific project in a multi-project workspace\nng add @exhaustive-ui/core --project=admin\n```\n\nIf the schematic cannot find a providers array to update it prints the three manual steps instead of guessing, so nothing in your workspace is rewritten unexpectedly. If it detects an existing `primeng` dependency it changes
|
|
43709
|
+
"description": "The recommended way to add ExhaustiveUI to an Angular CLI workspace is a single command.\n\n```bash\nng add @exhaustive-ui/core\n```\n\nThe schematic asks which theme preset you want and then does the rest:\n\n- adds `@exhaustive-ui/core` and `@exhaustive-ui/themes` to your dependencies\n- wires `provideExhaustive` into your root providers with the chosen preset, in `app.config.ts` or your root NgModule\n- installs the packages\n\nPass the preset up front to skip the prompt, or skip the install step if you want to run it yourself:\n\n```bash\n# Choose the preset without the prompt — Aura, Lara, Material or Nora\nng add @exhaustive-ui/core --theme=Lara\n\n# Wire everything up but do not run the package install\nng add @exhaustive-ui/core --skip-install\n\n# Target a specific project in a multi-project workspace\nng add @exhaustive-ui/core --project=admin\n```\n\nIf the schematic cannot find a providers array to update it prints the three manual steps instead of guessing, so nothing in your workspace is rewritten unexpectedly. If it detects an existing `primeng` or\n`@openng/optimus-ui` dependency it changes nothing and fails with an error rather than reporting success, and points you at the `migrate-from-primeng` or `migrate-from-optimus` schematic, described in the\n[PrimeNG](https://exhaustive-ui.com/migration/primeng) and [Optimus UI](https://exhaustive-ui.com/migration/optimus) migration guides. It does not run that schematic for you. The Angular CLI installs\n`@exhaustive-ui/core` before the schematic runs, so the dependency stays in your `package.json` — the migration schematic needs it there.",
|
|
43710
43710
|
"examples": null
|
|
43711
43711
|
},
|
|
43712
43712
|
{
|
|
@@ -44492,7 +44492,7 @@
|
|
|
44492
44492
|
{
|
|
44493
44493
|
"id": "trademark",
|
|
44494
44494
|
"label": "PrimeNG and PrimeTek",
|
|
44495
|
-
"description": "ExhaustiveUI is not affiliated with, endorsed by, or sponsored by PrimeTek. PrimeNG, PrimeFaces, PrimeReact, PrimeVue and PrimeFlex are their trademarks. The rename from the inherited names — the packages, the CSS layer, the icon\nlibrary — is a trademark matter, not a technical one, and it is why we ship a [migration schematic](https://
|
|
44495
|
+
"description": "ExhaustiveUI is not affiliated with, endorsed by, or sponsored by PrimeTek. PrimeNG, PrimeFaces, PrimeReact, PrimeVue and PrimeFlex are their trademarks. The rename from the inherited names — the packages, the CSS layer, the icon\nlibrary — is a trademark matter, not a technical one, and it is why we ship a [migration schematic](https://exhaustive-ui.com/migration/primeng) rather than asking you to rewrite imports by hand.\n\nReferences to PrimeNG remain throughout this documentation and the source, and they are deliberate. Attribution is the point: this library is PrimeTek's decade of work plus whatever the community adds on top. Pretending otherwise\nwould be both dishonest and useless to anyone trying to find their way around a familiar API.\n\nThe code we forked was published under the MIT license, and we distribute it under those same terms, with the original copyright notices intact.",
|
|
44496
44496
|
"examples": null
|
|
44497
44497
|
},
|
|
44498
44498
|
{
|
|
@@ -44518,7 +44518,7 @@
|
|
|
44518
44518
|
{
|
|
44519
44519
|
"id": "migration",
|
|
44520
44520
|
"label": "Compatibility & Migration",
|
|
44521
|
-
"description": "### Which Angular versions are supported?\n\nAngular v22: ExhaustiveUI v22 requires Angular v22. Our majors follow Angular's — when a new Angular major ships, a compatible ExhaustiveUI major is the first thing we work on. See the\n[version compatibility table](https://exhaustive-ui.com/migration/update) in the update guide.\n\n### How do I migrate from PrimeNG? Is it automatic?\n\nMostly, but not through `ng add`, which only sets up new projects and fails without changing anything when it finds an existing `primeng` dependency. Install `@exhaustive-ui/core`, then run\n`ng generate @exhaustive-ui/core:migrate-from-primeng` in a PrimeNG v21 workspace updated to Angular v22: packages swapped, imports rewritten, dependencies installed. It then prints a report of anything it could not rewrite,\nwith file and line numbers. The [migration guide](https://
|
|
44521
|
+
"description": "### Which Angular versions are supported?\n\nAngular v22: ExhaustiveUI v22 requires Angular v22. Our majors follow Angular's — when a new Angular major ships, a compatible ExhaustiveUI major is the first thing we work on. See the\n[version compatibility table](https://exhaustive-ui.com/migration/update) in the update guide.\n\n### How do I migrate from PrimeNG? Is it automatic?\n\nMostly, but not through `ng add`, which only sets up new projects and fails without changing anything when it finds an existing `primeng` dependency. Install `@exhaustive-ui/core`, then run\n`ng generate @exhaustive-ui/core:migrate-from-primeng` in a PrimeNG v21 workspace updated to Angular v22: packages swapped, imports rewritten, dependencies installed. It then prints a report of anything it could not rewrite,\nwith file and line numbers. The [migration guide](https://exhaustive-ui.com/migration/primeng) covers the details and the manual cases.\n\n### I am on PrimeNG v20 or older. Can I migrate directly?\n\nNo. Upgrade to PrimeNG v21 first, using PrimeNG's own migration guides, then update Angular to v22 and run the schematic. The schematic checks the version and refuses rather than producing a half-migrated workspace.\n\n### I use Optimus UI. Can I switch?\n\nYes. ExhaustiveUI is a fork of Optimus UI, with the same components. On Optimus UI v2, run `ng generate @exhaustive-ui/core:migrate-from-optimus`: packages swapped, imports and configuration API renamed, CSS layer renamed,\ndependencies installed. The [Optimus UI migration guide](https://exhaustive-ui.com/migration/optimus) covers the steps and the v22 migrations that follow.\n\n### What happens to my PrimeNG license?\n\nNothing — it is unrelated. A PrimeNG v22 commercial license covers PrimeNG. ExhaustiveUI needs no license at all. If you hold a PrimeTek subscription for their templates or theme designer, those remain their products and do not carry\nover here.\n\n### I had an open PR on primefaces/primeng. Can I bring it here?\n\nYes, and we would like you to. Append `.patch` to your original pull request URL and apply it with `git am` — the contributing guide in the repository walks through it, including what to do when the patch no longer applies\ncleanly.\n\n### Can I run PrimeNG and ExhaustiveUI side by side?\n\nTechnically yes, since the package names and the CSS cascade layer differ, but you will ship two copies of the same components and two theme runtimes. Treat it as a temporary state during migration rather than a supported\nconfiguration.",
|
|
44522
44522
|
"examples": null
|
|
44523
44523
|
},
|
|
44524
44524
|
{
|
|
@@ -44544,7 +44544,7 @@
|
|
|
44544
44544
|
{
|
|
44545
44545
|
"id": "overview",
|
|
44546
44546
|
"label": "Overview",
|
|
44547
|
-
"description": "All `@exhaustive-ui/core` packages — the components, themes, locale definitions, Tailwind CSS plugin and their internal dependencies — are versioned and released together, so an update always moves the whole suite to a single\nnew version. ExhaustiveUI supports `ng update`, the Angular CLI's own update mechanism, which bumps every installed ExhaustiveUI package in one step and runs any automated code migrations shipped with the new version.\n\nMajor versions follow Angular's: when a new Angular major ships, a matching ExhaustiveUI major is released for it. Minor and patch releases stay within the same Angular major and are drop-in updates.\n\nThis page is about updating a project that already uses ExhaustiveUI. To move an existing
|
|
44547
|
+
"description": "All `@exhaustive-ui/core` packages — the components, themes, locale definitions, Tailwind CSS plugin and their internal dependencies — are versioned and released together, so an update always moves the whole suite to a single\nnew version. ExhaustiveUI supports `ng update`, the Angular CLI's own update mechanism, which bumps every installed ExhaustiveUI package in one step and runs any automated code migrations shipped with the new version.\n\nMajor versions follow Angular's: when a new Angular major ships, a matching ExhaustiveUI major is released for it. Minor and patch releases stay within the same Angular major and are drop-in updates.\n\nThis page is about updating a project that already uses ExhaustiveUI. To move an existing workspace across, see the guides for\n[PrimeNG](https://exhaustive-ui.com/migration/primeng) and [Optimus UI](https://exhaustive-ui.com/migration/optimus) instead.",
|
|
44548
44548
|
"examples": null
|
|
44549
44549
|
},
|
|
44550
44550
|
{
|
|
@@ -44573,6 +44573,106 @@
|
|
|
44573
44573
|
}
|
|
44574
44574
|
]
|
|
44575
44575
|
},
|
|
44576
|
+
{
|
|
44577
|
+
"name": "primeng",
|
|
44578
|
+
"path": "migration/primeng",
|
|
44579
|
+
"title": "Migrating from PrimeNG",
|
|
44580
|
+
"description": "Moving a PrimeNG v21 application to ExhaustiveUI: the migrate-from-primeng schematic, what it changes (packages, imports, configuration API, icons, CSS layer), the manual checks and the v22 migrations.",
|
|
44581
|
+
"sections": [
|
|
44582
|
+
{
|
|
44583
|
+
"id": "overview",
|
|
44584
|
+
"label": "Overview",
|
|
44585
|
+
"description": "ExhaustiveUI is an MIT fork of PrimeNG v21, the last PrimeNG release published under the MIT license, by way of Optimus UI. The components, their selectors, the `p-*` CSS classes, the design tokens and the `pi pi-*` icon\nclasses are the same, so a PrimeNG v21 application moves across in two parts:\n\n1. **The switch**: other package names, a configuration API named after ExhaustiveUI, another icon package and another default CSS layer name. The `migrate-from-primeng` schematic does it.\n2. **The v22 changes**: Angular 22, the Signals API, OnPush and the API cleanup of ExhaustiveUI v22. The `ng update` migrations do most of it, and the [migration guide to v22](https://exhaustive-ui.com/migration/v22) covers the rest.\n\nNo license is needed. A PrimeTek license or subscription for PrimeNG, its templates or its theme designer does not carry over, and is not required.",
|
|
44586
|
+
"examples": null
|
|
44587
|
+
},
|
|
44588
|
+
{
|
|
44589
|
+
"id": "prerequisites",
|
|
44590
|
+
"label": "Before you start",
|
|
44591
|
+
"description": "- **PrimeNG v21.** ExhaustiveUI shares its API. On v20 or older, upgrade to v21 first with PrimeNG's own update guides; the schematic checks the installed version and stops otherwise. On PrimeNG v22, the schematic runs, but the features PrimeNG added after v21 have no ExhaustiveUI equivalent: check the compiler errors and the report.\n- **A clean git working tree**, so every change can be reviewed and reverted on its own, and a build and test run that passes before you start.\n- **PrimeFlex**, if the project uses it, is not migrated by this schematic. Run `migrate-from-primeflex` afterwards to move its classes to Tailwind CSS; the schematic reminds you when it finds PrimeFlex.",
|
|
44592
|
+
"examples": null
|
|
44593
|
+
},
|
|
44594
|
+
{
|
|
44595
|
+
"id": "steps",
|
|
44596
|
+
"label": "Migration steps",
|
|
44597
|
+
"description": "1. Update Angular to 22. PrimeNG v21 declares Angular 21 as its peer dependency, so the Angular CLI refuses the update while `primeng` is installed: pass `--force`. The next step removes `primeng`.\n2. Install ExhaustiveUI and run the `migrate-from-primeng` schematic. It rewrites the workspace, then installs the new dependencies.\n3. Run the v22 migrations. The workspace did not go through `ng update`, so they are run explicitly, from the version before v22.\n4. Read both reports, fix the compiler errors, then build and run your tests.\n\n```bash\nng update @angular/core@22 @angular/cli@22 --force\nnpm install @exhaustive-ui/core@22\nng generate @exhaustive-ui/core:migrate-from-primeng\nng update @exhaustive-ui/core --migrate-only --from=3.0.0\n```\n\nThe schematic takes two options: `--skip-install` leaves the install to you, and `--force` skips the PrimeNG version check.",
|
|
44598
|
+
"examples": null
|
|
44599
|
+
},
|
|
44600
|
+
{
|
|
44601
|
+
"id": "schematic",
|
|
44602
|
+
"label": "What the schematic changes",
|
|
44603
|
+
"description": "The schematic visits every file of the workspace except `node_modules`, build output and the files your `.gitignore` excludes.\n\n### Dependencies\n\nIn every `package.json` of the workspace, including `overrides` and `resolutions`, each package is replaced by its counterpart:\n\n- `primeng` becomes `@exhaustive-ui/core`\n- `@primeuix/themes`, `@primeuix/styled`, `@primeuix/styles`, `@primeuix/utils` and `@primeuix/motion` become `@exhaustive-ui/themes`, `@exhaustive-ui/styled`, `@exhaustive-ui/styles`, `@exhaustive-ui/utils` and `@exhaustive-ui/motion`\n- `tailwindcss-primeui` becomes `@exhaustive-ui/tailwindcss`\n- `primelocale` becomes `@exhaustive-ui/locale`\n- `primeicons` becomes `@openng/icons`\n\n### TypeScript\n\nImports, dynamic imports and `require()` calls are rewritten, subpaths included (`primeng/button` becomes `@exhaustive-ui/core/button`, `@primeuix/themes/aura` becomes\n`@exhaustive-ui/themes/aura`), and so is the Tailwind CSS configuration file. The configuration API is renamed where it is imported: `providePrimeNG` becomes `provideExhaustive`, the `PrimeNG` service becomes\n`Exhaustive`, `PrimeNGConfigType` becomes `ExhaustiveConfigType`, and the `PrimeIcons` constants become `OpenngIcons`.\n\n```typescript\n// Before\nimport { ApplicationConfig } from '@angular/core';\nimport { providePrimeNG } from 'primeng/config';\nimport Aura from '@primeuix/themes/aura';\n\nexport const appConfig: ApplicationConfig = {\n providers: [providePrimeNG({ theme: { preset: Aura } })]\n};\n\n// After\nimport { ApplicationConfig } from '@angular/core';\nimport { provideExhaustive } from '@exhaustive-ui/core/config';\nimport Aura from '@exhaustive-ui/themes/aura';\n\nexport const appConfig: ApplicationConfig = {\n providers: [provideExhaustive({ theme: { preset: Aura } })]\n};\n```\n\n### Stylesheets and angular.json\n\n`@import`, `@use`, `@plugin` and `url()` references in stylesheets, and the `styles` and `scripts` entries of `angular.json` and `project.json`, follow the new package names.\n`primeicons/primeicons.css` becomes `@openng/icons/openng-icons.css`; the `pi pi-*` classes in templates do not change.\n\n### CSS cascade layer\n\nWhen the theme sets `cssLayer`, the `primeng` layer becomes `exhaustive` in its `name` and `order`, `primeng-overwrites` becomes `exhaustive-overwrites`, and the matching\n`@layer` declarations in your stylesheets are renamed too, so your overrides keep their place in the layer order. With `cssLayer: true`, the configuration does not change, and only the stylesheets are renamed.\n\n### The report\n\nThe schematic ends with the places that still mention `primeng`, `primeicons`, `@primeuix`, `tailwindcss-primeui` or `primelocale`, with the file and line: templates, Markdown, JSON or code it does not\nrewrite. Lockfiles are left out of the report, since the install regenerates them.",
|
|
44604
|
+
"examples": null
|
|
44605
|
+
},
|
|
44606
|
+
{
|
|
44607
|
+
"id": "manual",
|
|
44608
|
+
"label": "Manual checks",
|
|
44609
|
+
"description": "Besides the places listed in the report, check these by hand:\n\n- **The icon font name.** A stylesheet that names the font directly, as in `font-family: 'primeicons'`, now needs `'openng-icons'`. The schematic does not touch declaration values.\n- **Local variables named after PrimeNG**, such as `primeng = inject(PrimeNG)`: the type is renamed, the variable name is yours to keep or change.\n- **Module paths passed to other functions**, such as `jest.mock('primeng/button')` or `vi.mock()`: only imports, dynamic imports and `require()` are rewritten. These appear in the report.\n- **Build and deployment files** outside the TypeScript sources and stylesheets: Dockerfiles, CI scripts, CDN links to PrimeNG or PrimeIcons.\n- **PrimeTek products** such as templates or the theme designer are not part of ExhaustiveUI. A preset built with them is a plain `definePreset()` object and keeps working once its imports point to `@exhaustive-ui/themes`.",
|
|
44610
|
+
"examples": null
|
|
44611
|
+
},
|
|
44612
|
+
{
|
|
44613
|
+
"id": "v22",
|
|
44614
|
+
"label": "What changes in v22",
|
|
44615
|
+
"description": "After the switch, the application runs on ExhaustiveUI v22, which differs from PrimeNG v21 in ways the compiler and your tests will show. The [migration guide to v22](https://exhaustive-ui.com/migration/v22)\ndetails each of them:\n\n- Inputs, two-way properties, outputs and queries are signals: code holding a component instance reads inputs with a call and writes two-way properties with `.set()`.\n- Components use OnPush change detection, except Table, TreeTable and DynamicDialog: give them new arrays and objects, or signals, rather than mutating bound data.\n- Deprecated and inactive inputs are removed or renamed, `styleClass` becomes `class` on most components; the v22 migrations rewrite these bindings and report the rest.\n- Hundreds of bugs inherited from PrimeNG v21 are fixed, each with a regression test; a few of them change a visible behavior.",
|
|
44616
|
+
"examples": null
|
|
44617
|
+
},
|
|
44618
|
+
{
|
|
44619
|
+
"id": "checklist",
|
|
44620
|
+
"label": "Checklist",
|
|
44621
|
+
"description": "- Angular 22 installed, and no `primeng`, `@primeuix/*`, `primeicons`, `tailwindcss-primeui` or `primelocale` left in any `package.json`.\n- The report of `migrate-from-primeng` handled, then the report of the v22 migrations.\n- Icons render: the stylesheet is `@openng/icons/openng-icons.css` and nothing names the `primeicons` font.\n- With a CSS layer configured, your overrides still apply: the `@layer` names match the theme's `cssLayer` order.\n- The application compiles and its tests pass, after the code changes of the migration guide to v22.\n- PrimeFlex, if used, migrated with `migrate-from-primeflex`.",
|
|
44622
|
+
"examples": null
|
|
44623
|
+
}
|
|
44624
|
+
]
|
|
44625
|
+
},
|
|
44626
|
+
{
|
|
44627
|
+
"name": "optimus",
|
|
44628
|
+
"path": "migration/optimus",
|
|
44629
|
+
"title": "Migrating from Optimus UI",
|
|
44630
|
+
"description": "Moving an Optimus UI v2 application to ExhaustiveUI: package and configuration API renames, the CSS layer name, then the v22 migrations.",
|
|
44631
|
+
"sections": [
|
|
44632
|
+
{
|
|
44633
|
+
"id": "overview",
|
|
44634
|
+
"label": "Overview",
|
|
44635
|
+
"description": "ExhaustiveUI is a fork of Optimus UI, itself the MIT continuation of PrimeNG v21. An Optimus UI v2 application already runs on Angular 22 and uses the same components, selectors, CSS classes, design tokens and\n`@openng/icons` icons. Moving it across takes two steps:\n\n1. **The rename**: the `@openng/optimus-ui*` packages become `@exhaustive-ui/*`, and the four names of the configuration API change. The `migrate-from-optimus` schematic does it.\n2. **The v22 changes**: the Signals API everywhere, OnPush and the API cleanup of ExhaustiveUI v22. The `ng update` migrations do most of it, and the [migration guide to v22](https://exhaustive-ui.com/migration/v22) covers the rest.",
|
|
44636
|
+
"examples": null
|
|
44637
|
+
},
|
|
44638
|
+
{
|
|
44639
|
+
"id": "prerequisites",
|
|
44640
|
+
"label": "Before you start",
|
|
44641
|
+
"description": "- **Optimus UI v2 on Angular 22.** An application still on Optimus UI v1 updates to v2 first, following Optimus UI's documentation.\n- **A clean git working tree**, so the rename and the migrations can be reviewed on their own, and a build and test run that passes before you start.",
|
|
44642
|
+
"examples": null
|
|
44643
|
+
},
|
|
44644
|
+
{
|
|
44645
|
+
"id": "steps",
|
|
44646
|
+
"label": "Migration steps",
|
|
44647
|
+
"description": "1. Install ExhaustiveUI and run the `migrate-from-optimus` schematic. It rewrites the workspace, then installs the new dependencies.\n2. Run the v22 migrations. The workspace did not go through `ng update`, so they are run explicitly, from the version before v22.\n3. Read both reports, fix the compiler errors, then build and run your tests.\n\n```bash\nnpm install @exhaustive-ui/core@22\nng generate @exhaustive-ui/core:migrate-from-optimus\nng update @exhaustive-ui/core --migrate-only --from=3.0.0\n```\n\nThe schematic checks that `@openng/optimus-ui` v2 is installed. It takes two options: `--skip-install` leaves the install to you, and `--force` skips the version check. Like `ng update`, run it on a clean\nworking tree so its changes can be reviewed with `git diff`.",
|
|
44648
|
+
"examples": null
|
|
44649
|
+
},
|
|
44650
|
+
{
|
|
44651
|
+
"id": "schematic",
|
|
44652
|
+
"label": "What the schematic changes",
|
|
44653
|
+
"description": "The schematic visits every file of the workspace except `node_modules`, build output and the files your `.gitignore` excludes.\n\n### Dependencies\n\nIn every `package.json` of the workspace, each package is replaced by its counterpart, which has the same content and the same subpaths:\n\n- `@openng/optimus-ui` becomes `@exhaustive-ui/core`\n- `@openng/optimus-ui-themes`, `-tailwindcss`, `-locale`, `-styled`, `-styles`, `-utils` and `-motion` become `@exhaustive-ui/themes`, `tailwindcss`, `locale`, `styled`, `styles`, `utils` and `motion`\n- `@openng/icons` stays: ExhaustiveUI uses the same icon set.\n\n### TypeScript\n\nImports, dynamic imports and `require()` calls are rewritten, subpaths included (`@openng/optimus-ui/button` becomes `@exhaustive-ui/core/button`), and so is the Tailwind CSS configuration file. The\nconfiguration API is renamed where it is imported from Optimus UI, along with every use in the file: `provideOptimus` becomes `provideExhaustive`, the `Optimus` service becomes `Exhaustive`,\n`OptimusConfigType` becomes `ExhaustiveConfigType` and `OPTIMUS_CONFIG` becomes `EXHAUSTIVE_CONFIG`. A class of your own that happens to be named `Optimus` is left alone.\n\n```typescript\n// Before\nimport { ApplicationConfig } from '@angular/core';\nimport { provideOptimus } from '@openng/optimus-ui/config';\nimport Aura from '@openng/optimus-ui-themes/aura';\n\nexport const appConfig: ApplicationConfig = {\n providers: [provideOptimus({ theme: { preset: Aura } })]\n};\n\n// After\nimport { ApplicationConfig } from '@angular/core';\nimport { provideExhaustive } from '@exhaustive-ui/core/config';\nimport Aura from '@exhaustive-ui/themes/aura';\n\nexport const appConfig: ApplicationConfig = {\n providers: [provideExhaustive({ theme: { preset: Aura } })]\n};\n```\n\n### Stylesheets and angular.json\n\n`@import`, `@use`, `@plugin` and `url()` references in stylesheets, and the `styles` and `scripts` entries of `angular.json` and `project.json`, follow the new package names.\n\n### The report\n\nThe schematic ends with the places that still mention `optimus-ui`, `Optimus`, `provideOptimus`, `OptimusConfigType` or `OPTIMUS_CONFIG`, with the file and line: templates, Markdown, comments, or module paths\npassed to other functions, such as `jest.mock()`. Lockfiles are left out, since the install regenerates them.",
|
|
44654
|
+
"examples": null
|
|
44655
|
+
},
|
|
44656
|
+
{
|
|
44657
|
+
"id": "css-layer",
|
|
44658
|
+
"label": "CSS layer",
|
|
44659
|
+
"description": "Optimus UI puts its styles in a CSS cascade layer named `optimus` when the theme enables `cssLayer`; ExhaustiveUI names it `exhaustive`. The schematic renames the `optimus` token in the `cssLayer`\n`name` and `order` of your configuration, then the matching `@layer` declarations and `@import ... layer()` clauses in your stylesheets, so your overrides keep their place in the layer order. With\n`cssLayer: true`, the configuration does not change, and only the stylesheets are renamed.\n\nA layer of your own, with another name, is left as it is. The CSS classes (`p-button`...), the design tokens (`--p-primary-color`...) and the icon classes (`pi pi-check`...) do not change.",
|
|
44660
|
+
"examples": null
|
|
44661
|
+
},
|
|
44662
|
+
{
|
|
44663
|
+
"id": "v22",
|
|
44664
|
+
"label": "v22 migrations",
|
|
44665
|
+
"description": "After `migrate-from-optimus`, run the v22 migrations. The workspace did not go through `ng update`, so they are run explicitly, from the version before v22:\n\n```bash\nng update @exhaustive-ui/core --migrate-only --from=3.0.0\n```\n\nThey rewrite the templates and code for the inputs, outputs and templates removed or renamed in v22, and for the configuration options that became signals or changed name, such as `inputStyle`, now `inputVariant`. They\nreport what they cannot rewrite. The [migration guide to v22](https://exhaustive-ui.com/migration/v22) then covers the code changes: signal inputs, `model()` and signal queries in every component, OnPush change\ndetection, and the behavior and type changes.",
|
|
44666
|
+
"examples": null
|
|
44667
|
+
},
|
|
44668
|
+
{
|
|
44669
|
+
"id": "checklist",
|
|
44670
|
+
"label": "Checklist",
|
|
44671
|
+
"description": "- No `@openng/optimus-ui*` package left in any `package.json`, and the report of `migrate-from-optimus` handled.\n- `provideExhaustive`, `Exhaustive`, `ExhaustiveConfigType` and `EXHAUSTIVE_CONFIG` in place of the Optimus names.\n- With a CSS layer configured, your overrides still apply.\n- The v22 migrations run and their report handled.\n- The application compiles and its tests pass, after the code changes of the migration guide to v22.",
|
|
44672
|
+
"examples": null
|
|
44673
|
+
}
|
|
44674
|
+
]
|
|
44675
|
+
},
|
|
44576
44676
|
{
|
|
44577
44677
|
"name": "v22",
|
|
44578
44678
|
"path": "migration/v22",
|
|
@@ -44594,7 +44694,7 @@
|
|
|
44594
44694
|
{
|
|
44595
44695
|
"id": "steps",
|
|
44596
44696
|
"label": "Update steps",
|
|
44597
|
-
"description": "### From an ExhaustiveUI alpha or release candidate\n\nUpdate Angular, then ExhaustiveUI. Every installed `@exhaustive-ui/*` package moves to 22.0.0 together, and the migrations run.\n\n```bash\nng update @angular/core@22 @angular/cli@22\nng update @exhaustive-ui/core@22\n```\n\n### From PrimeNG v21\n\nUpdate Angular to 22, install ExhaustiveUI and run the `migrate-from-primeng` schematic. It swaps the `primeng`, `@primeuix/*` and PrimeIcons dependencies, rewrites the imports (`primeng/button` becomes\n`@exhaustive-ui/core/button`) and renames the configuration API (`providePrimeNG` becomes `provideExhaustive`). The workspace did not go through `ng update`, so run the v22 migrations explicitly afterwards.\n\n```bash\nng update @angular/core@22 @angular/cli@22\nnpm install @exhaustive-ui/core@22\nng generate @exhaustive-ui/core:migrate-from-primeng\nng update @exhaustive-ui/core --migrate-only --from=3.0.0\n```\n\nProjects on PrimeNG v20 or older upgrade to PrimeNG v21 first; the schematic checks the version and refuses otherwise.\n\n### From Optimus UI v2\n\nOptimus UI v2 has the PrimeNG v21 API under other package names.
|
|
44697
|
+
"description": "### From an ExhaustiveUI alpha or release candidate\n\nUpdate Angular, then ExhaustiveUI. Every installed `@exhaustive-ui/*` package moves to 22.0.0 together, and the migrations run.\n\n```bash\nng update @angular/core@22 @angular/cli@22\nng update @exhaustive-ui/core@22\n```\n\n### From PrimeNG v21\n\nUpdate Angular to 22, install ExhaustiveUI and run the `migrate-from-primeng` schematic. It swaps the `primeng`, `@primeuix/*` and PrimeIcons dependencies, rewrites the imports (`primeng/button` becomes\n`@exhaustive-ui/core/button`) and renames the configuration API (`providePrimeNG` becomes `provideExhaustive`). The workspace did not go through `ng update`, so run the v22 migrations explicitly afterwards.\n\n```bash\nng update @angular/core@22 @angular/cli@22 --force\nnpm install @exhaustive-ui/core@22\nng generate @exhaustive-ui/core:migrate-from-primeng\nng update @exhaustive-ui/core --migrate-only --from=3.0.0\n```\n\nProjects on PrimeNG v20 or older upgrade to PrimeNG v21 first; the schematic checks the version and refuses otherwise. The [PrimeNG migration guide](https://exhaustive-ui.com/migration/primeng) details each step,\nincluding the `--force` the Angular update needs while `primeng` is installed.\n\n### From Optimus UI v2\n\nOptimus UI v2 has the PrimeNG v21 API under other package names. The `migrate-from-optimus` schematic swaps its packages for their `@exhaustive-ui/*` counterparts and renames the imports, the configuration API and the\nCSS layer; then run the v22 migrations explicitly. The [Optimus UI migration guide](https://exhaustive-ui.com/migration/optimus) details each step.\n\n```bash\nnpm install @exhaustive-ui/core@22\nng generate @exhaustive-ui/core:migrate-from-optimus\nng update @exhaustive-ui/core --migrate-only --from=3.0.0\n```\n\n### Then\n\n1. Read the report the migrations printed, see `Reviewing the report` below.\n2. Fix the TypeScript errors: most come from the Signals API and the removed TypeScript API.\n3. Check the screens that mutate data bound to a component, which no longer refresh under OnPush.\n4. Read the behavior changes, then build and run your tests.",
|
|
44598
44698
|
"examples": null
|
|
44599
44699
|
},
|
|
44600
44700
|
{
|
|
@@ -44665,6 +44765,12 @@
|
|
|
44665
44765
|
"description": "ExhaustiveUI is a community-driven project stewarded by e-xiste, and we appreciate any help you can provide. Here are some areas where you can contribute:\n\n### Issue Triage\n\nHelp us manage issues by;\n\n- Reproducing reported bugs\n- Clarifying issue descriptions\n- Tagging issues with appropriate labels\n\n### Sending Pull Requests\n\nWe encourage you to send pull requests, especially for issues tagged with the `help-needed` label.\n\n### Community Support\n\nAssist other users by participating in the issue tracker and [GitHub discussions](https://github.com/e-xiste/exhaustive-ui/discussions). Your expertise can help others solve\nproblems and improve their experience with ExhaustiveUI.",
|
|
44666
44766
|
"examples": null
|
|
44667
44767
|
},
|
|
44768
|
+
{
|
|
44769
|
+
"id": "ai",
|
|
44770
|
+
"label": "AI Contributions",
|
|
44771
|
+
"description": "Contributions written with AI coding agents are welcome, on the same terms as any other: the pull request is yours. You understand the change and can answer questions about it in review, it is scoped to one problem, and it comes with\ntests that fail without the fix. The repository ships what agents need: the `@exhaustive-ui/mcp` server, the `exhaustive-ui` agent skill and the LLM docs, generated from this site.",
|
|
44772
|
+
"examples": null
|
|
44773
|
+
},
|
|
44668
44774
|
{
|
|
44669
44775
|
"id": "pathway",
|
|
44670
44776
|
"label": "Pathway",
|
package/data/llms-full.txt
CHANGED
|
@@ -18,8 +18,9 @@ ExhaustiveUI v22 targets Angular v22. Any workspace created with the Angular CLI
|
|
|
18
18
|
- RxJS v7.8.1 or newer
|
|
19
19
|
- A package manager of your choice — npm, yarn or pnpm
|
|
20
20
|
|
|
21
|
-
Already using PrimeNG? Do not follow this page. The [migration guide](https://
|
|
22
|
-
|
|
21
|
+
Already using PrimeNG? Do not follow this page. The [migration guide](https://exhaustive-ui.com/migration/primeng) covers moving an existing PrimeNG v21 workspace, once updated to Angular v22, across with the
|
|
22
|
+
`migrate-from-primeng` schematic, which is a separate command from the `ng add` below. On Optimus UI v2, follow the [Optimus UI migration guide](https://exhaustive-ui.com/migration/optimus) and its
|
|
23
|
+
`migrate-from-optimus` schematic instead.
|
|
23
24
|
|
|
24
25
|
## Angular Version Compatibility
|
|
25
26
|
|
|
@@ -52,10 +53,10 @@ ng add @exhaustive-ui/core --skip-install
|
|
|
52
53
|
ng add @exhaustive-ui/core --project=admin
|
|
53
54
|
```
|
|
54
55
|
|
|
55
|
-
If the schematic cannot find a providers array to update it prints the three manual steps instead of guessing, so nothing in your workspace is rewritten unexpectedly. If it detects an existing `primeng`
|
|
56
|
-
nothing and fails with an error rather than reporting success, and points you at the
|
|
57
|
-
|
|
58
|
-
migration schematic needs it there.
|
|
56
|
+
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` or
|
|
57
|
+
`@openng/optimus-ui` dependency it changes nothing and fails with an error rather than reporting success, and points you at the `migrate-from-primeng` or `migrate-from-optimus` schematic, described in the
|
|
58
|
+
[PrimeNG](https://exhaustive-ui.com/migration/primeng) and [Optimus UI](https://exhaustive-ui.com/migration/optimus) migration guides. It does not run that schematic for you. The Angular CLI installs
|
|
59
|
+
`@exhaustive-ui/core` before the schematic runs, so the dependency stays in your `package.json` — the migration schematic needs it there.
|
|
59
60
|
|
|
60
61
|
## Download
|
|
61
62
|
|
|
@@ -2193,8 +2194,7 @@ migration schematic, rather than dripping renames across releases.
|
|
|
2193
2194
|
## PrimeNG and PrimeTek
|
|
2194
2195
|
|
|
2195
2196
|
ExhaustiveUI is not affiliated with, endorsed by, or sponsored by PrimeTek. PrimeNG, PrimeFaces, PrimeReact, PrimeVue and PrimeFlex are their trademarks. The rename from the inherited names — the packages, the CSS layer, the icon
|
|
2196
|
-
library — is a trademark matter, not a technical one, and it is why we ship a [migration schematic](https://
|
|
2197
|
-
asking you to rewrite imports by hand.
|
|
2197
|
+
library — is a trademark matter, not a technical one, and it is why we ship a [migration schematic](https://exhaustive-ui.com/migration/primeng) rather than asking you to rewrite imports by hand.
|
|
2198
2198
|
|
|
2199
2199
|
References to PrimeNG remain throughout this documentation and the source, and they are deliberate. Attribution is the point: this library is PrimeTek's decade of work plus whatever the community adds on top. Pretending otherwise
|
|
2200
2200
|
would be both dishonest and useless to anyone trying to find their way around a familiar API.
|
|
@@ -2261,12 +2261,17 @@ Angular v22: ExhaustiveUI v22 requires Angular v22. Our majors follow Angular's
|
|
|
2261
2261
|
|
|
2262
2262
|
Mostly, but not through `ng add`, which only sets up new projects and fails without changing anything when it finds an existing `primeng` dependency. Install `@exhaustive-ui/core`, then run
|
|
2263
2263
|
`ng generate @exhaustive-ui/core:migrate-from-primeng` in a PrimeNG v21 workspace updated to Angular v22: packages swapped, imports rewritten, dependencies installed. It then prints a report of anything it could not rewrite,
|
|
2264
|
-
with file and line numbers. The [migration guide](https://
|
|
2264
|
+
with file and line numbers. The [migration guide](https://exhaustive-ui.com/migration/primeng) covers the details and the manual cases.
|
|
2265
2265
|
|
|
2266
2266
|
### I am on PrimeNG v20 or older. Can I migrate directly?
|
|
2267
2267
|
|
|
2268
2268
|
No. Upgrade to PrimeNG v21 first, using PrimeNG's own migration guides, then update Angular to v22 and run the schematic. The schematic checks the version and refuses rather than producing a half-migrated workspace.
|
|
2269
2269
|
|
|
2270
|
+
### I use Optimus UI. Can I switch?
|
|
2271
|
+
|
|
2272
|
+
Yes. ExhaustiveUI is a fork of Optimus UI, with the same components. On Optimus UI v2, run `ng generate @exhaustive-ui/core:migrate-from-optimus`: packages swapped, imports and configuration API renamed, CSS layer renamed,
|
|
2273
|
+
dependencies installed. The [Optimus UI migration guide](https://exhaustive-ui.com/migration/optimus) covers the steps and the v22 migrations that follow.
|
|
2274
|
+
|
|
2270
2275
|
### What happens to my PrimeNG license?
|
|
2271
2276
|
|
|
2272
2277
|
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
|
|
@@ -2346,8 +2351,8 @@ new version. ExhaustiveUI supports `ng update`, the Angular CLI's own update mec
|
|
|
2346
2351
|
|
|
2347
2352
|
Major versions follow Angular's: when a new Angular major ships, a matching ExhaustiveUI major is released for it. Minor and patch releases stay within the same Angular major and are drop-in updates.
|
|
2348
2353
|
|
|
2349
|
-
This page is about updating a project that already uses ExhaustiveUI. To move an existing
|
|
2350
|
-
[migration
|
|
2354
|
+
This page is about updating a project that already uses ExhaustiveUI. To move an existing workspace across, see the guides for
|
|
2355
|
+
[PrimeNG](https://exhaustive-ui.com/migration/primeng) and [Optimus UI](https://exhaustive-ui.com/migration/optimus) instead.
|
|
2351
2356
|
|
|
2352
2357
|
## Updating
|
|
2353
2358
|
|
|
@@ -2400,6 +2405,237 @@ manual steps a release requires. Check the notes for the target version before a
|
|
|
2400
2405
|
|
|
2401
2406
|
---
|
|
2402
2407
|
|
|
2408
|
+
# Migrating from PrimeNG
|
|
2409
|
+
|
|
2410
|
+
Moving a PrimeNG v21 application to ExhaustiveUI: the migrate-from-primeng schematic, what it changes (packages, imports, configuration API, icons, CSS layer), the manual checks and the v22 migrations.
|
|
2411
|
+
|
|
2412
|
+
## Overview
|
|
2413
|
+
|
|
2414
|
+
ExhaustiveUI is an MIT fork of PrimeNG v21, the last PrimeNG release published under the MIT license, by way of Optimus UI. The components, their selectors, the `p-*` CSS classes, the design tokens and the `pi pi-*` icon
|
|
2415
|
+
classes are the same, so a PrimeNG v21 application moves across in two parts:
|
|
2416
|
+
|
|
2417
|
+
1. **The switch**: other package names, a configuration API named after ExhaustiveUI, another icon package and another default CSS layer name. The `migrate-from-primeng` schematic does it.
|
|
2418
|
+
2. **The v22 changes**: Angular 22, the Signals API, OnPush and the API cleanup of ExhaustiveUI v22. The `ng update` migrations do most of it, and the [migration guide to v22](https://exhaustive-ui.com/migration/v22) covers the rest.
|
|
2419
|
+
|
|
2420
|
+
No license is needed. A PrimeTek license or subscription for PrimeNG, its templates or its theme designer does not carry over, and is not required.
|
|
2421
|
+
|
|
2422
|
+
## Before you start
|
|
2423
|
+
|
|
2424
|
+
- **PrimeNG v21.** ExhaustiveUI shares its API. On v20 or older, upgrade to v21 first with PrimeNG's own update guides; the schematic checks the installed version and stops otherwise. On PrimeNG v22, the schematic runs, but the features PrimeNG added after v21 have no ExhaustiveUI equivalent: check the compiler errors and the report.
|
|
2425
|
+
- **A clean git working tree**, so every change can be reviewed and reverted on its own, and a build and test run that passes before you start.
|
|
2426
|
+
- **PrimeFlex**, if the project uses it, is not migrated by this schematic. Run `migrate-from-primeflex` afterwards to move its classes to Tailwind CSS; the schematic reminds you when it finds PrimeFlex.
|
|
2427
|
+
|
|
2428
|
+
## Migration steps
|
|
2429
|
+
|
|
2430
|
+
1. Update Angular to 22. PrimeNG v21 declares Angular 21 as its peer dependency, so the Angular CLI refuses the update while `primeng` is installed: pass `--force`. The next step removes `primeng`.
|
|
2431
|
+
2. Install ExhaustiveUI and run the `migrate-from-primeng` schematic. It rewrites the workspace, then installs the new dependencies.
|
|
2432
|
+
3. Run the v22 migrations. The workspace did not go through `ng update`, so they are run explicitly, from the version before v22.
|
|
2433
|
+
4. Read both reports, fix the compiler errors, then build and run your tests.
|
|
2434
|
+
|
|
2435
|
+
```bash
|
|
2436
|
+
ng update @angular/core@22 @angular/cli@22 --force
|
|
2437
|
+
npm install @exhaustive-ui/core@22
|
|
2438
|
+
ng generate @exhaustive-ui/core:migrate-from-primeng
|
|
2439
|
+
ng update @exhaustive-ui/core --migrate-only --from=3.0.0
|
|
2440
|
+
```
|
|
2441
|
+
|
|
2442
|
+
The schematic takes two options: `--skip-install` leaves the install to you, and `--force` skips the PrimeNG version check.
|
|
2443
|
+
|
|
2444
|
+
## What the schematic changes
|
|
2445
|
+
|
|
2446
|
+
The schematic visits every file of the workspace except `node_modules`, build output and the files your `.gitignore` excludes.
|
|
2447
|
+
|
|
2448
|
+
### Dependencies
|
|
2449
|
+
|
|
2450
|
+
In every `package.json` of the workspace, including `overrides` and `resolutions`, each package is replaced by its counterpart:
|
|
2451
|
+
|
|
2452
|
+
- `primeng` becomes `@exhaustive-ui/core`
|
|
2453
|
+
- `@primeuix/themes`, `@primeuix/styled`, `@primeuix/styles`, `@primeuix/utils` and `@primeuix/motion` become `@exhaustive-ui/themes`, `@exhaustive-ui/styled`, `@exhaustive-ui/styles`, `@exhaustive-ui/utils` and `@exhaustive-ui/motion`
|
|
2454
|
+
- `tailwindcss-primeui` becomes `@exhaustive-ui/tailwindcss`
|
|
2455
|
+
- `primelocale` becomes `@exhaustive-ui/locale`
|
|
2456
|
+
- `primeicons` becomes `@openng/icons`
|
|
2457
|
+
|
|
2458
|
+
### TypeScript
|
|
2459
|
+
|
|
2460
|
+
Imports, dynamic imports and `require()` calls are rewritten, subpaths included (`primeng/button` becomes `@exhaustive-ui/core/button`, `@primeuix/themes/aura` becomes
|
|
2461
|
+
`@exhaustive-ui/themes/aura`), and so is the Tailwind CSS configuration file. The configuration API is renamed where it is imported: `providePrimeNG` becomes `provideExhaustive`, the `PrimeNG` service becomes
|
|
2462
|
+
`Exhaustive`, `PrimeNGConfigType` becomes `ExhaustiveConfigType`, and the `PrimeIcons` constants become `OpenngIcons`.
|
|
2463
|
+
|
|
2464
|
+
```typescript
|
|
2465
|
+
// Before
|
|
2466
|
+
import { ApplicationConfig } from '@angular/core';
|
|
2467
|
+
import { providePrimeNG } from 'primeng/config';
|
|
2468
|
+
import Aura from '@primeuix/themes/aura';
|
|
2469
|
+
|
|
2470
|
+
export const appConfig: ApplicationConfig = {
|
|
2471
|
+
providers: [providePrimeNG({ theme: { preset: Aura } })]
|
|
2472
|
+
};
|
|
2473
|
+
|
|
2474
|
+
// After
|
|
2475
|
+
import { ApplicationConfig } from '@angular/core';
|
|
2476
|
+
import { provideExhaustive } from '@exhaustive-ui/core/config';
|
|
2477
|
+
import Aura from '@exhaustive-ui/themes/aura';
|
|
2478
|
+
|
|
2479
|
+
export const appConfig: ApplicationConfig = {
|
|
2480
|
+
providers: [provideExhaustive({ theme: { preset: Aura } })]
|
|
2481
|
+
};
|
|
2482
|
+
```
|
|
2483
|
+
|
|
2484
|
+
### Stylesheets and angular.json
|
|
2485
|
+
|
|
2486
|
+
`@import`, `@use`, `@plugin` and `url()` references in stylesheets, and the `styles` and `scripts` entries of `angular.json` and `project.json`, follow the new package names.
|
|
2487
|
+
`primeicons/primeicons.css` becomes `@openng/icons/openng-icons.css`; the `pi pi-*` classes in templates do not change.
|
|
2488
|
+
|
|
2489
|
+
### CSS cascade layer
|
|
2490
|
+
|
|
2491
|
+
When the theme sets `cssLayer`, the `primeng` layer becomes `exhaustive` in its `name` and `order`, `primeng-overwrites` becomes `exhaustive-overwrites`, and the matching
|
|
2492
|
+
`@layer` declarations in your stylesheets are renamed too, so your overrides keep their place in the layer order. With `cssLayer: true`, the configuration does not change, and only the stylesheets are renamed.
|
|
2493
|
+
|
|
2494
|
+
### The report
|
|
2495
|
+
|
|
2496
|
+
The schematic ends with the places that still mention `primeng`, `primeicons`, `@primeuix`, `tailwindcss-primeui` or `primelocale`, with the file and line: templates, Markdown, JSON or code it does not
|
|
2497
|
+
rewrite. Lockfiles are left out of the report, since the install regenerates them.
|
|
2498
|
+
|
|
2499
|
+
## Manual checks
|
|
2500
|
+
|
|
2501
|
+
Besides the places listed in the report, check these by hand:
|
|
2502
|
+
|
|
2503
|
+
- **The icon font name.** A stylesheet that names the font directly, as in `font-family: 'primeicons'`, now needs `'openng-icons'`. The schematic does not touch declaration values.
|
|
2504
|
+
- **Local variables named after PrimeNG**, such as `primeng = inject(PrimeNG)`: the type is renamed, the variable name is yours to keep or change.
|
|
2505
|
+
- **Module paths passed to other functions**, such as `jest.mock('primeng/button')` or `vi.mock()`: only imports, dynamic imports and `require()` are rewritten. These appear in the report.
|
|
2506
|
+
- **Build and deployment files** outside the TypeScript sources and stylesheets: Dockerfiles, CI scripts, CDN links to PrimeNG or PrimeIcons.
|
|
2507
|
+
- **PrimeTek products** such as templates or the theme designer are not part of ExhaustiveUI. A preset built with them is a plain `definePreset()` object and keeps working once its imports point to `@exhaustive-ui/themes`.
|
|
2508
|
+
|
|
2509
|
+
## What changes in v22
|
|
2510
|
+
|
|
2511
|
+
After the switch, the application runs on ExhaustiveUI v22, which differs from PrimeNG v21 in ways the compiler and your tests will show. The [migration guide to v22](https://exhaustive-ui.com/migration/v22)
|
|
2512
|
+
details each of them:
|
|
2513
|
+
|
|
2514
|
+
- Inputs, two-way properties, outputs and queries are signals: code holding a component instance reads inputs with a call and writes two-way properties with `.set()`.
|
|
2515
|
+
- Components use OnPush change detection, except Table, TreeTable and DynamicDialog: give them new arrays and objects, or signals, rather than mutating bound data.
|
|
2516
|
+
- Deprecated and inactive inputs are removed or renamed, `styleClass` becomes `class` on most components; the v22 migrations rewrite these bindings and report the rest.
|
|
2517
|
+
- Hundreds of bugs inherited from PrimeNG v21 are fixed, each with a regression test; a few of them change a visible behavior.
|
|
2518
|
+
|
|
2519
|
+
## Checklist
|
|
2520
|
+
|
|
2521
|
+
- Angular 22 installed, and no `primeng`, `@primeuix/*`, `primeicons`, `tailwindcss-primeui` or `primelocale` left in any `package.json`.
|
|
2522
|
+
- The report of `migrate-from-primeng` handled, then the report of the v22 migrations.
|
|
2523
|
+
- Icons render: the stylesheet is `@openng/icons/openng-icons.css` and nothing names the `primeicons` font.
|
|
2524
|
+
- With a CSS layer configured, your overrides still apply: the `@layer` names match the theme's `cssLayer` order.
|
|
2525
|
+
- The application compiles and its tests pass, after the code changes of the migration guide to v22.
|
|
2526
|
+
- PrimeFlex, if used, migrated with `migrate-from-primeflex`.
|
|
2527
|
+
|
|
2528
|
+
---
|
|
2529
|
+
|
|
2530
|
+
# Migrating from Optimus UI
|
|
2531
|
+
|
|
2532
|
+
Moving an Optimus UI v2 application to ExhaustiveUI: package and configuration API renames, the CSS layer name, then the v22 migrations.
|
|
2533
|
+
|
|
2534
|
+
## Overview
|
|
2535
|
+
|
|
2536
|
+
ExhaustiveUI is a fork of Optimus UI, itself the MIT continuation of PrimeNG v21. An Optimus UI v2 application already runs on Angular 22 and uses the same components, selectors, CSS classes, design tokens and
|
|
2537
|
+
`@openng/icons` icons. Moving it across takes two steps:
|
|
2538
|
+
|
|
2539
|
+
1. **The rename**: the `@openng/optimus-ui*` packages become `@exhaustive-ui/*`, and the four names of the configuration API change. The `migrate-from-optimus` schematic does it.
|
|
2540
|
+
2. **The v22 changes**: the Signals API everywhere, OnPush and the API cleanup of ExhaustiveUI v22. The `ng update` migrations do most of it, and the [migration guide to v22](https://exhaustive-ui.com/migration/v22) covers the rest.
|
|
2541
|
+
|
|
2542
|
+
## Before you start
|
|
2543
|
+
|
|
2544
|
+
- **Optimus UI v2 on Angular 22.** An application still on Optimus UI v1 updates to v2 first, following Optimus UI's documentation.
|
|
2545
|
+
- **A clean git working tree**, so the rename and the migrations can be reviewed on their own, and a build and test run that passes before you start.
|
|
2546
|
+
|
|
2547
|
+
## Migration steps
|
|
2548
|
+
|
|
2549
|
+
1. Install ExhaustiveUI and run the `migrate-from-optimus` schematic. It rewrites the workspace, then installs the new dependencies.
|
|
2550
|
+
2. Run the v22 migrations. The workspace did not go through `ng update`, so they are run explicitly, from the version before v22.
|
|
2551
|
+
3. Read both reports, fix the compiler errors, then build and run your tests.
|
|
2552
|
+
|
|
2553
|
+
```bash
|
|
2554
|
+
npm install @exhaustive-ui/core@22
|
|
2555
|
+
ng generate @exhaustive-ui/core:migrate-from-optimus
|
|
2556
|
+
ng update @exhaustive-ui/core --migrate-only --from=3.0.0
|
|
2557
|
+
```
|
|
2558
|
+
|
|
2559
|
+
The schematic checks that `@openng/optimus-ui` v2 is installed. It takes two options: `--skip-install` leaves the install to you, and `--force` skips the version check. Like `ng update`, run it on a clean
|
|
2560
|
+
working tree so its changes can be reviewed with `git diff`.
|
|
2561
|
+
|
|
2562
|
+
## What the schematic changes
|
|
2563
|
+
|
|
2564
|
+
The schematic visits every file of the workspace except `node_modules`, build output and the files your `.gitignore` excludes.
|
|
2565
|
+
|
|
2566
|
+
### Dependencies
|
|
2567
|
+
|
|
2568
|
+
In every `package.json` of the workspace, each package is replaced by its counterpart, which has the same content and the same subpaths:
|
|
2569
|
+
|
|
2570
|
+
- `@openng/optimus-ui` becomes `@exhaustive-ui/core`
|
|
2571
|
+
- `@openng/optimus-ui-themes`, `-tailwindcss`, `-locale`, `-styled`, `-styles`, `-utils` and `-motion` become `@exhaustive-ui/themes`, `tailwindcss`, `locale`, `styled`, `styles`, `utils` and `motion`
|
|
2572
|
+
- `@openng/icons` stays: ExhaustiveUI uses the same icon set.
|
|
2573
|
+
|
|
2574
|
+
### TypeScript
|
|
2575
|
+
|
|
2576
|
+
Imports, dynamic imports and `require()` calls are rewritten, subpaths included (`@openng/optimus-ui/button` becomes `@exhaustive-ui/core/button`), and so is the Tailwind CSS configuration file. The
|
|
2577
|
+
configuration API is renamed where it is imported from Optimus UI, along with every use in the file: `provideOptimus` becomes `provideExhaustive`, the `Optimus` service becomes `Exhaustive`,
|
|
2578
|
+
`OptimusConfigType` becomes `ExhaustiveConfigType` and `OPTIMUS_CONFIG` becomes `EXHAUSTIVE_CONFIG`. A class of your own that happens to be named `Optimus` is left alone.
|
|
2579
|
+
|
|
2580
|
+
```typescript
|
|
2581
|
+
// Before
|
|
2582
|
+
import { ApplicationConfig } from '@angular/core';
|
|
2583
|
+
import { provideOptimus } from '@openng/optimus-ui/config';
|
|
2584
|
+
import Aura from '@openng/optimus-ui-themes/aura';
|
|
2585
|
+
|
|
2586
|
+
export const appConfig: ApplicationConfig = {
|
|
2587
|
+
providers: [provideOptimus({ theme: { preset: Aura } })]
|
|
2588
|
+
};
|
|
2589
|
+
|
|
2590
|
+
// After
|
|
2591
|
+
import { ApplicationConfig } from '@angular/core';
|
|
2592
|
+
import { provideExhaustive } from '@exhaustive-ui/core/config';
|
|
2593
|
+
import Aura from '@exhaustive-ui/themes/aura';
|
|
2594
|
+
|
|
2595
|
+
export const appConfig: ApplicationConfig = {
|
|
2596
|
+
providers: [provideExhaustive({ theme: { preset: Aura } })]
|
|
2597
|
+
};
|
|
2598
|
+
```
|
|
2599
|
+
|
|
2600
|
+
### Stylesheets and angular.json
|
|
2601
|
+
|
|
2602
|
+
`@import`, `@use`, `@plugin` and `url()` references in stylesheets, and the `styles` and `scripts` entries of `angular.json` and `project.json`, follow the new package names.
|
|
2603
|
+
|
|
2604
|
+
### The report
|
|
2605
|
+
|
|
2606
|
+
The schematic ends with the places that still mention `optimus-ui`, `Optimus`, `provideOptimus`, `OptimusConfigType` or `OPTIMUS_CONFIG`, with the file and line: templates, Markdown, comments, or module paths
|
|
2607
|
+
passed to other functions, such as `jest.mock()`. Lockfiles are left out, since the install regenerates them.
|
|
2608
|
+
|
|
2609
|
+
## CSS layer
|
|
2610
|
+
|
|
2611
|
+
Optimus UI puts its styles in a CSS cascade layer named `optimus` when the theme enables `cssLayer`; ExhaustiveUI names it `exhaustive`. The schematic renames the `optimus` token in the `cssLayer`
|
|
2612
|
+
`name` and `order` of your configuration, then the matching `@layer` declarations and `@import ... layer()` clauses in your stylesheets, so your overrides keep their place in the layer order. With
|
|
2613
|
+
`cssLayer: true`, the configuration does not change, and only the stylesheets are renamed.
|
|
2614
|
+
|
|
2615
|
+
A layer of your own, with another name, is left as it is. The CSS classes (`p-button`...), the design tokens (`--p-primary-color`...) and the icon classes (`pi pi-check`...) do not change.
|
|
2616
|
+
|
|
2617
|
+
## v22 migrations
|
|
2618
|
+
|
|
2619
|
+
After `migrate-from-optimus`, run the v22 migrations. The workspace did not go through `ng update`, so they are run explicitly, from the version before v22:
|
|
2620
|
+
|
|
2621
|
+
```bash
|
|
2622
|
+
ng update @exhaustive-ui/core --migrate-only --from=3.0.0
|
|
2623
|
+
```
|
|
2624
|
+
|
|
2625
|
+
They rewrite the templates and code for the inputs, outputs and templates removed or renamed in v22, and for the configuration options that became signals or changed name, such as `inputStyle`, now `inputVariant`. They
|
|
2626
|
+
report what they cannot rewrite. The [migration guide to v22](https://exhaustive-ui.com/migration/v22) then covers the code changes: signal inputs, `model()` and signal queries in every component, OnPush change
|
|
2627
|
+
detection, and the behavior and type changes.
|
|
2628
|
+
|
|
2629
|
+
## Checklist
|
|
2630
|
+
|
|
2631
|
+
- No `@openng/optimus-ui*` package left in any `package.json`, and the report of `migrate-from-optimus` handled.
|
|
2632
|
+
- `provideExhaustive`, `Exhaustive`, `ExhaustiveConfigType` and `EXHAUSTIVE_CONFIG` in place of the Optimus names.
|
|
2633
|
+
- With a CSS layer configured, your overrides still apply.
|
|
2634
|
+
- The v22 migrations run and their report handled.
|
|
2635
|
+
- The application compiles and its tests pass, after the code changes of the migration guide to v22.
|
|
2636
|
+
|
|
2637
|
+
---
|
|
2638
|
+
|
|
2403
2639
|
# Migrating to v22
|
|
2404
2640
|
|
|
2405
2641
|
Moving an application to ExhaustiveUI v22: update steps from an ExhaustiveUI prerelease, PrimeNG v21 or Optimus UI, the automated migrations and their report, the Signals API, OnPush, removed API, behavior and type changes.
|
|
@@ -2442,20 +2678,23 @@ Update Angular to 22, install ExhaustiveUI and run the `migrate-from-primeng` sc
|
|
|
2442
2678
|
`@exhaustive-ui/core/button`) and renames the configuration API (`providePrimeNG` becomes `provideExhaustive`). The workspace did not go through `ng update`, so run the v22 migrations explicitly afterwards.
|
|
2443
2679
|
|
|
2444
2680
|
```bash
|
|
2445
|
-
ng update @angular/core@22 @angular/cli@22
|
|
2681
|
+
ng update @angular/core@22 @angular/cli@22 --force
|
|
2446
2682
|
npm install @exhaustive-ui/core@22
|
|
2447
2683
|
ng generate @exhaustive-ui/core:migrate-from-primeng
|
|
2448
2684
|
ng update @exhaustive-ui/core --migrate-only --from=3.0.0
|
|
2449
2685
|
```
|
|
2450
2686
|
|
|
2451
|
-
Projects on PrimeNG v20 or older upgrade to PrimeNG v21 first; the schematic checks the version and refuses otherwise.
|
|
2687
|
+
Projects on PrimeNG v20 or older upgrade to PrimeNG v21 first; the schematic checks the version and refuses otherwise. The [PrimeNG migration guide](https://exhaustive-ui.com/migration/primeng) details each step,
|
|
2688
|
+
including the `--force` the Angular update needs while `primeng` is installed.
|
|
2452
2689
|
|
|
2453
2690
|
### From Optimus UI v2
|
|
2454
2691
|
|
|
2455
|
-
Optimus UI v2 has the PrimeNG v21 API under other package names.
|
|
2456
|
-
|
|
2692
|
+
Optimus UI v2 has the PrimeNG v21 API under other package names. The `migrate-from-optimus` schematic swaps its packages for their `@exhaustive-ui/*` counterparts and renames the imports, the configuration API and the
|
|
2693
|
+
CSS layer; then run the v22 migrations explicitly. The [Optimus UI migration guide](https://exhaustive-ui.com/migration/optimus) details each step.
|
|
2457
2694
|
|
|
2458
2695
|
```bash
|
|
2696
|
+
npm install @exhaustive-ui/core@22
|
|
2697
|
+
ng generate @exhaustive-ui/core:migrate-from-optimus
|
|
2459
2698
|
ng update @exhaustive-ui/core --migrate-only --from=3.0.0
|
|
2460
2699
|
```
|
|
2461
2700
|
|
|
@@ -2684,6 +2923,11 @@ We encourage you to send pull requests, especially for issues tagged with the `h
|
|
|
2684
2923
|
Assist other users by participating in the issue tracker and [GitHub discussions](https://github.com/e-xiste/exhaustive-ui/discussions). Your expertise can help others solve
|
|
2685
2924
|
problems and improve their experience with ExhaustiveUI.
|
|
2686
2925
|
|
|
2926
|
+
## AI Contributions
|
|
2927
|
+
|
|
2928
|
+
Contributions written with AI coding agents are welcome, on the same terms as any other: the pull request is yours. You understand the change and can answer questions about it in review, it is scoped to one problem, and it comes with
|
|
2929
|
+
tests that fail without the fix. The repository ships what agents need: the `@exhaustive-ui/mcp` server, the `exhaustive-ui` agent skill and the LLM docs, generated from this site.
|
|
2930
|
+
|
|
2687
2931
|
## Pathway
|
|
2688
2932
|
|
|
2689
2933
|
ExhaustiveUI offers an organization structure involving contributors and the core team:
|
package/data/llms.txt
CHANGED
|
@@ -22,6 +22,8 @@ Machine-readable API (selectors, inputs, outputs, templates, types): https://exh
|
|
|
22
22
|
- [Philosophy](https://exhaustive-ui.com/philosophy): Why ExhaustiveUI exists, what it commits to, and where it stops.
|
|
23
23
|
- [FAQ](https://exhaustive-ui.com/faq): Licensing, migration from PrimeNG, the ecosystem, and how support works.
|
|
24
24
|
- [Update ExhaustiveUI](https://exhaustive-ui.com/migration/update): Updating with ng update, Angular version compatibility, and a summary of what changes in v22.
|
|
25
|
+
- [Migrating from PrimeNG](https://exhaustive-ui.com/migration/primeng): Moving a PrimeNG v21 application to ExhaustiveUI: the migrate-from-primeng schematic, what it changes (packages, imports, configuration API, icons, CSS layer), the manual checks and the v22 migrations.
|
|
26
|
+
- [Migrating from Optimus UI](https://exhaustive-ui.com/migration/optimus): Moving an Optimus UI v2 application to ExhaustiveUI: package and configuration API renames, the CSS layer name, then the v22 migrations.
|
|
25
27
|
- [Migrating to v22](https://exhaustive-ui.com/migration/v22): Moving an application to ExhaustiveUI v22: update steps from an ExhaustiveUI prerelease, PrimeNG v21 or Optimus UI, the automated migrations and their report, the Signals API, OnPush, removed API, behavior and type changes.
|
|
26
28
|
- [Contribution Guide](https://exhaustive-ui.com/contribution): How to contribute to ExhaustiveUI.
|
|
27
29
|
|
package/data/manifest.json
CHANGED
|
@@ -62,6 +62,11 @@ We encourage you to send pull requests, especially for issues tagged with the `h
|
|
|
62
62
|
Assist other users by participating in the issue tracker and [GitHub discussions](https://github.com/e-xiste/exhaustive-ui/discussions). Your expertise can help others solve
|
|
63
63
|
problems and improve their experience with ExhaustiveUI.
|
|
64
64
|
|
|
65
|
+
## AI Contributions
|
|
66
|
+
|
|
67
|
+
Contributions written with AI coding agents are welcome, on the same terms as any other: the pull request is yours. You understand the change and can answer questions about it in review, it is scoped to one problem, and it comes with
|
|
68
|
+
tests that fail without the fix. The repository ships what agents need: the `@exhaustive-ui/mcp` server, the `exhaustive-ui` agent skill and the LLM docs, generated from this site.
|
|
69
|
+
|
|
65
70
|
## Pathway
|
|
66
71
|
|
|
67
72
|
ExhaustiveUI offers an organization structure involving contributors and the core team:
|
package/data/pages/faq.md
CHANGED
|
@@ -41,12 +41,17 @@ Angular v22: ExhaustiveUI v22 requires Angular v22. Our majors follow Angular's
|
|
|
41
41
|
|
|
42
42
|
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
|
|
43
43
|
`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,
|
|
44
|
-
with file and line numbers. The [migration guide](https://
|
|
44
|
+
with file and line numbers. The [migration guide](https://exhaustive-ui.com/migration/primeng) covers the details and the manual cases.
|
|
45
45
|
|
|
46
46
|
### I am on PrimeNG v20 or older. Can I migrate directly?
|
|
47
47
|
|
|
48
48
|
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.
|
|
49
49
|
|
|
50
|
+
### I use Optimus UI. Can I switch?
|
|
51
|
+
|
|
52
|
+
Yes. ExhaustiveUI is a fork of Optimus UI, with the same components. On Optimus UI v2, run `ng generate @exhaustive-ui/core:migrate-from-optimus`: packages swapped, imports and configuration API renamed, CSS layer renamed,
|
|
53
|
+
dependencies installed. The [Optimus UI migration guide](https://exhaustive-ui.com/migration/optimus) covers the steps and the v22 migrations that follow.
|
|
54
|
+
|
|
50
55
|
### What happens to my PrimeNG license?
|
|
51
56
|
|
|
52
57
|
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
|