@exhaustive-ui/mcp 22.0.0-rc.2 → 22.0.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/data/components/accordion.md +1 -0
- package/data/components/autocomplete.md +59 -0
- package/data/components/cascadeselect.md +136 -0
- package/data/components/checkbox.md +56 -0
- package/data/components/colorpicker.md +49 -0
- package/data/components/confirmpopup.md +0 -7
- package/data/components/dataview.md +0 -2
- package/data/components/datepicker.md +52 -3
- package/data/components/drawer.md +1 -1
- package/data/components/editor.md +49 -0
- package/data/components/floatlabel.md +72 -0
- package/data/components/iftalabel.md +68 -0
- package/data/components/inputmask.md +54 -4
- package/data/components/inputnumber.md +52 -3
- package/data/components/inputotp.md +50 -0
- package/data/components/inputtext.md +63 -1
- package/data/components/knob.md +55 -0
- package/data/components/listbox.md +57 -2
- package/data/components/message.md +0 -1
- package/data/components/multiselect.md +59 -4
- package/data/components/orderlist.md +1 -3
- package/data/components/password.md +52 -3
- package/data/components/picklist.md +0 -3
- package/data/components/radiobutton.md +60 -0
- package/data/components/rating.md +49 -0
- package/data/components/select.md +58 -3
- package/data/components/selectbutton.md +50 -1
- package/data/components/slider.md +50 -0
- package/data/components/stepper.md +0 -1
- package/data/components/table.md +1 -1
- package/data/components/textarea.md +48 -0
- package/data/components/togglebutton.md +50 -0
- package/data/components/toggleswitch.md +49 -0
- package/data/components/tooltip.md +0 -1
- package/data/components/treeselect.md +61 -1
- package/data/components/treetable.md +1 -1
- package/data/components.json +774 -503
- package/data/llms-full.txt +3494 -819
- package/data/llms.txt +2 -1
- package/data/manifest.json +91 -476
- package/data/pages/accessibility.md +164 -6
- package/data/pages/animations.md +110 -5
- package/data/pages/configuration.md +107 -102
- package/data/pages/contribution.md +68 -7
- package/data/pages/customicons.md +8 -8
- package/data/pages/faq.md +103 -8
- package/data/pages/icons.md +24 -23
- package/data/pages/installation.md +77 -25
- package/data/pages/llms.md +71 -15
- package/data/pages/passthrough.md +96 -7
- package/data/pages/philosophy.md +80 -11
- package/data/pages/primeflex.md +41 -4
- package/data/pages/rtl.md +4 -1
- package/data/pages/styled.md +174 -66
- package/data/pages/tailwind.md +309 -218
- package/data/pages/unstyled.md +48 -7
- package/data/pages/update.md +42 -13
- package/data/pages/v22.md +218 -0
- package/data/snapshot.json +4 -4
- package/dist/index.mjs +72 -22
- package/dist/index.mjs.map +1 -1
- package/package.json +1 -1
|
@@ -2,19 +2,80 @@
|
|
|
2
2
|
|
|
3
3
|
How to contribute to ExhaustiveUI.
|
|
4
4
|
|
|
5
|
-
##
|
|
5
|
+
## Introduction
|
|
6
6
|
|
|
7
|
-
|
|
7
|
+
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.
|
|
8
8
|
|
|
9
|
-
|
|
9
|
+
### Development Setup
|
|
10
10
|
|
|
11
|
-
|
|
11
|
+
To begin with, clone the ExhaustiveUI repository from GitHub:
|
|
12
12
|
|
|
13
|
-
|
|
13
|
+
```typescript
|
|
14
|
+
git clone https://github.com/e-xiste/exhaustive-ui.git
|
|
15
|
+
cd exhaustive-ui
|
|
16
|
+
```
|
|
17
|
+
|
|
18
|
+
Then run the documentation app in your local environment at `http://localhost:4200/`.
|
|
19
|
+
|
|
20
|
+
```typescript
|
|
21
|
+
pnpm install
|
|
22
|
+
pnpm run dev
|
|
23
|
+
```
|
|
24
|
+
|
|
25
|
+
### Project Structure
|
|
26
|
+
|
|
27
|
+
ExhaustiveUI's project structure is organized as follows:
|
|
28
|
+
|
|
29
|
+
```typescript
|
|
30
|
+
- apps
|
|
31
|
+
- docs // this documentation website
|
|
32
|
+
- tailwind-playgrounds // Tailwind integration sandboxes
|
|
33
|
+
- packages
|
|
34
|
+
- core // components, directives and services
|
|
35
|
+
- themes // built-in theme presets
|
|
36
|
+
- styled // styled-mode theming engine
|
|
37
|
+
- styles // base styles
|
|
38
|
+
- tailwindcss // Tailwind CSS plugin
|
|
39
|
+
- locale // i18n locales
|
|
40
|
+
- motion // animation utilities
|
|
41
|
+
- utils // shared helpers
|
|
42
|
+
```
|
|
43
|
+
|
|
44
|
+
## Help Needed
|
|
45
|
+
|
|
46
|
+
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:
|
|
47
|
+
|
|
48
|
+
### Issue Triage
|
|
49
|
+
|
|
50
|
+
Help us manage issues by;
|
|
14
51
|
|
|
15
|
-
|
|
52
|
+
- Reproducing reported bugs
|
|
53
|
+
- Clarifying issue descriptions
|
|
54
|
+
- Tagging issues with appropriate labels
|
|
55
|
+
|
|
56
|
+
### Sending Pull Requests
|
|
57
|
+
|
|
58
|
+
We encourage you to send pull requests, especially for issues tagged with the `help-needed` label.
|
|
59
|
+
|
|
60
|
+
### Community Support
|
|
61
|
+
|
|
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
|
+
problems and improve their experience with ExhaustiveUI.
|
|
16
64
|
|
|
17
65
|
## Pathway
|
|
18
66
|
|
|
19
|
-
ExhaustiveUI offers an organization structure involving contributors and the core team:
|
|
67
|
+
ExhaustiveUI offers an organization structure involving contributors and the core team:
|
|
68
|
+
|
|
69
|
+
### Contributor Role
|
|
70
|
+
|
|
71
|
+
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.
|
|
72
|
+
|
|
73
|
+
### Committer Role
|
|
74
|
+
|
|
75
|
+
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.
|
|
76
|
+
|
|
77
|
+
## Benefits
|
|
78
|
+
|
|
79
|
+
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
|
|
80
|
+
yourself as a professional.
|
|
20
81
|
|
|
@@ -2,19 +2,19 @@
|
|
|
2
2
|
|
|
3
3
|
Use custom icons with ExhaustiveUI components.
|
|
4
4
|
|
|
5
|
-
##
|
|
5
|
+
## Material
|
|
6
6
|
|
|
7
|
-
|
|
7
|
+
[Material icons](https://fonts.google.com/icons) is the official icon library based on Google Material Design.
|
|
8
8
|
|
|
9
|
-
##
|
|
9
|
+
## Font Awesome
|
|
10
10
|
|
|
11
|
-
|
|
11
|
+
[Font Awesome](https://fontawesome.com/) is a popular icon library with a wide range of icons.
|
|
12
12
|
|
|
13
|
-
##
|
|
13
|
+
## SVG
|
|
14
14
|
|
|
15
|
-
|
|
15
|
+
Inline SVGs are embedded inside the dom.
|
|
16
16
|
|
|
17
|
-
##
|
|
17
|
+
## Image
|
|
18
18
|
|
|
19
|
-
|
|
19
|
+
Any type of image can be used as an icon.
|
|
20
20
|
|
package/data/pages/faq.md
CHANGED
|
@@ -2,19 +2,114 @@
|
|
|
2
2
|
|
|
3
3
|
Licensing, migration from PrimeNG, the ecosystem, and how support works.
|
|
4
4
|
|
|
5
|
-
##
|
|
5
|
+
## The Project
|
|
6
6
|
|
|
7
|
-
|
|
7
|
+
### Is ExhaustiveUI free? Will it stay free?
|
|
8
8
|
|
|
9
|
-
|
|
9
|
+
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
|
|
10
|
+
[philosophy page](https://exhaustive-ui.com/philosophy) goes into what that does and does not buy you.
|
|
10
11
|
|
|
11
|
-
|
|
12
|
+
### Is this an official PrimeNG fork? Are you affiliated with PrimeTek?
|
|
12
13
|
|
|
13
|
-
|
|
14
|
+
No. ExhaustiveUI is an independent community fork, not affiliated with, endorsed by, or sponsored by PrimeTek. It is a fork of
|
|
15
|
+
[Optimus UI](https://github.com/openng-org/optimus-ui) (OpenNG), itself a repository seeded with PrimeNG's MIT licensed code and history, not a fork of the archived
|
|
16
|
+
`primefaces/primeng` repository.
|
|
14
17
|
|
|
15
|
-
|
|
18
|
+
### Which PrimeNG version is this forked from?
|
|
16
19
|
|
|
17
|
-
|
|
20
|
+
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
|
|
21
|
+
number follows Angular's.
|
|
18
22
|
|
|
19
|
-
|
|
23
|
+
### Who maintains it, and how is it funded?
|
|
24
|
+
|
|
25
|
+
A small group of volunteers, with e-xiste covering hosting and the domain. We are deliberate about not implying more than that — see
|
|
26
|
+
[sustainability](https://exhaustive-ui.com/philosophy) for the honest version and the ways that can change.
|
|
27
|
+
|
|
28
|
+
### Why did the name change?
|
|
29
|
+
|
|
30
|
+
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
|
|
31
|
+
schematic rather than by asking you to rewrite imports by hand.
|
|
32
|
+
|
|
33
|
+
## Compatibility & Migration
|
|
34
|
+
|
|
35
|
+
### Which Angular versions are supported?
|
|
36
|
+
|
|
37
|
+
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
|
|
38
|
+
[version compatibility table](https://exhaustive-ui.com/migration/update) in the update guide.
|
|
39
|
+
|
|
40
|
+
### How do I migrate from PrimeNG? Is it automatic?
|
|
41
|
+
|
|
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
|
+
`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://v1.optimus.openng.org/migration/primeng) covers the details and the manual cases.
|
|
45
|
+
|
|
46
|
+
### I am on PrimeNG v20 or older. Can I migrate directly?
|
|
47
|
+
|
|
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
|
+
|
|
50
|
+
### What happens to my PrimeNG license?
|
|
51
|
+
|
|
52
|
+
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
|
|
53
|
+
over here.
|
|
54
|
+
|
|
55
|
+
### I had an open PR on primefaces/primeng. Can I bring it here?
|
|
56
|
+
|
|
57
|
+
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
|
|
58
|
+
cleanly.
|
|
59
|
+
|
|
60
|
+
### Can I run PrimeNG and ExhaustiveUI side by side?
|
|
61
|
+
|
|
62
|
+
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
|
|
63
|
+
configuration.
|
|
64
|
+
|
|
65
|
+
## Themes, Icons & Ecosystem
|
|
66
|
+
|
|
67
|
+
### Do the PrimeNG themes work?
|
|
68
|
+
|
|
69
|
+
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
|
|
70
|
+
migration schematic handles.
|
|
71
|
+
|
|
72
|
+
### What about the Theme Designer, templates and blocks?
|
|
73
|
+
|
|
74
|
+
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
|
|
75
|
+
full under [styled mode](https://exhaustive-ui.com/theming/styled).
|
|
76
|
+
|
|
77
|
+
### What replaced PrimeIcons?
|
|
78
|
+
|
|
79
|
+
[OpenNG Icons](https://exhaustive-ui.com/icons), installed as `@openng/icons`. The `pi pi-{icon}` class names are unchanged, so templates do not need editing — only the package name and the
|
|
80
|
+
stylesheet import, both of which the migration schematic rewrites.
|
|
81
|
+
|
|
82
|
+
### What about PrimeFlex?
|
|
83
|
+
|
|
84
|
+
PrimeFlex is not maintained here. We suggest Tailwind CSS instead, and ship `@exhaustive-ui/tailwindcss` for first-class integration — see the [Tailwind guide](https://exhaustive-ui.com/tailwind). The
|
|
85
|
+
[PrimeFlex guide](https://exhaustive-ui.com/guides/primeflex) covers moving across.
|
|
86
|
+
|
|
87
|
+
### Does ExhaustiveUI work with SSR?
|
|
88
|
+
|
|
89
|
+
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.
|
|
90
|
+
|
|
91
|
+
## Support & Contributing
|
|
92
|
+
|
|
93
|
+
### Is there commercial support?
|
|
94
|
+
|
|
95
|
+
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.
|
|
96
|
+
|
|
97
|
+
### How do I report a bug?
|
|
98
|
+
|
|
99
|
+
Open an issue on [GitHub](https://github.com/e-xiste/exhaustive-ui/issues) with a minimal reproduction — a StackBlitz from any demo on this site is ideal — plus your ExhaustiveUI,
|
|
100
|
+
Angular and browser versions. A reproduction is the difference between a bug that gets fixed and one that sits in the backlog.
|
|
101
|
+
|
|
102
|
+
### How do I request a feature?
|
|
103
|
+
|
|
104
|
+
Open a [discussion](https://github.com/e-xiste/exhaustive-ui/discussions). Requests are triaged and welcome, but in practice they ship when someone implements them. If it matters to
|
|
105
|
+
you, the [contribution guide](https://exhaustive-ui.com/contribution) is the fastest route.
|
|
106
|
+
|
|
107
|
+
### Where do I ask questions?
|
|
108
|
+
|
|
109
|
+
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.
|
|
110
|
+
|
|
111
|
+
### How does versioning work?
|
|
112
|
+
|
|
113
|
+
Semantic versioning, with majors tracking Angular majors. Breaking changes are confined to majors and documented in the
|
|
114
|
+
[GitHub releases](https://github.com/e-xiste/exhaustive-ui/releases).
|
|
20
115
|
|
package/data/pages/icons.md
CHANGED
|
@@ -2,13 +2,33 @@
|
|
|
2
2
|
|
|
3
3
|
OpenNG Icons is the default icon library of ExhaustiveUI with over 250 open source icons.
|
|
4
4
|
|
|
5
|
+
## Download
|
|
6
|
+
|
|
7
|
+
The icon library is available at npm, run the following command to download it to your project.
|
|
8
|
+
|
|
9
|
+
```bash
|
|
10
|
+
npm install @openng/icons
|
|
11
|
+
```
|
|
12
|
+
|
|
13
|
+
## Import
|
|
14
|
+
|
|
15
|
+
CSS file of the icon library needs to be imported in `styles.scss` of your application.
|
|
16
|
+
|
|
5
17
|
## Basic
|
|
6
18
|
|
|
7
|
-
OpenNG Icons use the pi pi-{icon} syntax such as pi pi-check
|
|
19
|
+
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`
|
|
20
|
+
|
|
21
|
+
## Size
|
|
22
|
+
|
|
23
|
+
Size of an icon is controlled with the font-size property of the element.
|
|
8
24
|
|
|
9
25
|
## Color
|
|
10
26
|
|
|
11
|
-
Icon color is defined with the color property which is inherited from parent by default.
|
|
27
|
+
Icon color is defined with the `color` property which is inherited from parent by default.
|
|
28
|
+
|
|
29
|
+
## Spin
|
|
30
|
+
|
|
31
|
+
Special `pi-spin` class applies infinite rotation to an icon.
|
|
12
32
|
|
|
13
33
|
## Constants
|
|
14
34
|
|
|
@@ -40,27 +60,8 @@ export class OpenngIconsConstantsDemo {
|
|
|
40
60
|
}
|
|
41
61
|
```
|
|
42
62
|
|
|
43
|
-
## Download
|
|
44
|
-
|
|
45
|
-
The icon library is available at npm, run the following command to download it to your project.
|
|
46
|
-
|
|
47
|
-
```bash
|
|
48
|
-
npm install @openng/icons
|
|
49
|
-
```
|
|
50
|
-
|
|
51
|
-
## Import
|
|
52
|
-
|
|
53
|
-
CSS file of the icon library needs to be imported in styles.scss of your application.
|
|
54
|
-
|
|
55
63
|
## List
|
|
56
64
|
|
|
57
|
-
Here is the full list of icons. More icons will be added periodically and you may also
|
|
58
|
-
|
|
59
|
-
## Size
|
|
60
|
-
|
|
61
|
-
Size of an icon is controlled with the font-size property of the element.
|
|
62
|
-
|
|
63
|
-
## Spin
|
|
64
|
-
|
|
65
|
-
Special pi-spin class applies infinite rotation to an icon.
|
|
65
|
+
Here is the full list of icons. More icons will be added periodically and you may also
|
|
66
|
+
[request new icons](https://github.com/openng-org/icons/issues) at the issue tracker.
|
|
66
67
|
|
|
@@ -2,48 +2,72 @@
|
|
|
2
2
|
|
|
3
3
|
Setting up ExhaustiveUI in an Angular CLI project.
|
|
4
4
|
|
|
5
|
-
##
|
|
5
|
+
## Prerequisites
|
|
6
6
|
|
|
7
|
-
|
|
7
|
+
ExhaustiveUI v22 targets Angular v22. Any workspace created with the Angular CLI works, standalone or NgModule based.
|
|
8
8
|
|
|
9
|
-
|
|
10
|
-
|
|
11
|
-
npm
|
|
9
|
+
- 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`)
|
|
10
|
+
- RxJS v7.8.1 or newer
|
|
11
|
+
- A package manager of your choice — npm, yarn or pnpm
|
|
12
12
|
|
|
13
|
-
|
|
14
|
-
|
|
13
|
+
Already using PrimeNG? Do not follow this page. The [migration guide](https://v1.optimus.openng.org/migration/primeng) covers moving an existing PrimeNG v21
|
|
14
|
+
workspace, once updated to Angular v22, across with the `migrate-from-primeng` schematic, which is a separate command from the `ng add` below.
|
|
15
15
|
|
|
16
|
-
|
|
17
|
-
|
|
16
|
+
## Angular Version Compatibility
|
|
17
|
+
|
|
18
|
+
Each ExhaustiveUI major targets a single Angular major. Install the version matching your workspace, and see the [update guide](https://exhaustive-ui.com/migration/update) when moving to a newer one.
|
|
19
|
+
|
|
20
|
+
## Install
|
|
21
|
+
|
|
22
|
+
The recommended way to add ExhaustiveUI to an Angular CLI workspace is a single command.
|
|
23
|
+
|
|
24
|
+
```bash
|
|
25
|
+
ng add @exhaustive-ui/core
|
|
18
26
|
```
|
|
19
27
|
|
|
20
|
-
|
|
28
|
+
The schematic asks which theme preset you want and then does the rest:
|
|
21
29
|
|
|
22
|
-
|
|
30
|
+
- adds `@exhaustive-ui/core` and `@exhaustive-ui/themes` to your dependencies
|
|
31
|
+
- wires `provideExhaustive` into your root providers with the chosen preset, in `app.config.ts` or your root NgModule
|
|
32
|
+
- installs the packages
|
|
23
33
|
|
|
24
|
-
|
|
34
|
+
Pass the preset up front to skip the prompt, or skip the install step if you want to run it yourself:
|
|
25
35
|
|
|
26
|
-
|
|
36
|
+
```bash
|
|
37
|
+
# Choose the preset without the prompt — Aura, Lara, Material or Nora
|
|
38
|
+
ng add @exhaustive-ui/core --theme=Lara
|
|
27
39
|
|
|
28
|
-
|
|
40
|
+
# Wire everything up but do not run the package install
|
|
41
|
+
ng add @exhaustive-ui/core --skip-install
|
|
29
42
|
|
|
30
|
-
|
|
43
|
+
# Target a specific project in a multi-project workspace
|
|
44
|
+
ng add @exhaustive-ui/core --project=admin
|
|
45
|
+
```
|
|
31
46
|
|
|
32
|
-
|
|
47
|
+
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
|
|
48
|
+
nothing and fails with an error rather than reporting success, and points you at the [migration guide](https://v1.optimus.openng.org/migration/primeng), which
|
|
49
|
+
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
|
|
50
|
+
migration schematic needs it there.
|
|
33
51
|
|
|
34
|
-
|
|
52
|
+
## Download
|
|
53
|
+
|
|
54
|
+
Prefer to wire things up yourself? Install the packages from the [npm registry](https://www.npmjs.com/package/@exhaustive-ui/core) directly. The next section covers the provider
|
|
55
|
+
setup that `ng add` would have written for you.
|
|
35
56
|
|
|
36
57
|
```bash
|
|
37
|
-
|
|
38
|
-
|
|
58
|
+
# Using npm
|
|
59
|
+
npm install @exhaustive-ui/core @exhaustive-ui/themes
|
|
39
60
|
|
|
40
|
-
|
|
61
|
+
# Using yarn
|
|
62
|
+
yarn add @exhaustive-ui/core @exhaustive-ui/themes
|
|
41
63
|
|
|
42
|
-
|
|
64
|
+
# Using pnpm
|
|
65
|
+
pnpm add @exhaustive-ui/core @exhaustive-ui/themes
|
|
66
|
+
```
|
|
43
67
|
|
|
44
68
|
## Provider
|
|
45
69
|
|
|
46
|
-
Add provideExhaustive to the list of providers in your app.config.ts and use the theme property to configure a theme such as Aura.
|
|
70
|
+
Add `provideExhaustive` to the list of providers in your `app.config.ts` and use the `theme` property to configure a theme such as Aura.
|
|
47
71
|
|
|
48
72
|
```typescript
|
|
49
73
|
import { ApplicationConfig } from '@angular/core';
|
|
@@ -61,11 +85,39 @@ export const appConfig: ApplicationConfig = {
|
|
|
61
85
|
};
|
|
62
86
|
```
|
|
63
87
|
|
|
88
|
+
## Icons
|
|
89
|
+
|
|
90
|
+
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
|
|
91
|
+
[OpenNG Icons](https://exhaustive-ui.com/icons), and component defaults such as the DatePicker arrows reference them too. Install it if you want the demos to look the way they do here.
|
|
92
|
+
|
|
93
|
+
```bash
|
|
94
|
+
npm install @openng/icons
|
|
95
|
+
```
|
|
96
|
+
|
|
97
|
+
Then import the stylesheet, either from your global stylesheet or from the `styles` array in `angular.json`.
|
|
98
|
+
|
|
99
|
+
```scss
|
|
100
|
+
@import "@openng/icons/openng-icons.css";
|
|
101
|
+
```
|
|
102
|
+
|
|
64
103
|
## Verify
|
|
65
104
|
|
|
66
|
-
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
|
|
105
|
+
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
|
|
106
|
+
corresponding component.
|
|
107
|
+
|
|
108
|
+
## Examples
|
|
109
|
+
|
|
110
|
+
Every example in this documentation opens in StackBlitz from the code toolbar above each demo, already wired up with the current version. The
|
|
111
|
+
[source repository](https://github.com/e-xiste/exhaustive-ui) is the reference for how the library itself is built and consumed.
|
|
112
|
+
|
|
113
|
+
## Next Steps
|
|
67
114
|
|
|
68
|
-
|
|
115
|
+
Once you have ExhaustiveUI up and running, we recommend exploring the following resources to gain a deeper understanding of the library.
|
|
69
116
|
|
|
70
|
-
|
|
117
|
+
- [Global configuration](https://exhaustive-ui.com/configuration)
|
|
118
|
+
- [Styled mode](https://exhaustive-ui.com/theming/styled) and [unstyled mode](https://exhaustive-ui.com/theming/unstyled)
|
|
119
|
+
- [Tailwind CSS integration](https://exhaustive-ui.com/tailwind)
|
|
120
|
+
- [Pass Through](https://exhaustive-ui.com/passthrough) for direct access to the underlying elements
|
|
121
|
+
- [Philosophy](https://exhaustive-ui.com/philosophy) — what this project promises, and what it does not
|
|
122
|
+
- [FAQ](https://exhaustive-ui.com/faq)
|
|
71
123
|
|
package/data/pages/llms.md
CHANGED
|
@@ -2,9 +2,37 @@
|
|
|
2
2
|
|
|
3
3
|
LLM-optimized documentation endpoints for ExhaustiveUI components.
|
|
4
4
|
|
|
5
|
-
##
|
|
5
|
+
## /llms.txt
|
|
6
6
|
|
|
7
|
-
The
|
|
7
|
+
The [llms.txt](https://llmstxt.org/) file is an industry standard that helps AI models better understand and navigate the ExhaustiveUI documentation. It lists key pages in a
|
|
8
|
+
structured format, making it easier for LLMs to retrieve relevant information.
|
|
9
|
+
|
|
10
|
+
[
|
|
11
|
+
|
|
12
|
+
](/llms/llms.txt)
|
|
13
|
+
|
|
14
|
+
## /llms-full.txt
|
|
15
|
+
|
|
16
|
+
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.
|
|
17
|
+
|
|
18
|
+
[
|
|
19
|
+
|
|
20
|
+
](/llms/llms-full.txt)
|
|
21
|
+
|
|
22
|
+
## .md extension
|
|
23
|
+
|
|
24
|
+
Add a `.md` to a page's URL to display a Markdown version of that page.
|
|
25
|
+
|
|
26
|
+
[
|
|
27
|
+
|
|
28
|
+
](/llms/components/button.md)
|
|
29
|
+
|
|
30
|
+
## Agent Skill
|
|
31
|
+
|
|
32
|
+
The markdown files above are also bundled as an [Agent Skill](https://agentskills.io), the `SKILL.md` format supported by coding agents such as Claude Code,
|
|
33
|
+
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.
|
|
34
|
+
|
|
35
|
+
Install it with the [skills CLI](https://skills.sh/docs/cli), which asks which agents to set it up for.
|
|
8
36
|
|
|
9
37
|
```bash
|
|
10
38
|
npx skills add https://exhaustive-ui.com
|
|
@@ -13,17 +41,53 @@ npx skills add https://exhaustive-ui.com
|
|
|
13
41
|
npx skills update exhaustive-ui
|
|
14
42
|
```
|
|
15
43
|
|
|
16
|
-
|
|
44
|
+
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
|
|
45
|
+
agent's skills directory.
|
|
46
|
+
|
|
47
|
+
[
|
|
48
|
+
|
|
49
|
+
](/llms/exhaustive-ui-skill.zip)
|
|
50
|
+
|
|
51
|
+
## MCP Server
|
|
17
52
|
|
|
18
|
-
|
|
53
|
+
[@exhaustive-ui/mcp](https://www.npmjs.com/package/@exhaustive-ui/mcp) is a
|
|
54
|
+
[Model Context Protocol](https://modelcontextprotocol.io) server that gives coding agents such as Claude Code, Cursor, Claude Desktop, VS Code Copilot and Codex
|
|
55
|
+
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
|
|
56
|
+
compiled API (unknown inputs or outputs, invalid literal values, unsupported two-way bindings, deprecated inputs, PrimeNG imports and selectors).
|
|
19
57
|
|
|
20
|
-
|
|
58
|
+
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
|
|
59
|
+
in the package and used when the network is unavailable.
|
|
21
60
|
|
|
22
|
-
|
|
61
|
+
Register it with Claude Code:
|
|
62
|
+
|
|
63
|
+
```bash
|
|
64
|
+
claude mcp add exhaustive-ui -s user -- npx -y @exhaustive-ui/mcp
|
|
65
|
+
```
|
|
66
|
+
|
|
67
|
+
Or add it to the MCP configuration of your client (`.cursor/mcp.json`, `claude_desktop_config.json`, `.vscode/mcp.json` with a `servers` key, ...):
|
|
68
|
+
|
|
69
|
+
```typescript
|
|
70
|
+
{
|
|
71
|
+
"mcpServers": {
|
|
72
|
+
"exhaustive-ui": {
|
|
73
|
+
"command": "npx",
|
|
74
|
+
"args": ["-y", "@exhaustive-ui/mcp"]
|
|
75
|
+
}
|
|
76
|
+
}
|
|
77
|
+
}
|
|
78
|
+
```
|
|
79
|
+
|
|
80
|
+
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
|
|
81
|
+
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
|
|
82
|
+
`EXHAUSTIVE_UI_MCP_OFFLINE=1` to only use the bundled snapshot. The package README lists every option.
|
|
23
83
|
|
|
24
84
|
## Manifest
|
|
25
85
|
|
|
26
|
-
/llms/manifest.json describes every component, directive, NgModule, service and exported type as structured data, for tools that need exact facts rather than prose:
|
|
86
|
+
[/llms/manifest.json](/llms/manifest.json) describes every component, directive, NgModule, service and exported type as structured data, for tools that need exact facts rather than prose:
|
|
87
|
+
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.
|
|
88
|
+
|
|
89
|
+
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,
|
|
90
|
+
templates with their context type, methods, forms support and pass-through keys.
|
|
27
91
|
|
|
28
92
|
```typescript
|
|
29
93
|
{
|
|
@@ -51,11 +115,3 @@ The llms.txt file is an industry standard that helps AI models better understand
|
|
|
51
115
|
}
|
|
52
116
|
```
|
|
53
117
|
|
|
54
|
-
## Markdownextension
|
|
55
|
-
|
|
56
|
-
Add a .md to a page's URL to display a Markdown version of that page.
|
|
57
|
-
|
|
58
|
-
## Mcp
|
|
59
|
-
|
|
60
|
-
@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.
|
|
61
|
-
|