@progress/kendo-angular-buttons 19.1.1-develop.2 → 19.1.2-develop.1

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (61) hide show
  1. package/button/button.component.d.ts +26 -22
  2. package/button/button.module.d.ts +8 -18
  3. package/button/selection-settings.d.ts +4 -1
  4. package/buttongroup/buttongroup.component.d.ts +22 -18
  5. package/buttongroup/buttongroup.module.d.ts +18 -1
  6. package/buttons.module.d.ts +3 -13
  7. package/chip/chip-list.component.d.ts +19 -13
  8. package/chip/chip.component.d.ts +32 -46
  9. package/chip/chip.module.d.ts +8 -15
  10. package/chip/models/avatar-settings.interface.d.ts +9 -9
  11. package/chip/models/selection.d.ts +0 -1
  12. package/common/models/arrow-settings.d.ts +4 -4
  13. package/common/models/fillmode.d.ts +2 -2
  14. package/common/models/rounded.d.ts +2 -2
  15. package/common/models/size.d.ts +2 -3
  16. package/common/models/theme-color.d.ts +20 -19
  17. package/directives.d.ts +88 -8
  18. package/dropdownbutton/dropdownbutton.component.d.ts +38 -76
  19. package/dropdownbutton/dropdownbutton.module.d.ts +20 -4
  20. package/esm2022/button/button.component.mjs +28 -24
  21. package/esm2022/button/button.module.mjs +8 -18
  22. package/esm2022/buttongroup/buttongroup.component.mjs +22 -18
  23. package/esm2022/buttongroup/buttongroup.module.mjs +18 -1
  24. package/esm2022/buttons.module.mjs +3 -13
  25. package/esm2022/chip/chip-list.component.mjs +19 -13
  26. package/esm2022/chip/chip.component.mjs +34 -48
  27. package/esm2022/chip/chip.module.mjs +8 -15
  28. package/esm2022/directives.mjs +88 -8
  29. package/esm2022/dropdownbutton/dropdownbutton.component.mjs +38 -76
  30. package/esm2022/dropdownbutton/dropdownbutton.module.mjs +20 -4
  31. package/esm2022/floatingactionbutton/floatingactionbutton.component.mjs +33 -75
  32. package/esm2022/floatingactionbutton/floatingactionbutton.module.mjs +9 -17
  33. package/esm2022/floatingactionbutton/templates/dial-item-template.directive.mjs +12 -4
  34. package/esm2022/floatingactionbutton/templates/fab-template.directive.mjs +12 -3
  35. package/esm2022/listbutton/button-item-template.directive.mjs +15 -37
  36. package/esm2022/listbutton/list-button.mjs +12 -14
  37. package/esm2022/package-metadata.mjs +2 -2
  38. package/esm2022/splitbutton/localization/custom-messages.component.mjs +2 -2
  39. package/esm2022/splitbutton/localization/messages.mjs +14 -15
  40. package/esm2022/splitbutton/splitbutton.component.mjs +35 -135
  41. package/esm2022/splitbutton/splitbutton.module.mjs +3 -2
  42. package/fesm2022/progress-kendo-angular-buttons.mjs +435 -544
  43. package/floatingactionbutton/floatingactionbutton.component.d.ts +33 -75
  44. package/floatingactionbutton/floatingactionbutton.module.d.ts +9 -16
  45. package/floatingactionbutton/models/align.d.ts +6 -1
  46. package/floatingactionbutton/models/item-animation.interface.d.ts +6 -1
  47. package/floatingactionbutton/models/item-click.event.d.ts +8 -1
  48. package/floatingactionbutton/models/item.interface.d.ts +6 -6
  49. package/floatingactionbutton/models/offset.d.ts +7 -2
  50. package/floatingactionbutton/models/position-mode.d.ts +5 -5
  51. package/floatingactionbutton/templates/dial-item-template.directive.d.ts +12 -4
  52. package/floatingactionbutton/templates/fab-template.directive.d.ts +12 -3
  53. package/listbutton/button-item-template.directive.d.ts +15 -37
  54. package/listbutton/list-button.d.ts +12 -14
  55. package/listbutton/list-item-model.d.ts +12 -24
  56. package/listbutton/popup-settings.d.ts +17 -12
  57. package/package.json +7 -7
  58. package/splitbutton/localization/custom-messages.component.d.ts +2 -2
  59. package/splitbutton/localization/messages.d.ts +14 -15
  60. package/splitbutton/splitbutton.component.d.ts +35 -135
  61. package/splitbutton/splitbutton.module.d.ts +2 -1
@@ -3,10 +3,10 @@
3
3
  * Licensed under commercial license. See LICENSE.md in the project root for more information
4
4
  *-------------------------------------------------------------------------------------------*/
5
5
  /**
6
- * Represents the possible fillMode options of the buttons.
6
+ * Specifies the possible `fillMode` options for the buttons.
7
7
  */
8
8
  export type ButtonFillMode = 'solid' | 'flat' | 'outline' | 'link' | 'clear' | 'none';
9
9
  /**
10
- * Represents the possible fillMode options of the Chip.
10
+ * Specifies the possible `fillMode` options for the Chip.
11
11
  */
12
12
  export type ChipFillMode = 'solid' | 'outline' | 'none';
@@ -3,10 +3,10 @@
3
3
  * Licensed under commercial license. See LICENSE.md in the project root for more information
4
4
  *-------------------------------------------------------------------------------------------*/
5
5
  /**
6
- * Represents the possible rounded options of the buttons.
6
+ * Specifies the possible rounded options for the buttons.
7
7
  */
8
8
  export type ButtonRounded = 'small' | 'medium' | 'large' | 'full' | 'none';
9
9
  /**
10
- * Represents the possible rounded options of the Chip.
10
+ * Specifies the possible rounded options for the Chip.
11
11
  */
12
12
  export type ChipRounded = 'small' | 'medium' | 'large' | 'full' | 'none';
@@ -3,11 +3,10 @@
3
3
  * Licensed under commercial license. See LICENSE.md in the project root for more information
4
4
  *-------------------------------------------------------------------------------------------*/
5
5
  /**
6
- * Specifies the possible sizes of the buttons.
7
- *
6
+ * Specifies the possible sizes for the buttons.
8
7
  */
9
8
  export type ButtonSize = 'small' | 'medium' | 'large' | 'none';
10
9
  /**
11
- * Specifies the possible sizes of the Chip.
10
+ * Specifies the possible sizes for the Chip.
12
11
  */
13
12
  export type ChipSize = 'small' | 'medium' | 'large' | 'none';
@@ -3,31 +3,32 @@
3
3
  * Licensed under commercial license. See LICENSE.md in the project root for more information
4
4
  *-------------------------------------------------------------------------------------------*/
5
5
  /**
6
- * Specifies the possible theme colors of the buttons([see examples]({% slug appearance_button %}#toc-theme-colors)).
6
+ * Specifies the possible theme colors for the buttons ([see examples]({% slug appearance_button %}#theme-colors)).
7
7
  *
8
8
  * The possible values are:
9
- * * `base` —Applies coloring based on the `base` theme color.
10
- * * `primary` —Applies coloring based on the `primary` theme color.
11
- * * `secondary`—Applies coloring based on the `secondary` theme color.
12
- * * `tertiary`— Applies coloring based on the `tertiary` theme color.
13
- * * `info`—Applies coloring based on the `info` theme color.
14
- * * `success`— Applies coloring based on the `success` theme color.
15
- * * `warning`— Applies coloring based on the `warning` theme color.
16
- * * `error`— Applies coloring based on the `error` theme color.
17
- * * `dark`— Applies coloring based on the `dark` theme color.
18
- * * `light`— Applies coloring based on the `light` theme color.
19
- * * `inverse`— Applies coloring based on the `inverse` theme color.
20
- *
9
+ * * `base`—Applies the `base` theme color.
10
+ * * `primary`—Applies the `primary` theme color.
11
+ * * `secondary`—Applies the `secondary` theme color.
12
+ * * `tertiary`—Applies the `tertiary` theme color.
13
+ * * `info`—Applies the `info` theme color.
14
+ * * `success`—Applies the `success` theme color.
15
+ * * `warning`—Applies the `warning` theme color.
16
+ * * `error`—Applies the `error` theme color.
17
+ * * `dark`—Applies the `dark` theme color.
18
+ * * `light`—Applies the `light` theme color.
19
+ * * `inverse`—Applies the `inverse` theme color.
20
+ * * `none`—Removes the theme color.
21
21
  */
22
22
  export type ButtonThemeColor = 'base' | 'primary' | 'secondary' | 'tertiary' | 'info' | 'success' | 'warning' | 'error' | 'dark' | 'light' | 'inverse' | 'none';
23
23
  /**
24
- * Specifies the possible theme colors of the Chip.
24
+ * Specifies the possible theme colors for the Chip.
25
25
  *
26
26
  * The possible values are:
27
- * * `base` —Applies coloring based on the `base` theme color.
28
- * * `info`—Applies coloring based on the `info` theme color.
29
- * * `success`— Applies coloring based on the `success` theme color.
30
- * * `warning`— Applies coloring based on the `warning` theme color.
31
- * * `error`— Applies coloring based on the `error` theme color.
27
+ * * `base`—Applies the `base` theme color.
28
+ * * `info`—Applies the `info` theme color.
29
+ * * `success`—Applies the `success` theme color.
30
+ * * `warning`—Applies the `warning` theme color.
31
+ * * `error`—Applies the `error` theme color.
32
+ * * `none`—Removes the theme color.
32
33
  */
33
34
  export type ChipThemeColor = 'base' | 'info' | 'success' | 'warning' | 'error' | 'none';
package/directives.d.ts CHANGED
@@ -15,34 +15,114 @@ import { SplitButtonComponent } from './splitbutton/splitbutton.component';
15
15
  import { ButtonItemTemplateDirective } from './listbutton/button-item-template.directive';
16
16
  import { ToggleButtonTabStopDirective } from '@progress/kendo-angular-common';
17
17
  /**
18
- * Utility array that contains all `Button` related components and directives
18
+ * Use the `KENDO_BUTTON` utility array to add all Button-related components and directives to a standalone Angular component.
19
+ *
20
+ * @example
21
+ * ```typescript
22
+ * @Component({
23
+ * standalone: true,
24
+ * imports: [KENDO_BUTTON],
25
+ * // ...
26
+ * })
27
+ * export class MyComponent {}
28
+ * ```
19
29
  */
20
30
  export declare const KENDO_BUTTON: readonly [typeof ButtonComponent];
21
31
  /**
22
- * Utility array that contains all `ButtonGroup` related components and directives
32
+ * Use the `KENDO_BUTTONGROUP` utility array to add all ButtonGroup-related components and directives to a standalone Angular component.
33
+ *
34
+ * @example
35
+ * ```typescript
36
+ * @Component({
37
+ * standalone: true,
38
+ * imports: [KENDO_BUTTONGROUP],
39
+ * // ...
40
+ * })
41
+ * export class MyComponent {}
42
+ * ```
23
43
  */
24
44
  export declare const KENDO_BUTTONGROUP: readonly [typeof ButtonComponent, typeof ButtonGroupComponent];
25
45
  /**
26
- * Utility array that contains all `DropDownButton` related components and directives
46
+ * Use the `KENDO_DROPDOWNBUTTON` utility array to add all DropDownButton-related components and directives to a standalone Angular component.
47
+ *
48
+ * @example
49
+ * ```typescript
50
+ * @Component({
51
+ * standalone: true,
52
+ * imports: [KENDO_DROPDOWNBUTTON],
53
+ * // ...
54
+ * })
55
+ * export class MyComponent {}
56
+ * ```
27
57
  */
28
58
  export declare const KENDO_DROPDOWNBUTTON: readonly [typeof DropDownButtonComponent, typeof ButtonItemTemplateDirective];
29
59
  /**
30
- * Utility array that contains all `Chip` related components and directives
60
+ * Use the `KENDO_CHIP` utility array to add all Chip-related components and directives to a standalone Angular component.
61
+ *
62
+ * @example
63
+ * ```typescript
64
+ * @Component({
65
+ * standalone: true,
66
+ * imports: [KENDO_CHIP],
67
+ * // ...
68
+ * })
69
+ * export class MyComponent {}
70
+ * ```
31
71
  */
32
72
  export declare const KENDO_CHIP: readonly [typeof ChipComponent];
33
73
  /**
34
- * Utility array that contains all `ChipList` related components and directives
74
+ * Use the `KENDO_CHIPLIST` utility array to add all ChipList-related components and directives to a standalone Angular component.
75
+ *
76
+ * @example
77
+ * ```typescript
78
+ * @Component({
79
+ * standalone: true,
80
+ * imports: [KENDO_CHIPLIST],
81
+ * // ...
82
+ * })
83
+ * export class MyComponent {}
84
+ * ```
35
85
  */
36
86
  export declare const KENDO_CHIPLIST: readonly [typeof ChipComponent, typeof ChipListComponent];
37
87
  /**
38
- * Utility array that contains all `FloatingActionButton` related components and directives
88
+ * Use the `KENDO_FLOATINGACTIONBUTTON` utility array to add all FloatingActionButton-related components and directives to a standalone Angular component.
89
+ *
90
+ * @example
91
+ * ```typescript
92
+ * @Component({
93
+ * standalone: true,
94
+ * imports: [KENDO_FLOATINGACTIONBUTTON],
95
+ * // ...
96
+ * })
97
+ * export class MyComponent {}
98
+ * ```
39
99
  */
40
100
  export declare const KENDO_FLOATINGACTIONBUTTON: readonly [typeof FloatingActionButtonComponent, typeof DialItemTemplateDirective, typeof FloatingActionButtonTemplateDirective];
41
101
  /**
42
- * Utility array that contains all `SplitButton` related components and directives
102
+ * Use the `KENDO_SPLITBUTTON` utility array to add all SplitButton-related components and directives to a standalone Angular component.
103
+ *
104
+ * @example
105
+ * ```typescript
106
+ * @Component({
107
+ * standalone: true,
108
+ * imports: [KENDO_SPLITBUTTON],
109
+ * // ...
110
+ * })
111
+ * export class MyComponent {}
112
+ * ```
43
113
  */
44
114
  export declare const KENDO_SPLITBUTTON: readonly [typeof SplitButtonComponent, typeof SplitButtonCustomMessagesComponent, typeof ToggleButtonTabStopDirective, typeof ButtonItemTemplateDirective];
45
115
  /**
46
- * Utility array that contains all `@progress/kendo-angular-buttons` related components and directives
116
+ * Use the `KENDO_BUTTONS` utility array to add all `@progress/kendo-angular-buttons`-related components and directives to a standalone Angular component.
117
+ *
118
+ * @example
119
+ * ```typescript
120
+ * @Component({
121
+ * standalone: true,
122
+ * imports: [KENDO_BUTTONS],
123
+ * // ...
124
+ * })
125
+ * export class MyComponent {}
126
+ * ```
47
127
  */
48
128
  export declare const KENDO_BUTTONS: readonly [typeof ButtonComponent, typeof ButtonComponent, typeof ButtonGroupComponent, typeof DropDownButtonComponent, typeof ButtonItemTemplateDirective, typeof ChipComponent, typeof ChipComponent, typeof ChipListComponent, typeof FloatingActionButtonComponent, typeof DialItemTemplateDirective, typeof FloatingActionButtonTemplateDirective, typeof SplitButtonComponent, typeof SplitButtonCustomMessagesComponent, typeof ToggleButtonTabStopDirective, typeof ButtonItemTemplateDirective];
@@ -17,28 +17,26 @@ import * as i0 from "@angular/core";
17
17
  /**
18
18
  * Represents the Kendo UI DropDownButton component for Angular.
19
19
  *
20
+ * Use the DropDownButton to display a button with a popup list of actions.
21
+ *
20
22
  * @example
21
23
  * ```ts
22
- * _@Component({
23
- * selector: 'my-app',
24
- * template: `
25
- * <kendo-dropdownbutton [data]="data">
26
- * User Settings
27
- * </kendo-dropdownbutton>
28
- * `
24
+ * @Component({
25
+ * selector: 'my-app',
26
+ * template: `
27
+ * <kendo-dropdownbutton [data]="data">
28
+ * User Settings
29
+ * </kendo-dropdownbutton>
30
+ * `
29
31
  * })
30
32
  * class AppComponent {
31
- * public data: Array<any> = [{
32
- * text: 'My Profile'
33
- * }, {
34
- * text: 'Friend Requests'
35
- * }, {
36
- * text: 'Account Settings'
37
- * }, {
38
- * text: 'Support'
39
- * }, {
40
- * text: 'Log Out'
41
- * }];
33
+ * public data: Array<any> = [
34
+ * { text: 'My Profile' },
35
+ * { text: 'Friend Requests' },
36
+ * { text: 'Account Settings' },
37
+ * { text: 'Support' },
38
+ * { text: 'Log Out' }
39
+ * ];
42
40
  * }
43
41
  * ```
44
42
  */
@@ -46,96 +44,59 @@ export declare class DropDownButtonComponent extends ListButton implements After
46
44
  protected containerService: PopupContainerService;
47
45
  private renderer;
48
46
  /**
49
- * Allows showing the default arrow icon or providing alternative one instead.
47
+ * Displays the default arrow icon or a custom one.
50
48
  * @default false
51
49
  */
52
50
  arrowIcon: boolean | ArrowIconSettings;
53
51
  /**
54
- * Defines the name of an existing icon in the Kendo UI theme.
52
+ * Specifies the name of an existing icon in the Kendo UI theme.
55
53
  */
56
54
  icon: string;
57
55
  /**
58
- * Defines an [`SVGIcon`](slug:api_icons_svgicon) to be rendered within the button.
56
+ * Specifies an [`SVGIcon`](slug:api_icons_svgicon) to render within the button.
59
57
  */
60
58
  svgIcon: SVGIcon;
61
59
  /**
62
- * Defines the list of CSS classes which are used for styling the Button with custom icons.
60
+ * Specifies a list of CSS classes for styling the button with custom icons.
63
61
  */
64
62
  iconClass: string;
65
63
  /**
66
- * Defines a URL for styling the button with a custom image.
64
+ * Specifies a URL for styling the button with a custom image.
67
65
  */
68
66
  imageUrl: string;
69
67
  /**
70
68
  * Sets the data item field that represents the item text.
71
- * If the data contains only primitive values, do not define it.
69
+ * If the data contains only primitive values, leave this undefined.
72
70
  */
73
71
  textField: string;
74
72
  /**
75
- * Sets or gets the data of the DropDownButton.
76
- *
77
- * > The data has to be provided in an array-like list.
73
+ * Sets or gets the data of the DropDownButton. Provide the data as an array-like list.
78
74
  */
79
75
  set data(data: any);
80
76
  get data(): any;
81
77
  /**
82
- * The size property specifies the padding of the DropDownButton
83
- * ([see example]({% slug api_buttons_dropdownbuttoncomponent %}#toc-size)).
84
- *
85
- * The possible values are:
86
- * * `small`
87
- * * `medium` (default)
88
- * * `large`
89
- * * `none`
78
+ * Specifies the padding of the DropDownButton. See [DropDownButton Appearance](slug:appearance_dropdownbutton#size).
79
+ * @default 'medium'
90
80
  */
91
81
  size: ButtonSize;
92
82
  /**
93
- * The rounded property specifies the border radius of the DropDownButton
94
- * ([see example]({% slug api_buttons_dropdownbuttoncomponent %}#toc-rounded)).
95
- *
96
- * The possible values are:
97
- * * `small`
98
- * * `medium` (default)
99
- * * `large`
100
- * * `full`
101
- * * `none`
83
+ * Specifies the border radius of the DropDownButton. See [DropDownButton Appearance](slug:appearance_dropdownbutton#roundness).
84
+ * @default 'medium'
102
85
  */
103
86
  rounded: ButtonRounded;
104
87
  /**
105
- * The fillMode property specifies the background and border styles of the DropDownButton
106
- * ([see example]({% slug api_buttons_dropdownbuttoncomponent %}#toc-fillMode)).
107
- *
108
- * The available values are:
109
- * * `solid` (default)
110
- * * `flat`
111
- * * `outline`
112
- * * `link`
113
- * * `none`
88
+ * Specifies the background and border styles of the DropDownButton. See [DropDownButton Appearance](slug:appearance_dropdownbutton#fill-mode).
89
+ * @default 'solid'
114
90
  */
115
91
  set fillMode(fillMode: ButtonFillMode);
116
92
  get fillMode(): ButtonFillMode;
117
93
  /**
118
- * The DropDownButton allows you to specify predefined theme colors.
119
- * The theme color will be applied as a background and border color while also amending the text color accordingly
120
- * ([see example]({% slug api_buttons_dropdownbuttoncomponent %}#toc-themeColor)).
121
- *
122
- * The possible values are:
123
- * * `base` &mdash;Applies coloring based on the `base` theme color. (default)
124
- * * `primary` &mdash;Applies coloring based on the `primary` theme color.
125
- * * `secondary`&mdash;Applies coloring based on the `secondary` theme color.
126
- * * `tertiary`&mdash; Applies coloring based on the `tertiary` theme color.
127
- * * `info`&mdash;Applies coloring based on the `info` theme color.
128
- * * `success`&mdash; Applies coloring based on the `success` theme color.
129
- * * `warning`&mdash; Applies coloring based on the `warning` theme color.
130
- * * `error`&mdash; Applies coloring based on the `error` theme color.
131
- * * `dark`&mdash; Applies coloring based on the `dark` theme color.
132
- * * `light`&mdash; Applies coloring based on the `light` theme color.
133
- * * `inverse`&mdash; Applies coloring based on the `inverse` theme color.
134
- * * `none` &mdash;Removes the default CSS class (no class would be rendered).
94
+ * Specifies predefined theme colors for the DropDownButton. See [DropDownButton Appearance](slug:appearance_dropdownbutton#theme-colors).
95
+ * @default 'base'
135
96
  */
136
97
  themeColor: ButtonThemeColor;
137
98
  /**
138
- * Sets attributes to the main button.
99
+ * Sets attributes for the main button.
139
100
  */
140
101
  set buttonAttributes(buttonAttributes: {
141
102
  [key: string]: string;
@@ -144,15 +105,16 @@ export declare class DropDownButtonComponent extends ListButton implements After
144
105
  [key: string]: string;
145
106
  };
146
107
  /**
147
- * Fires each time the user clicks on a drop-down list item. The event data contains the data item bound to the clicked list item.
108
+ * Fires when the user clicks a drop-down list item.
109
+ * The event data contains the data item bound to the clicked list item.
148
110
  */
149
111
  itemClick: EventEmitter<any>;
150
112
  /**
151
- * Fires each time the DropDownButton gets focused.
113
+ * Fires when the DropDownButton is focused.
152
114
  */
153
115
  onFocus: EventEmitter<any>;
154
116
  /**
155
- * Fires each time the DropDownButton gets blurred.
117
+ * Fires when the DropDownButton is blurred.
156
118
  */
157
119
  onBlur: EventEmitter<any>;
158
120
  get focused(): boolean;
@@ -191,11 +153,11 @@ export declare class DropDownButtonComponent extends ListButton implements After
191
153
  */
192
154
  onButtonBlur(): void;
193
155
  /**
194
- * Focuses the DropDownButton component.
156
+ * Focuses the DropDownButton.
195
157
  */
196
158
  focus(): void;
197
159
  /**
198
- * Blurs the DropDownButton component.
160
+ * Blurs the DropDownButton.
199
161
  */
200
162
  blur(): void;
201
163
  constructor(focusService: FocusService, navigationService: NavigationService, wrapperRef: ElementRef, zone: NgZone, popupService: PopupService, elRef: ElementRef, localization: LocalizationService, cdr: ChangeDetectorRef, containerService: PopupContainerService, renderer: Renderer2);
@@ -6,12 +6,28 @@ import * as i0 from "@angular/core";
6
6
  import * as i1 from "./dropdownbutton.component";
7
7
  import * as i2 from "../listbutton/button-item-template.directive";
8
8
  /**
9
+ * Exports the package module.
9
10
  *
10
- * The exported package module.
11
+ * Required for adding DropDownButton features in NgModule-based Angular applications.
11
12
  *
12
- * The package exports:
13
- * - `DropDownButtonComponent`&mdash;The DropDownButtonComponent component class.
14
- * - `ButtonItemTemplateDirective`&mdash;The Button item template directive.
13
+ * The module includes:
14
+ * - `DropDownButtonComponent`&mdash;The component class for the DropDownButton.
15
+ * - `ButtonItemTemplateDirective`&mdash;The directive for the button item template.
16
+ *
17
+ * @example
18
+ * ```typescript
19
+ * import { DropDownButtonModule } from '@progress/kendo-angular-buttons';
20
+ * import { NgModule } from '@angular/core';
21
+ * import { BrowserModule } from '@angular/platform-browser';
22
+ * import { AppComponent } from './app.component';
23
+ *
24
+ * @NgModule({
25
+ * declarations: [AppComponent],
26
+ * imports: [BrowserModule, DropDownButtonModule],
27
+ * bootstrap: [AppComponent]
28
+ * })
29
+ * export class AppModule {}
30
+ * ```
15
31
  */
16
32
  export declare class DropDownButtonModule {
17
33
  static ɵfac: i0.ɵɵFactoryDeclaration<DropDownButtonModule, never>;
@@ -24,7 +24,12 @@ const DEFAULT_FILL_MODE = 'solid';
24
24
  * Represents the Kendo UI Button component for Angular.
25
25
  *
26
26
  * As of package v17, the `span[kendoButton]` and `kendo-button` selectors are removed.
27
- * Please use the `button[kendoButton]` selector only.
27
+ * Use the `button[kendoButton]` selector only.
28
+ *
29
+ * @example
30
+ * ```html
31
+ * <button kendoButton [icon]="'save'" [themeColor]="'primary'">Save</button>
32
+ * ```
28
33
  */
29
34
  export class ButtonComponent {
30
35
  renderer;
@@ -37,7 +42,7 @@ export class ButtonComponent {
37
42
  */
38
43
  arrowIcon = false;
39
44
  /**
40
- * Provides visual styling that indicates if the Button is active.
45
+ * Adds visual styling to indicate when the Button is active.
41
46
  *
42
47
  * @default false
43
48
  */
@@ -58,6 +63,7 @@ export class ButtonComponent {
58
63
  }
59
64
  /**
60
65
  * Sets the selected state of the Button.
66
+ * Use with the `toggleable` property.
61
67
  *
62
68
  * @default false
63
69
  */
@@ -77,13 +83,12 @@ export class ButtonComponent {
77
83
  return this.element.tabIndex;
78
84
  }
79
85
  /**
80
- * Defines a URL which is used for an `img` element inside the Button.
86
+ * Specifies a URL for an `img` element inside the Button.
81
87
  * The URL can be relative or absolute. If relative, it is evaluated with relation to the web page URL.
82
88
  */
83
89
  imageUrl;
84
90
  /**
85
- * Defines a CSS class&mdash;or multiple classes separated by spaces&mdash;
86
- * which are applied to a `span` element inside the Button. Allows the usage of custom icons.
91
+ * Defines a CSS class, or multiple classes separated by spaces applied to a `span` element inside the Button. Use the `iconClass` to add custom icons.
87
92
  */
88
93
  set iconClass(value) {
89
94
  if (isDevMode() && value && (this.icon || this.svgIcon)) {
@@ -95,7 +100,7 @@ export class ButtonComponent {
95
100
  return this._iconClass;
96
101
  }
97
102
  /**
98
- * Defines the name for an existing font icon in the Kendo UI theme.
103
+ * Sets the name of an existing font icon in the Kendo UI theme.
99
104
  */
100
105
  set icon(name) {
101
106
  if (isDevMode() && name && this.iconClass) {
@@ -107,7 +112,7 @@ export class ButtonComponent {
107
112
  return this._icon;
108
113
  }
109
114
  /**
110
- * If set to `true`, it disables the Button.
115
+ * When `true`, disables the Button and prevents user interaction.
111
116
  *
112
117
  * @default false
113
118
  */
@@ -123,8 +128,8 @@ export class ButtonComponent {
123
128
  return this.isDisabled;
124
129
  }
125
130
  /**
126
- * The size property specifies the padding of the Button
127
- * ([see example]({% slug appearance_button %}#toc-size)).
131
+ * Sets the padding of the Button.
132
+ * See [Button Appearance]({% slug appearance_button %}#size).
128
133
  *
129
134
  * @default 'medium'
130
135
  */
@@ -137,8 +142,8 @@ export class ButtonComponent {
137
142
  return this._size;
138
143
  }
139
144
  /**
140
- * The rounded property specifies the border radius of the Button
141
- * ([see example](slug:appearance_button#toc-roundness)).
145
+ * Sets the border radius of the Button.
146
+ * See [Button Appearance](slug:appearance_button#roundness).
142
147
  *
143
148
  * @default 'medium'
144
149
  */
@@ -151,8 +156,8 @@ export class ButtonComponent {
151
156
  return this._rounded;
152
157
  }
153
158
  /**
154
- * The fillMode property specifies the background and border styles of the Button
155
- * ([see example](slug:appearance_button#toc-fill-mode)).
159
+ * Sets the background and border styles of the Button.
160
+ * See [Button Appearance](slug:appearance_button#fill-mode).
156
161
  *
157
162
  * @default 'solid'
158
163
  */
@@ -165,9 +170,9 @@ export class ButtonComponent {
165
170
  return this._fillMode;
166
171
  }
167
172
  /**
168
- * The Button allows you to specify predefined theme colors.
169
- * The theme color will be applied as a background and border color while also amending the text color accordingly
170
- * ([see example](slug:appearance_button#toc-theme-colors)).
173
+ * Sets a predefined theme color for the Button.
174
+ * The theme color applies as a background and border color and adjusts the text color.
175
+ * See [Button Appearance](slug:appearance_button#theme-colors).
171
176
  *
172
177
  * @default 'base'
173
178
  */
@@ -180,7 +185,7 @@ export class ButtonComponent {
180
185
  return this._themeColor;
181
186
  }
182
187
  /**
183
- * Defines an SVGIcon to be rendered within the button.
188
+ * Sets an SVG icon to display inside the Button.
184
189
  */
185
190
  set svgIcon(icon) {
186
191
  if (isDevMode() && icon && this.iconClass) {
@@ -192,13 +197,12 @@ export class ButtonComponent {
192
197
  return this._svgIcon;
193
198
  }
194
199
  /**
195
- * Fires each time the selected state of a toggleable button is changed.
196
- *
197
- * The event argument is the new selected state (boolean).
200
+ * Fires when the selected state of a toggleable button changes.
201
+ * The event argument is the new selected state (`boolean`).
198
202
  */
199
203
  selectedChange = new EventEmitter();
200
204
  /**
201
- * Fires each time the user clicks the button.
205
+ * Fires when the user clicks the Button.
202
206
  */
203
207
  click = new EventEmitter();
204
208
  element;
@@ -335,7 +339,7 @@ export class ButtonComponent {
335
339
  }
336
340
  }
337
341
  /**
338
- * Blurs the Button component.
342
+ * Removes focus from the Button component.
339
343
  */
340
344
  blur() {
341
345
  if (isDocumentAvailable()) {
@@ -449,7 +453,7 @@ export class ButtonComponent {
449
453
  [name]="$any(arrowIcon).icon || 'caret-alt-down'"
450
454
  [svgIcon]="$any(arrowIcon).svgIcon || caretAltDownIcon"></kendo-icon-wrapper>
451
455
  </span>
452
-
456
+
453
457
  `, isInline: true, dependencies: [{ kind: "directive", type: NgIf, selector: "[ngIf]", inputs: ["ngIf", "ngIfThen", "ngIfElse"] }, { kind: "component", type: IconWrapperComponent, selector: "kendo-icon-wrapper", inputs: ["name", "svgIcon", "innerCssClass", "customFontClass", "size"], exportAs: ["kendoIconWrapper"] }, { kind: "directive", type: NgClass, selector: "[ngClass]", inputs: ["class", "ngClass"] }] });
454
458
  }
455
459
  i0.ɵɵngDeclareClassMetadata({ minVersion: "12.0.0", version: "16.2.12", ngImport: i0, type: ButtonComponent, decorators: [{
@@ -481,7 +485,7 @@ i0.ɵɵngDeclareClassMetadata({ minVersion: "12.0.0", version: "16.2.12", ngImpo
481
485
  [name]="$any(arrowIcon).icon || 'caret-alt-down'"
482
486
  [svgIcon]="$any(arrowIcon).svgIcon || caretAltDownIcon"></kendo-icon-wrapper>
483
487
  </span>
484
-
488
+
485
489
  `,
486
490
  standalone: true,
487
491
  imports: [NgIf, IconWrapperComponent, NgClass]
@@ -11,31 +11,21 @@ import * as i0 from "@angular/core";
11
11
  * Represents the [NgModule](link:site.data.urls.angular['ngmodules'])
12
12
  * definition for the Button directive.
13
13
  *
14
- * @example
14
+ * Required for adding Button features in NgModule-based Angular applications.
15
15
  *
16
- * ```ts-no-run
17
- * // Import the Button module
16
+ * @example
17
+ * ```typescript
18
18
  * import { ButtonModule } from '@progress/kendo-angular-buttons';
19
- *
20
- * // The browser platform with a compiler
21
- * import { platformBrowserDynamic } from '@angular/platform-browser-dynamic';
22
- *
23
19
  * import { NgModule } from '@angular/core';
24
- *
25
- * // Import the app component
20
+ * import { BrowserModule } from '@angular/platform-browser';
26
21
  * import { AppComponent } from './app.component';
27
22
  *
28
- * // Define the app module
29
- * _@NgModule({
30
- * declarations: [AppComponent], // declare app component
31
- * imports: [BrowserModule, ButtonModule], // import Button module
32
- * bootstrap: [AppComponent]
23
+ * @NgModule({
24
+ * declarations: [AppComponent],
25
+ * imports: [BrowserModule, ButtonModule],
26
+ * bootstrap: [AppComponent]
33
27
  * })
34
28
  * export class AppModule {}
35
- *
36
- * // Compile and launch the module
37
- * platformBrowserDynamic().bootstrapModule(AppModule);
38
- *
39
29
  * ```
40
30
  */
41
31
  export class ButtonModule {