@exhaustive-ui/mcp 22.0.0-alpha.10 → 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.
@@ -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,7 +542,7 @@ 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
547
  | ariaExpanded | InputSignal<boolean> | ... | Value of the aria-expanded attribute of the button, for a button that shows or hides an element. |
548
548
  | ariaControls | InputSignal<string> | ... | Id of the element the button controls, set as its aria-controls attribute. |
@@ -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. |
@@ -997,7 +997,7 @@ DatePicker is a form component to work with dates.
997
997
  | icon | InputSignal<string> | ... | Icon of the datepicker button. |
998
998
  | readonlyInput | InputSignalWithTransform<boolean, unknown> | ... | When specified, prevents entering the date manually with keyboard. |
999
999
  | shortYearCutoff | InputSignal<any> | ... | The cutoff year for determining the century for a date. |
1000
- | hourFormat | InputSignal<string> | ... | Specifies 12 or 24 hour format. |
1000
+ | hourFormat | InputSignalWithTransform<string, string \| number> | ... | Specifies 12 or 24 hour format. |
1001
1001
  | timeOnly | InputSignalWithTransform<boolean, unknown> | ... | Whether to display timepicker only. |
1002
1002
  | stepHour | InputSignalWithTransform<number, unknown> | ... | Hours to change per step. |
1003
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
+
@@ -271,6 +271,7 @@ 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. |
275
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'. |
276
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. |
@@ -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. |
@@ -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. |