@exhaustive-ui/mcp 22.0.0-alpha.1 → 22.0.0-alpha.11

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.
Files changed (45) hide show
  1. package/README.md +18 -18
  2. package/data/components/accordion.md +1 -1
  3. package/data/components/autocomplete.md +1 -1
  4. package/data/components/autofocus.md +1 -1
  5. package/data/components/breadcrumb.md +1 -0
  6. package/data/components/button.md +3 -1
  7. package/data/components/confirmdialog.md +1 -1
  8. package/data/components/datepicker.md +3 -2
  9. package/data/components/image.md +216 -0
  10. package/data/components/listbox.md +1 -1
  11. package/data/components/llms.md +1 -1
  12. package/data/components/orderlist.md +3 -1
  13. package/data/components/password.md +1 -0
  14. package/data/components/picklist.md +1 -1
  15. package/data/components/splitter.md +1 -0
  16. package/data/components/styleclass.md +1 -1
  17. package/data/components/tabs.md +1 -1
  18. package/data/components/tree.md +1 -1
  19. package/data/components/treeselect.md +2 -1
  20. package/data/components.json +897 -268
  21. package/data/llms-full.txt +1007 -149
  22. package/data/llms.txt +2 -0
  23. package/data/manifest.json +137 -11
  24. package/data/pages/accessibility.md +7 -7
  25. package/data/pages/animations.md +7 -7
  26. package/data/pages/configuration.md +10 -14
  27. package/data/pages/contribution.md +4 -4
  28. package/data/pages/customicons.md +4 -4
  29. package/data/pages/faq.md +6 -6
  30. package/data/pages/icons.md +9 -9
  31. package/data/pages/installation.md +12 -12
  32. package/data/pages/llms.md +7 -7
  33. package/data/pages/passthrough.md +7 -7
  34. package/data/pages/philosophy.md +6 -6
  35. package/data/pages/primeflex.md +5 -5
  36. package/data/pages/rtl.md +2 -2
  37. package/data/pages/styled.md +29 -29
  38. package/data/pages/tailwind.md +610 -9
  39. package/data/pages/unstyled.md +4 -4
  40. package/data/pages/update.md +34 -0
  41. package/data/snapshot.json +4 -4
  42. package/dist/index.d.mts +1 -1
  43. package/dist/index.mjs +231 -10
  44. package/dist/index.mjs.map +1 -1
  45. package/package.json +1 -1
package/README.md CHANGED
@@ -85,16 +85,16 @@ args = ["-y", "@exhaustive-ui/mcp"]
85
85
 
86
86
  ## Tools
87
87
 
88
- | Tool | Purpose |
89
- | ---------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
90
- | `list` | List components, directives, guides, code examples or MCP resources (`kind`, `limit`, `offset`). |
91
- | `search` | Search component docs, guides, API members (inputs, outputs, templates, PT keys, CSS classes, tokens) and code examples (`query`, `scope`). |
92
- | `get_component` | Read a component: selectors, import path, sections, available examples; optionally its API and compiled declarations (`includeApi`), example code (`includeExamples`) and the full Markdown document (`detail: "full"`). Accepts a batch of up to 10 `components`. |
93
- | `get_guide` | Read a guide by name or route (`installation`, `configuration`, `theming/styled`, `tailwind`, `guides/accessibility`...), optionally one `section` or the full document. |
94
- | `get_example` | Return one complete, source-backed code example of a component (a standalone Angular component with template and imports), by `section` or feature `variant`. |
95
- | `get_setup` | Return the setup guidance for an `environment`: `angular-cli` (default), `configuration`, `styled`, `unstyled`, `tailwind`, `icons`, `custom-icons`, `passthrough`. |
96
- | `validate_usage` | Check an Angular template or component source against the compiled API of a component: unknown inputs and outputs, invalid literal values, unsupported two-way bindings, deprecated inputs, wrong selectors and PrimeNG imports. Accepts a batch of `usages`. |
97
- | `version` | Return the server version, the documented library version, where the docs are read from (live site, cache, offline snapshot) and the registered tools, resources and prompts. |
88
+ | Tool | Purpose |
89
+ | ---------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
90
+ | `list` | List components, directives, guides, code examples or MCP resources (`kind`, `limit`, `offset`). |
91
+ | `search` | Search component docs, guides, API members (inputs, outputs, templates, PT keys, CSS classes, tokens) and code examples (`query`, `scope`). |
92
+ | `get_component` | Read a component: selectors, import path, sections, available examples; optionally its API and compiled declarations (`includeApi`), example code (`includeExamples`) and the full Markdown document (`detail: "full"`). Accepts a batch of up to 10 `components`. |
93
+ | `get_guide` | Read a guide by name or route (`installation`, `configuration`, `theming/styled`, `tailwind`, `guides/accessibility`...), optionally one `section` or the full document. |
94
+ | `get_example` | Return one complete, source-backed code example of a component (a standalone Angular component with template and imports), by `section` or feature `variant`. |
95
+ | `get_setup` | Return the setup guidance for an `environment`: `angular-cli` (default), `configuration`, `styled`, `unstyled`, `tailwind`, `icons`, `custom-icons`, `passthrough`. |
96
+ | `validate_usage` | Check an Angular template or component source against the compiled API of a component: unknown inputs and outputs, invalid literal values, unsupported two-way bindings, deprecated inputs, inputs and outputs removed or renamed in v22 (with their replacement), wrong selectors and PrimeNG imports. Accepts a batch of `usages`. |
97
+ | `version` | Return the server version, the documented library version, where the docs are read from (live site, cache, offline snapshot) and the registered tools, resources and prompts. |
98
98
 
99
99
  Component names are resolved loosely: `button`, `p-button`, `Button`, `[pTooltip]`, `@exhaustive-ui/core/select`, a docs URL, and the PrimeNG names of renamed components (`dropdown`, `calendar`, `sidebar`, `overlaypanel`, `inputswitch`, `tabview`...) all work.
100
100
 
@@ -116,7 +116,7 @@ Resource templates:
116
116
  - `guide-docs`: `exhaustive-ui://docs/pages/{guide}.md`
117
117
  - `example-docs`: `exhaustive-ui://docs/examples/{component}/{section}.md`
118
118
 
119
- Prompts: `use_component`, `build_form`, `theme_component`, `migrate_from_primeng`, `audit_component_usage`.
119
+ Prompts: `use_component`, `build_form`, `theme_component`, `migrate_from_primeng`, `update_to_v22`, `audit_component_usage`.
120
120
 
121
121
  ## Where the docs come from
122
122
 
@@ -126,13 +126,13 @@ The server reads these files from the live site at runtime and keeps them in mem
126
126
 
127
127
  ## Environment variables
128
128
 
129
- | Variable | Default | Purpose |
130
- | --------------------------------- | ----------------------------------- | ------------------------------------------------------------------------------ |
131
- | `EXHAUSTIVE_UI_DOCS_URL` | `https://exhaustive-ui.com` | Docs site to read from, for instance a local `ng serve` of the docs app. |
132
- | `EXHAUSTIVE_UI_MCP_CACHE_TTL` | `900` | Seconds a fetched document is reused before it is fetched again. |
133
- | `EXHAUSTIVE_UI_MCP_FETCH_TIMEOUT` | `10000` | Milliseconds before a request to the docs site is abandoned. |
134
- | `EXHAUSTIVE_UI_MCP_OFFLINE` | unset | Set to `1` to never contact the site and only use the bundled snapshot. |
135
- | `EXHAUSTIVE_UI_MCP_SNAPSHOT_DIR` | the package's `data/` directory | Directory of the offline snapshot (a copy of the site's `/llms/` directory). |
129
+ | Variable | Default | Purpose |
130
+ | --------------------------------- | ------------------------------- | ---------------------------------------------------------------------------- |
131
+ | `EXHAUSTIVE_UI_DOCS_URL` | `https://exhaustive-ui.com` | Docs site to read from, for instance a local `ng serve` of the docs app. |
132
+ | `EXHAUSTIVE_UI_MCP_CACHE_TTL` | `900` | Seconds a fetched document is reused before it is fetched again. |
133
+ | `EXHAUSTIVE_UI_MCP_FETCH_TIMEOUT` | `10000` | Milliseconds before a request to the docs site is abandoned. |
134
+ | `EXHAUSTIVE_UI_MCP_OFFLINE` | unset | Set to `1` to never contact the site and only use the bundled snapshot. |
135
+ | `EXHAUSTIVE_UI_MCP_SNAPSHOT_DIR` | the package's `data/` directory | Directory of the offline snapshot (a copy of the site's `/llms/` directory). |
136
136
 
137
137
  Example, Claude Code pointed at a local docs server:
138
138
 
@@ -166,7 +166,7 @@ export class AccordionDisabledDemo {}
166
166
 
167
167
  ## Dynamic
168
168
 
169
- AccordionPanel can be generated dynamically using the standard @for block.
169
+ AccordionPanel can be generated dynamically using the standard @for block.
170
170
 
171
171
  ```typescript
172
172
  import { Component } from '@angular/core';
@@ -640,7 +640,7 @@ export class AutocompleteMultipleDemo {
640
640
 
641
641
  ## Objects
642
642
 
643
- AutoComplete can also work with objects using the optionLabel property that defines the label to display as a suggestion. The value passed to the model would still be the object instance of a suggestion. Here is an example with a Country object that has name and code fields such as {name: "United States", code:"USA"} .
643
+ AutoComplete can also work with objects using the optionLabel property that defines the label to display as a suggestion. The value passed to the model would still be the object instance of a suggestion. Here is an example with a Country object that has name and code fields such as {name: "United States", code:"USA"} .
644
644
 
645
645
  ```typescript
646
646
  import { Component, OnInit, inject } from '@angular/core';
@@ -30,7 +30,7 @@ AutoFocus manages focus on focusable element on load.
30
30
 
31
31
  | Name | Type | Default | Description |
32
32
  |------|------|---------|-------------|
33
- | autofocus | InputSignal<boolean> | ... | When present, it specifies that the component should automatically get focus on load. |
33
+ | autofocus | InputSignalWithTransform<boolean, unknown> | ... | When present, it specifies that the component should automatically get focus on load. |
34
34
  | dt | InputSignal<Object> | undefined | Defines scoped design tokens of the component. |
35
35
  | unstyled | InputSignal<boolean> | undefined | Indicates whether the component should be rendered without styles. |
36
36
  | pt | InputSignal<any> | undefined | Used to pass attributes to DOM elements inside the component. |
@@ -112,6 +112,7 @@ Breadcrumb provides contextual information about page hierarchy.
112
112
  | styleClass | InputSignal<string> | ... | Style class of the component. |
113
113
  | home | InputSignal<MenuItem> | ... | MenuItem configuration for the home icon. |
114
114
  | homeAriaLabel | InputSignal<string> | ... | Defines a string that labels the home icon for accessibility. Defaults to the `aria.home` translation when the home item has no visible label. |
115
+ | ariaLabel | InputSignal<string> | 'Breadcrumb' | Defines a string that labels the nav landmark for accessibility. Give each breadcrumb on a page a distinct label. |
115
116
 
116
117
  ### Emits
117
118
 
@@ -542,8 +542,10 @@ Button is an extension to standard button element with icons and theming.
542
542
  | variant | InputSignal<"text" \| "outlined"> | ... | Specifies the variant of the component. |
543
543
  | style | InputSignal<{ [klass: string]: any }> | ... | Inline style of the element. |
544
544
  | styleClass | InputSignal<string> | ... | Class of the element. |
545
- | badgeSeverity | InputSignal<"success" \| "info" \| "warn" \| "danger" \| "secondary" \| "contrast" \| "help" \| "primary"> | secondary | Severity type of the badge. |
545
+ | badgeSeverity | InputSignal<"primary" \| "success" \| "info" \| "warn" \| "danger" \| "secondary" \| "contrast" \| "help"> | secondary | Severity type of the badge. |
546
546
  | ariaLabel | InputSignal<string> | ... | Used to define a string that autocomplete attribute the current element. |
547
+ | ariaExpanded | InputSignal<boolean> | ... | Value of the aria-expanded attribute of the button, for a button that shows or hides an element. |
548
+ | ariaControls | InputSignal<string> | ... | Id of the element the button controls, set as its aria-controls attribute. |
547
549
  | autofocus | InputSignalWithTransform<boolean, unknown> | ... | When present, it specifies that the component should automatically get focus on load. |
548
550
  | iconPos | InputSignal<ButtonIconPosition> | ... | Position of the icon. |
549
551
  | icon | InputSignal<string> | ... | Name of the icon. |
@@ -251,7 +251,7 @@ ConfirmDialog uses a Dialog UI that is integrated with the Confirmation API.
251
251
  | Name | Type | Description |
252
252
  |------|------|-------------|
253
253
  | host | PassThroughOption<HTMLElement, I> | Used to pass attributes to the host's DOM element. |
254
- | root | DialogPassThrough | Used to pass attributes to the root's DOM element. |
254
+ | root | PassThroughOption<HTMLDivElement, I> | Used to pass attributes to the root's DOM element. |
255
255
  | mask | PassThroughOption<HTMLDivElement, I> | Used to pass attributes to the mask's DOM element. |
256
256
  | icon | PassThroughOption<HTMLElement, I> | Used to pass attributes to the icon's DOM element. |
257
257
  | message | PassThroughOption<HTMLSpanElement, I> | Used to pass attributes to the message's DOM element. |
@@ -322,7 +322,7 @@ export class DatepickerFluidDemo {
322
322
 
323
323
  ## Format
324
324
 
325
- Default date format is mm/dd/yy which can be customized using the dateFormat property. Following options can be a part of the format. d - day of month (no leading zero) dd - day of month (two digit) o - day of the year (no leading zeros) oo - day of the year (three digit) D - day name short DD - day name long m - month of year (no leading zero) mm - month of year (two digit) M - month name short MM - month name long y - year (two digit) yy - year (four digit) &#64; - Unix timestamp (ms since 01/01/1970) ! - Windows ticks (100ns since 01/01/0001) '...' - literal text '' - single quote anything else - literal text
325
+ Default date format is mm/dd/yy which can be customized using the dateFormat property. Following options can be a part of the format. d - day of month (no leading zero) dd - day of month (two digit) o - day of the year (no leading zeros) oo - day of the year (three digit) D - day name short DD - day name long m - month of year (no leading zero) mm - month of year (two digit) M - month name short MM - month name long y - year (two digit) yy - year (four digit) @ - Unix timestamp (ms since 01/01/1970) ! - Windows ticks (100ns since 01/01/0001) '...' - literal text '' - single quote anything else - literal text
326
326
 
327
327
  ```typescript
328
328
  import { Component } from '@angular/core';
@@ -985,6 +985,7 @@ DatePicker is a form component to work with dates.
985
985
  | placeholder | InputSignal<string> | ... | Placeholder text for the input. |
986
986
  | ariaLabelledBy | InputSignal<string> | ... | Establishes relationships between the component and label(s) where its value should be one or more element IDs. |
987
987
  | ariaLabel | InputSignal<string> | ... | Defines a string that labels the input for accessibility. |
988
+ | ariaDescribedBy | InputSignal<string> | ... | Establishes relationships between the input and the element(s) that describe it, as one or more element IDs. |
988
989
  | iconAriaLabel | InputSignal<string> | ... | Defines a string that labels the icon button for accessibility. |
989
990
  | dateFormat | InputSignal<string> | ... | Format of the date which can also be defined at locale settings. |
990
991
  | multipleSeparator | InputSignal<string> | ... | Separator for multiple selection mode. |
@@ -996,7 +997,7 @@ DatePicker is a form component to work with dates.
996
997
  | icon | InputSignal<string> | ... | Icon of the datepicker button. |
997
998
  | readonlyInput | InputSignalWithTransform<boolean, unknown> | ... | When specified, prevents entering the date manually with keyboard. |
998
999
  | shortYearCutoff | InputSignal<any> | ... | The cutoff year for determining the century for a date. |
999
- | hourFormat | InputSignal<string> | ... | Specifies 12 or 24 hour format. |
1000
+ | hourFormat | InputSignalWithTransform<string, string \| number> | ... | Specifies 12 or 24 hour format. |
1000
1001
  | timeOnly | InputSignalWithTransform<boolean, unknown> | ... | Whether to display timepicker only. |
1001
1002
  | stepHour | InputSignalWithTransform<number, unknown> | ... | Hours to change per step. |
1002
1003
  | stepMinute | InputSignalWithTransform<number, unknown> | ... | Minutes to change per step. |
@@ -0,0 +1,216 @@
1
+ # Angular Image Component
2
+
3
+ Displays an image with preview and tranformation options.
4
+
5
+ ## Accessibility
6
+
7
+ Screen Reader The preview button is a native button element with an aria-label that refers to the aria.zoomImage property of the locale API by default. When preview is active, dialog role with aria-modal is applied to the overlay image container. Button controls use aria.rotateRight , aria.rotateLeft , aria.zoomIn , aria.zoomOut and aria.close from the locale API as aria-label . ButtonBar Keyboard Support When preview is activated, close button receives the initial focus. Key Function tab Moves focus through button bar. enter Activates the button. space Activates the button. esc Closes the image preview.
8
+
9
+ ## Basic
10
+
11
+ Image is used as the native img element and supports all properties that the native element has. For multiple image, see Galleria.
12
+
13
+ ```typescript
14
+ import { Component } from '@angular/core';
15
+ import { ImageModule } from '@exhaustive-ui/core/image';
16
+
17
+ @Component({
18
+ template: `
19
+ <div class="card flex justify-center">
20
+ <p-image src="https://exhaustive-ui.com/demo/galleria/galleria10.jpg" alt="Image" width="250" />
21
+ </div>
22
+ `,
23
+ standalone: true,
24
+ imports: [ImageModule]
25
+ })
26
+ export class ImageBasicDemo {}
27
+ ```
28
+
29
+ ## Preview
30
+
31
+ Preview mode displays a modal layer when the image is clicked that provides transformation options such as rotating and zooming.
32
+
33
+ ```typescript
34
+ import { Component } from '@angular/core';
35
+ import { ImageModule } from '@exhaustive-ui/core/image';
36
+
37
+ @Component({
38
+ template: `
39
+ <div class="card flex justify-center">
40
+ <p-image src="https://exhaustive-ui.com/demo/galleria/galleria10.jpg" alt="Image" width="250" [preview]="true" />
41
+ </div>
42
+ `,
43
+ standalone: true,
44
+ imports: [ImageModule]
45
+ })
46
+ export class ImagePreviewDemo {}
47
+ ```
48
+
49
+ ## previewimagesource-doc
50
+
51
+ In case that you want to show different image on preview, you can set previewImageSrc attribute. It could come handy when wanted to use smaller image version at first and bigger one on preview.
52
+
53
+ ```typescript
54
+ import { Component } from '@angular/core';
55
+ import { ImageModule } from '@exhaustive-ui/core/image';
56
+
57
+ @Component({
58
+ template: `
59
+ <div class="card flex justify-center">
60
+ <p-image src="https://exhaustive-ui.com/demo/galleria/galleria11.jpg" previewImageSrc="https://exhaustive-ui.com/demo/galleria/galleria11.jpg" alt="Image" width="250" [preview]="true" />
61
+ </div>
62
+ `,
63
+ standalone: true,
64
+ imports: [ImageModule]
65
+ })
66
+ export class ImagePreviewimagesourceDemo {}
67
+ ```
68
+
69
+ ## Template
70
+
71
+ An eye icon is displayed by default when the image is hovered in preview mode. Use the indicator template for custom content.
72
+
73
+ ```typescript
74
+ import { Component } from '@angular/core';
75
+ import { ImageModule } from '@exhaustive-ui/core/image';
76
+
77
+ @Component({
78
+ template: `
79
+ <div class="card flex justify-center">
80
+ <p-image src="https://exhaustive-ui.com/demo/galleria/galleria11.jpg" [preview]="true" alt="Image" width="250">
81
+ <ng-template #indicator>
82
+ <i class="pi pi-search"></i>
83
+ </ng-template>
84
+ <ng-template #image>
85
+ <img src="https://exhaustive-ui.com/demo/galleria/galleria11.jpg" alt="image" width="250" />
86
+ </ng-template>
87
+ <ng-template #preview let-style="style" let-previewCallback="previewCallback">
88
+ <img src="https://exhaustive-ui.com/demo/galleria/galleria11.jpg" alt="image" [style]="style" (click)="previewCallback()" />
89
+ </ng-template>
90
+ </p-image>
91
+ </div>
92
+ `,
93
+ standalone: true,
94
+ imports: [ImageModule]
95
+ })
96
+ export class ImageTemplateDemo {}
97
+ ```
98
+
99
+ ## Image
100
+
101
+ Displays an image with preview and tranformation options. For multiple image, see Galleria.
102
+
103
+ ### Props
104
+
105
+ | Name | Type | Default | Description |
106
+ |------|------|---------|-------------|
107
+ | dt | InputSignal<Object> | undefined | Defines scoped design tokens of the component. |
108
+ | unstyled | InputSignal<boolean> | undefined | Indicates whether the component should be rendered without styles. |
109
+ | pt | InputSignal<ImagePassThrough> | undefined | Used to pass attributes to DOM elements inside the component. |
110
+ | ptOptions | InputSignal<PassThroughOptions> | undefined | Used to configure passthrough(pt) options of the component. |
111
+ | imageClass | InputSignal<string> | ... | Style class of the image element. |
112
+ | imageStyle | InputSignal<{ [klass: string]: any }> | ... | Inline style of the image element. |
113
+ | src | InputSignal<string \| SafeUrl> | ... | The source path for the main image. |
114
+ | srcSet | InputSignal<string \| SafeUrl> | ... | The srcset definition for the main image. |
115
+ | sizes | InputSignal<string> | ... | The sizes definition for the main image. |
116
+ | previewImageSrc | InputSignal<string \| SafeUrl> | ... | The source path for the preview image. |
117
+ | previewImageSrcSet | InputSignal<string \| SafeUrl> | ... | The srcset definition for the preview image. |
118
+ | previewImageSizes | InputSignal<string> | ... | The sizes definition for the preview image. |
119
+ | alt | InputSignal<string> | ... | Attribute of the preview image element. |
120
+ | previewAriaLabel | InputSignal<string> | ... | Accessible name of the preview dialog. Defaults to the alt text, then to the zoomImage ARIA translation. |
121
+ | width | InputSignal<string> | ... | Attribute of the image element. |
122
+ | height | InputSignal<string> | ... | Attribute of the image element. |
123
+ | loading | InputSignal<"eager" \| "lazy"> | ... | Attribute of the image element. |
124
+ | preview | InputSignalWithTransform<boolean, unknown> | ... | Controls the preview functionality. |
125
+ | appendTo | InputSignal<any> | 'self' | Target element to attach the overlay, valid values are "body" or a local ng-template variable of another element (note: use binding with brackets for template variables, e.g. [appendTo]="mydiv" for a div element having #mydiv as variable name). |
126
+ | maskMotionOptions | InputSignal<MotionOptions> | ... | The motion options for the mask. |
127
+ | motionOptions | InputSignal<MotionOptions> | ... | The motion options. |
128
+
129
+ ### Emits
130
+
131
+ | Name | Parameters | Description |
132
+ |------|------------|-------------|
133
+ | onShow | value: any | Triggered when the preview overlay is shown. |
134
+ | onHide | value: any | Triggered when the preview overlay is hidden. |
135
+ | onImageError | event: Event | This event is triggered if an error occurs while loading an image file. |
136
+
137
+ ### Templates
138
+
139
+ | Name | Type | Description |
140
+ |------|------|-------------|
141
+ | indicator | TemplateRef<void> | Custom indicator template. |
142
+ | rotaterighticon | TemplateRef<void> | Custom rotate right icon template. |
143
+ | rotatelefticon | TemplateRef<void> | Custom rotate left icon template. |
144
+ | zoomouticon | TemplateRef<void> | Custom zoom out icon template. |
145
+ | zoominicon | TemplateRef<void> | Custom zoom in icon template. |
146
+ | closeicon | TemplateRef<void> | Custom close icon template. |
147
+ | preview | TemplateRef<ImagePreviewTemplateContext> | Custom preview template. |
148
+ | image | TemplateRef<ImageImageTemplateContext> | Custom image template. |
149
+
150
+ ## Pass Through Options
151
+
152
+ | Name | Type | Description |
153
+ |------|------|-------------|
154
+ | root | PassThroughOption<HTMLSpanElement, I> | Used to pass attributes to the root's DOM element. |
155
+ | image | PassThroughOption<HTMLImageElement, I> | Used to pass attributes to the image's DOM element. |
156
+ | previewMask | PassThroughOption<HTMLButtonElement, I> | Used to pass attributes to the preview mask button's DOM element. |
157
+ | previewIcon | PassThroughOption<SVGElement, I> | Used to pass attributes to the preview icon's DOM element. |
158
+ | mask | PassThroughOption<HTMLDivElement, I> | Used to pass attributes to the mask's DOM element. |
159
+ | toolbar | PassThroughOption<HTMLDivElement, I> | Used to pass attributes to the toolbar's DOM element. |
160
+ | rotateRightButton | PassThroughOption<HTMLButtonElement, I> | Used to pass attributes to the rotate right button's DOM element. |
161
+ | rotateLeftButton | PassThroughOption<HTMLButtonElement, I> | Used to pass attributes to the rotate left button's DOM element. |
162
+ | zoomOutButton | PassThroughOption<HTMLButtonElement, I> | Used to pass attributes to the zoom out button's DOM element. |
163
+ | zoomInButton | PassThroughOption<HTMLButtonElement, I> | Used to pass attributes to the zoom in button's DOM element. |
164
+ | closeButton | PassThroughOption<HTMLButtonElement, I> | Used to pass attributes to the close button's DOM element. |
165
+ | original | PassThroughOption<HTMLImageElement, I> | Used to pass attributes to the original/preview image's DOM element. |
166
+ | motion | MotionOptions | Used to pass options to the motion component/directive. |
167
+
168
+ ## Theming
169
+
170
+ ### CSS Classes
171
+
172
+ | Class | Description |
173
+ |-------|-------------|
174
+ | p-image | Class name of the root element |
175
+ | p-image-preview-mask | Class name of the preview mask element |
176
+ | p-image-preview-icon | Class name of the preview icon element |
177
+ | p-image-mask | Class name of the mask element |
178
+ | p-image-toolbar | Class name of the toolbar element |
179
+ | p-image-rotate-right-button | Class name of the rotate right button element |
180
+ | p-image-rotate-left-button | Class name of the rotate left button element |
181
+ | p-image-zoom-out-button | Class name of the zoom out button element |
182
+ | p-image-zoom-in-button | Class name of the zoom in button element |
183
+ | p-image-close-button | Class name of the close button element |
184
+ | p-image-original | Class name of the original element |
185
+
186
+ ### Design Tokens
187
+
188
+ | Token | CSS Variable | Description |
189
+ |-------|--------------|-------------|
190
+ | image.transition.duration | --p-image-transition-duration | Transition duration of root |
191
+ | image.preview.icon.size | --p-image-preview-icon-size | Icon size of preview |
192
+ | image.preview.mask.background | --p-image-preview-mask-background | Mask background of preview |
193
+ | image.preview.mask.color | --p-image-preview-mask-color | Mask color of preview |
194
+ | image.toolbar.position.left | --p-image-toolbar-position-left | Position left of toolbar |
195
+ | image.toolbar.position.right | --p-image-toolbar-position-right | Position right of toolbar |
196
+ | image.toolbar.position.top | --p-image-toolbar-position-top | Position top of toolbar |
197
+ | image.toolbar.position.bottom | --p-image-toolbar-position-bottom | Position bottom of toolbar |
198
+ | image.toolbar.blur | --p-image-toolbar-blur | Blur of toolbar |
199
+ | image.toolbar.background | --p-image-toolbar-background | Background of toolbar |
200
+ | image.toolbar.border.color | --p-image-toolbar-border-color | Border color of toolbar |
201
+ | image.toolbar.border.width | --p-image-toolbar-border-width | Border width of toolbar |
202
+ | image.toolbar.border.radius | --p-image-toolbar-border-radius | Border radius of toolbar |
203
+ | image.toolbar.padding | --p-image-toolbar-padding | Padding of toolbar |
204
+ | image.toolbar.gap | --p-image-toolbar-gap | Gap of toolbar |
205
+ | image.action.hover.background | --p-image-action-hover-background | Hover background of action |
206
+ | image.action.color | --p-image-action-color | Color of action |
207
+ | image.action.hover.color | --p-image-action-hover-color | Hover color of action |
208
+ | image.action.size | --p-image-action-size | Size of action |
209
+ | image.action.icon.size | --p-image-action-icon-size | Icon size of action |
210
+ | image.action.border.radius | --p-image-action-border-radius | Border radius of action |
211
+ | image.action.focus.ring.width | --p-image-action-focus-ring-width | Focus ring width of action |
212
+ | image.action.focus.ring.style | --p-image-action-focus-ring-style | Focus ring style of action |
213
+ | image.action.focus.ring.color | --p-image-action-focus-ring-color | Focus ring color of action |
214
+ | image.action.focus.ring.offset | --p-image-action-focus-ring-offset | Focus ring offset of action |
215
+ | image.action.focus.ring.shadow | --p-image-action-focus-ring-shadow | Focus ring shadow of action |
216
+
@@ -164,7 +164,7 @@ export class ListboxDisabledDemo implements OnInit {
164
164
 
165
165
  ## dragdrop-doc
166
166
 
167
- Items can be reordered using drag and drop by enabling dragdrop property. Depends on &#64;angular/cdk package.
167
+ Items can be reordered using drag and drop by enabling dragdrop property. Depends on @angular/cdk package.
168
168
 
169
169
  ```typescript
170
170
  import { Component, OnInit } from '@angular/core';
@@ -24,5 +24,5 @@ Add a .md to a page's URL to display a Markdown version of that page.
24
24
 
25
25
  ## MCP Server
26
26
 
27
- &#64;exhaustive-ui/mcp is a Model Context Protocol server that gives coding agents such as Claude Code, Cursor, Claude Desktop, VS Code Copilot and Codex tools to query this documentation instead of guessing from PrimeNG memory: list and search components, read a component's docs and API, fetch a complete code example, read the setup guides, and validate an Angular template against the compiled API (unknown inputs or outputs, invalid literal values, unsupported two-way bindings, deprecated inputs, PrimeNG imports and selectors). The server reads the files described on this page from the live site, so it always reflects the deployed documentation without reinstalling the package, and keeps them in memory for 15 minutes. A snapshot of the same files is bundled in the package and used when the network is unavailable. Register it with Claude Code: Or add it to the MCP configuration of your client ( .cursor/mcp.json , claude_desktop_config.json , .vscode/mcp.json with a servers key, ...): The server exposes the list , search , get_component , get_guide , get_example , get_setup , validate_usage and version tools, the Markdown files of this page as MCP resources, and prompts for the usual tasks (use a component, build a form, theme a component, migrate from PrimeNG, audit usage). Set EXHAUSTIVE_UI_DOCS_URL to read another deployment of the docs, for instance a local ng serve , and EXHAUSTIVE_UI_MCP_OFFLINE=1 to only use the bundled snapshot. The package README lists every option.
27
+ @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.
28
28
 
@@ -55,7 +55,7 @@ export class OrderlistBasicDemo implements OnInit {
55
55
 
56
56
  ## dragdrop-doc
57
57
 
58
- Items can be reordered using drag and drop by enabling dragdrop property. Depends on &#64;angular/cdk package.
58
+ Items can be reordered using drag and drop by enabling dragdrop property. Depends on @angular/cdk package.
59
59
 
60
60
  ```typescript
61
61
  import { Component, OnInit, inject, signal } from '@angular/core';
@@ -271,7 +271,9 @@ OrderList is used to manage the order of a collection.
271
271
  | trackBy | InputSignal<Function> | ... | Function to optimize the dom operations by delegating to ngForTrackBy, default algorithm checks for object identity. |
272
272
  | scrollHeight | InputSignal<string> | ... | Height of the viewport, a scrollbar is defined if height of list exceeds this value. |
273
273
  | autoOptionFocus | InputSignalWithTransform<boolean, unknown> | ... | Whether to focus on the first visible or selected element. |
274
+ | focusOnHover | InputSignalWithTransform<boolean, unknown> | ... | When enabled, the hovered option will be focused. |
274
275
  | dataKey | InputSignal<string> | ... | Name of the field that uniquely identifies the record in the data. |
276
+ | optionLabel | InputSignal<string> | ... | Name of the label field of an option, used to display it and to search it with the keyboard. Defaults to dataKey, then to 'name'. |
275
277
  | selection | ModelSignal<any[]> | ... | A list of values that are currently selected. Two-way bindable with `[(selection)]` : `selectionChange` is emitted with the new selection when it changes. |
276
278
  | value | InputSignal<any[]> | ... | Array of values to be displayed in the component. It represents the data source for the list of items. |
277
279
  | buttonProps | InputSignal<ButtonProps> | ... | Used to pass all properties of the ButtonProps to the Button component. |
@@ -484,6 +484,7 @@ Password displays strength indicator for password fields.
484
484
  | strongLabel | InputSignal<string> | ... | Text for a strong password. Defaults to Exhaustive I18N API configuration. |
485
485
  | inputId | InputSignal<string> | ... | Identifier of the accessible input element. |
486
486
  | feedback | InputSignalWithTransform<boolean, unknown> | ... | Whether to show the strength indicator or not. |
487
+ | readonly | InputSignalWithTransform<boolean, unknown> | ... | When present, it specifies that an input field is read-only. |
487
488
  | toggleMask | InputSignalWithTransform<boolean, unknown> | ... | Whether to show an icon to display the password as plain text. |
488
489
  | inputStyleClass | InputSignal<string> | ... | Style class of the input field. |
489
490
  | inputStyle | InputSignal<{ [klass: string]: any }> | ... | Inline style of the input field. |
@@ -8,7 +8,7 @@ Screen Reader Value to describe the source listbox and target listbox can be pro
8
8
 
9
9
  ## Basic
10
10
 
11
- PickList is used as a controlled input with source and target properties. Content of a list item needs to be defined with the item template that receives an object in the list as parameter. Drag & drop functionality depends on &#64;angular/cdk package.
11
+ PickList is used as a controlled input with source and target properties. Content of a list item needs to be defined with the item template that receives an object in the list as parameter. Drag & drop functionality depends on @angular/cdk package.
12
12
 
13
13
  ```typescript
14
14
  import { Component, OnInit, inject, signal } from '@angular/core';
@@ -148,6 +148,7 @@ Splitter is utilized to separate and resize panels.
148
148
  | gutterSize | InputSignalWithTransform<number, unknown> | ... | Size of the divider in pixels. |
149
149
  | step | InputSignalWithTransform<number, unknown> | ... | Step factor to increment/decrement the size of the panels while pressing the arrow keys. |
150
150
  | minSizes | InputSignal<number[]> | ... | Minimum size of the elements relative to 100%. |
151
+ | maxSizes | InputSignal<number[]> | ... | Maximum size of the elements relative to 100%. |
151
152
  | panelSizes | InputSignal<number[]> | ... | Size of the elements relative to 100%. |
152
153
 
153
154
  ### Emits
@@ -104,7 +104,7 @@ export class StyleclassHideonresizeDemo {}
104
104
 
105
105
  ## Toggle Class
106
106
 
107
- StyleClass has two modes, toggleClass to simply add-remove a class and enter/leave animations. The target element to change the styling is defined with the selector property that accepts any valid CSS selector or keywords including &#64;next , prev , parent , grandparent
107
+ StyleClass has two modes, toggleClass to simply add-remove a class and enter/leave animations. The target element to change the styling is defined with the selector property that accepts any valid CSS selector or keywords including @next , prev , parent , grandparent
108
108
 
109
109
  ```typescript
110
110
  import { Component } from '@angular/core';
@@ -223,7 +223,7 @@ export class TabsDisabledDemo {}
223
223
 
224
224
  ## Dynamic
225
225
 
226
- Tabs can be generated dynamically using the standard &#64;for block.
226
+ Tabs can be generated dynamically using the standard @for block.
227
227
 
228
228
  ```typescript
229
229
  import { Component, OnInit } from '@angular/core';
@@ -363,7 +363,7 @@ export class TreeLazyDemo implements OnInit {
363
363
 
364
364
  ## Multiple
365
365
 
366
- More than one node is selectable by setting selectionMode to multiple . By default in multiple selection mode, metaKey press (e.g. ⌘ ) is necessary to add to existing selections however this can be configured with disabling the metaKeySelection property. Note that in touch enabled devices, Tree always ignores metaKey. In multiple selection mode, value binding should be a key-value pair where key is the node key and value is a boolean to indicate selection.
366
+ More than one node is selectable by setting selectionMode to multiple . By default in multiple selection mode, metaKey press (e.g. ⌘ ) is necessary to add to existing selections however this can be configured with disabling the metaKeySelection property. Note that in touch enabled devices, Tree always ignores metaKey. In multiple selection mode, selection binding should be an array of the selected nodes. Nodes are matched by their key , or by reference when they have no key.
367
367
 
368
368
  ```typescript
369
369
  import { Component, OnInit, inject, signal } from '@angular/core';
@@ -457,7 +457,7 @@ export class TreeselectLazyDemo implements OnInit {
457
457
 
458
458
  ## Multiple
459
459
 
460
- More than one node is selectable by setting selectionMode to multiple . By default in multiple selection mode, metaKey press (e.g. ⌘ ) is necessary to add to existing selections however this can be configured with disabling the metaKeySelection property. Note that in touch enabled devices, TreeSelect always ignores metaKey. In multiple selection mode, value binding should be a key-value pair where key is the node key and value is a boolean to indicate selection.
460
+ More than one node is selectable by setting selectionMode to multiple . By default in multiple selection mode, metaKey press (e.g. ⌘ ) is necessary to add to existing selections however this can be configured with disabling the metaKeySelection property. Note that in touch enabled devices, TreeSelect always ignores metaKey. In multiple selection mode, value binding should be an array of the selected nodes. Nodes are matched by their key , or by reference when they have no key.
461
461
 
462
462
  ```typescript
463
463
  import { Component, OnInit, inject } from '@angular/core';
@@ -763,6 +763,7 @@ TreeSelect is a form component to choose from hierarchical data.
763
763
  | tabindex | InputSignal<string> | ... | Index of the element in tabbing order. |
764
764
  | ariaLabel | InputSignal<string> | ... | Defines a string that labels the input for accessibility. |
765
765
  | ariaLabelledBy | InputSignal<string> | ... | Establishes relationships between the component and label(s) where its value should be one or more element IDs. |
766
+ | togglerAriaLabel | InputSignal<string> | ... | Defines a string that labels the toggle button of the tree nodes for accessibility. |
766
767
  | placeholder | InputSignal<string> | ... | Label to display when there are no selections. |
767
768
  | panelClass | InputSignal<string \| string[] \| Set<string> \| { [klass: string]: any }> | ... | Style class of the overlay panel. |
768
769
  | panelStyle | InputSignal<{ [klass: string]: any }> | ... | Inline style of the panel element. |