@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
@@ -23,10 +23,17 @@ import { SVGIcon } from '@progress/kendo-svg-icons';
23
23
  import { DialItem } from './models/item.interface';
24
24
  import * as i0 from "@angular/core";
25
25
  /**
26
+ * Represents the Kendo UI FloatingActionButton component for Angular.
27
+ * Use it to represent the primary or most common action in an application.
26
28
  *
27
- * Represents the [Kendo UI FloatingActionButton component for Angular]({% slug overview_floatingactionbutton %}).
28
- * Used to specify the primary or the most common action in an application.
29
- *
29
+ * @example
30
+ * ```html
31
+ * <kendo-floatingactionbutton
32
+ * [icon]="'plus'"
33
+ * [text]="'Add'"
34
+ * [align]="{ horizontal: 'end', vertical: 'bottom' }">
35
+ * </kendo-floatingactionbutton>
36
+ * ```
30
37
  */
31
38
  export declare class FloatingActionButtonComponent implements AfterViewInit, OnDestroy {
32
39
  renderer: Renderer2;
@@ -45,88 +52,49 @@ export declare class FloatingActionButtonComponent implements AfterViewInit, OnD
45
52
  dialItemTemplate: DialItemTemplateDirective;
46
53
  fabTemplate: FloatingActionButtonTemplateDirective;
47
54
  /**
48
- * Specifies the theme color of the FloatingActionButton
49
- * ([see example](slug:appearance_floatingactionbutton#toc-theme-colors)).
50
- * The theme color will be applied as background color of the component.
51
- *
52
- * The possible values are:
53
- * * `primary` (Default)&mdash;Applies coloring based on the `primary` theme color.
54
- * * `secondary`&mdash;Applies coloring based on the `secondary` theme color.
55
- * * `tertiary`&mdash; Applies coloring based on the `tertiary` theme color.
56
- * * `info`&mdash;Applies coloring based on the `info` theme color.
57
- * * `success`&mdash; Applies coloring based on the `success` theme color.
58
- * * `warning`&mdash; Applies coloring based on the `warning` theme color.
59
- * * `error`&mdash; Applies coloring based on the `error` theme color.
60
- * * `dark`&mdash; Applies coloring based on the `dark` theme color.
61
- * * `light`&mdash; Applies coloring based on the `light` theme color.
62
- * * `inverse`&mdash; Applies coloring based on the `inverse` theme color.
63
- * * `none`&mdash; Removes the built in theme color.
55
+ * Specifies the theme color of the FloatingActionButton ([see example](slug:appearance_floatingactionbutton#theme-colors)).
56
+ * @default "primary"
64
57
  */
65
58
  set themeColor(themeColor: ButtonThemeColor);
66
59
  get themeColor(): ButtonThemeColor;
67
60
  /**
68
- * Specifies the size of the FloatingActionButton
69
- * ([see example]({% slug appearance_floatingactionbutton %}#toc-size)).
70
- *
71
- * The possible values are:
72
- * * `small`
73
- * * `medium` (Default)
74
- * * `large`
75
- * * `none`
61
+ * Specifies the size of the FloatingActionButton ([see example](slug:appearance_floatingactionbutton#size)).
62
+ * @default "medium"
76
63
  */
77
64
  set size(size: ButtonSize);
78
65
  get size(): ButtonSize;
79
66
  /**
80
- * The rounded property specifies the border radius of the FloatingActionButton.
67
+ * Specifies the border radius of the FloatingActionButton ([see example](slug:appearance_floatingactionbutton#roundness)).
81
68
  *
82
- * The possible values are:
83
- * * `small`
84
- * * `medium`
85
- * * `large`
86
- * * `full` (default)
87
- * * `none`
69
+ * @default "full"
88
70
  */
89
71
  set rounded(rounded: ButtonRounded);
90
72
  get rounded(): ButtonRounded;
91
73
  /**
92
74
  * Specifies whether the FloatingActionButton is disabled.
75
+ * @default false
93
76
  */
94
77
  set disabled(disabled: boolean);
95
78
  get disabled(): boolean;
96
79
  /**
97
- * Specifies the horizontal and vertical alignment of the FloatingActionButton
98
- * ([see example](slug:positioning_floatingactionbutton#toc-alignment)).
99
- *
100
- * The possible values are:
101
- * * `{ horizontal: 'start'|'center'|'end', vertical: 'top'|'middle'|'bottom' }`
102
- *
103
- * The default value is:
104
- * * `{ horizontal: 'end', vertical: 'bottom' }`
105
- *
80
+ * Specifies the alignment of the FloatingActionButton ([see example](slug:positioning_floatingactionbutton#alignment)).
81
+ * @default { horizontal: 'end', vertical: 'top' }
106
82
  */
107
83
  set align(align: FabAlign);
108
84
  get align(): FabAlign;
109
85
  /**
110
- * Specifies the horizontal and vertical offset position of the FloatingActionButton
111
- * ([see example]({% slug positioning_floatingactionbutton %}#toc-offset)).
112
- *
113
- * * The default value is:
114
- * * `{ x: '16px', y: '16px' }`
86
+ * Specifies the offset position of the FloatingActionButton ([see example]({% slug positioning_floatingactionbutton %}#offset)).
87
+ * @default { x: '16px', y: '16px' }
115
88
  */
116
89
  set offset(offset: FabOffset);
117
90
  get offset(): FabOffset;
118
91
  /**
119
- * Specifies the positionMode of the FloatingActionButton
120
- * ([see example](slug:positioning_floatingactionbutton#toc-position-mode)).
121
- *
122
- * * The possible values are:
123
- * * `absolute`&mdash;Positions the FloatingActionButton absolutely to its first positioned parent element.
124
- * * `fixed` (Default)&mdash;Positions the FloatingActionButton relative to the viewport. It always stays in the same place even if the page is scrolled.
92
+ * Specifies the position mode of the FloatingActionButton ([see example](slug:positioning_floatingactionbutton#position-mode)).
93
+ * @default "fixed"
125
94
  */
126
95
  positionMode: FabPositionMode;
127
96
  /**
128
97
  * Defines the name of an existing icon in a Kendo UI theme.
129
- * If provided, the icon will be rendered inside the FloatingActionButton by a `span.k-icon` element.
130
98
  */
131
99
  icon: string;
132
100
  /**
@@ -134,8 +102,7 @@ export declare class FloatingActionButtonComponent implements AfterViewInit, OnD
134
102
  */
135
103
  svgIcon: SVGIcon;
136
104
  /**
137
- * Defines a CSS class or multiple classes separated by spaces which are applied to a `span` element.
138
- * Allows the usage of custom icons, rendered inside the FloatingActionButton by a `span` element.
105
+ * Defines a CSS class or multiple classes for custom icons.
139
106
  */
140
107
  iconClass: string;
141
108
  /**
@@ -154,46 +121,37 @@ export declare class FloatingActionButtonComponent implements AfterViewInit, OnD
154
121
  text: string;
155
122
  /**
156
123
  * Specifies the animation settings of the FloatingActionButton dial items.
157
- * ([see example]({% slug dialitems_floatingactionbutton %}#toc-animation)).
158
- *
159
- * The possible values are:
160
- * * Boolean
161
- * * (Default) `true`&mdash;Applies the default [`DialItemAnimation`]({% slug api_buttons_dialitemanimation %}) settings.
162
- * * `false`
163
- * * `DialItemAnimation`
164
- * * `duration`&mdash;Specifies the animation duration in milliseconds for each dial item. Defaults to `180ms`.
165
- * * `gap`&mdash;Specifies the animation duration gap in milliseconds after each dial item is animated. Defaults to `90ms`.
124
+ * @default true
166
125
  */
167
126
  dialItemAnimation: boolean | DialItemAnimation;
168
127
  /**
169
128
  * Specifies the [`tabIndex`](https://developer.mozilla.org/en-US/docs/Web/HTML/Global_attributes/tabindex) of the FloatingActionButton.
129
+ * @default 0
170
130
  */
171
131
  tabIndex: number;
172
132
  /**
173
- * Specifies the collection of the dial items that will be rendered in the FloatingActionButton popup.
133
+ * Specifies the collection of dial items rendered in the FloatingActionButton popup.
174
134
  */
175
135
  dialItems: DialItem[];
176
136
  /**
177
- * Fires each time the FloatingActionButton gets blurred.
137
+ * Fires when the FloatingActionButton is blurred.
178
138
  */
179
139
  onBlur: EventEmitter<any>;
180
140
  /**
181
- * Fires each time the FloatingActionButton gets focused.
141
+ * Fires when the FloatingActionButton is focused.
182
142
  */
183
143
  onFocus: EventEmitter<any>;
184
144
  /**
185
- * Fires each time a dial item is clicked.
145
+ * Fires when a dial item is clicked.
186
146
  */
187
147
  dialItemClick: EventEmitter<DialItemClickEvent>;
188
148
  /**
189
- * Fires each time the popup is about to open.
190
- * This event is preventable. If you cancel the event, the popup will remain closed
191
- * ([more information and example](slug:events_floatingactionbutton)).
149
+ * Fires when the popup is about to open. This event is preventable
150
+ * ([more information and example](slug:events_floatingactionbutton)).
192
151
  */
193
152
  open: EventEmitter<PreventableEvent>;
194
153
  /**
195
- * Fires each time the popup is about to close.
196
- * This event is preventable. If you cancel the event, the popup will remain open
154
+ * Fires when the popup is about to close. This event is preventable
197
155
  * ([more information and example](slug:events_floatingactionbutton)).
198
156
  */
199
157
  close: EventEmitter<PreventableEvent>;
@@ -7,31 +7,24 @@ import * as i1 from "./floatingactionbutton.component";
7
7
  import * as i2 from "./templates/dial-item-template.directive";
8
8
  import * as i3 from "./templates/fab-template.directive";
9
9
  /**
10
- * Represents the [NgModule](link:site.data.urls.angular['ngmoduleapi'])
11
- * definition for the FloatingActionButton component.
10
+ * Represents the NgModule definition for the FloatingActionButton component.
12
11
  *
13
- * @example
12
+ * Required for adding FloatingActionButton features in NgModule-based Angular applications.
14
13
  *
15
- * ```ts-no-run
16
- * // Import the FloatingActionButton module
14
+ * @example
15
+ * ```ts
17
16
  * import { FloatingActionButtonModule } from '@progress/kendo-angular-buttons';
18
- *
19
- * // The browser platform with a compiler
20
17
  * import { platformBrowserDynamic } from '@angular/platform-browser-dynamic';
21
- *
22
18
  * import { NgModule } from '@angular/core';
23
- *
24
- * // Import the app component
25
19
  * import { AppComponent } from './app.component';
20
+ * import { BrowserModule } from '@angular/platform-browser';
26
21
  *
27
- * // Define the app module
28
- * _@NgModule({
29
- * declarations: [AppComponent], // declare app component
30
- * imports: [BrowserModule, FloatingActionButtonModule], // import FloatingActionButton module
31
- * bootstrap: [AppComponent]
22
+ * @NgModule({
23
+ * declarations: [AppComponent],
24
+ * imports: [BrowserModule, FloatingActionButtonModule],
25
+ * bootstrap: [AppComponent]
32
26
  * })
33
27
  * export class AppModule {}
34
- *
35
28
  * ```
36
29
  */
37
30
  export declare class FloatingActionButtonModule {
@@ -4,7 +4,12 @@
4
4
  *-------------------------------------------------------------------------------------------*/
5
5
  /**
6
6
  * Specifies the horizontal and vertical alignment of the FloatingActionButton relative to the viewport or parent element
7
- * ([see example](slug:positioning_floatingactionbutton#toc-alignment)).
7
+ * ([see example](slug:positioning_floatingactionbutton#alignment)).
8
+ *
9
+ * @example
10
+ * ```typescript
11
+ * const align: FabAlign = { vertical: 'top', horizontal: 'start' };
12
+ * ```
8
13
  */
9
14
  export interface FabAlign {
10
15
  /**
@@ -4,7 +4,12 @@
4
4
  *-------------------------------------------------------------------------------------------*/
5
5
  /**
6
6
  * Specifies the animation settings for the dial items of the FloatingActionButton
7
- * ([see example]({% slug dialitems_floatingactionbutton %}#toc-animation)).
7
+ * ([see example]({% slug dialitems_floatingactionbutton %}#animation)).
8
+ *
9
+ * @example
10
+ * ```typescript
11
+ * const animation: DialItemAnimation = { duration: 200, gap: 100 };
12
+ * ```
8
13
  */
9
14
  export interface DialItemAnimation {
10
15
  /**
@@ -3,8 +3,15 @@
3
3
  * Licensed under commercial license. See LICENSE.md in the project root for more information
4
4
  *-------------------------------------------------------------------------------------------*/
5
5
  /**
6
- * Arguments for the `click` event of the dial item
6
+ * Arguments for the `click` event of a dial item
7
7
  * ([see example](slug:events_floatingactionbutton)).
8
+ *
9
+ * @example
10
+ * ```typescript
11
+ * function onDialItemClick(event: DialItemClickEvent): void {
12
+ * console.log(event.item, event.index);
13
+ * }
14
+ * ```
8
15
  */
9
16
  export interface DialItemClickEvent {
10
17
  /**
@@ -5,7 +5,7 @@
5
5
  import { SVGIcon } from "@progress/kendo-svg-icons";
6
6
  /**
7
7
  * An interface for the dial items of the FloatingActionButton
8
- * ([see example]({% slug dialitems_floatingactionbutton %}#toc-dial-items)).
8
+ * ([see example]({% slug dialitems_floatingactionbutton %}#dial-items)).
9
9
  */
10
10
  export interface DialItem {
11
11
  /**
@@ -24,21 +24,21 @@ export interface DialItem {
24
24
  disabled?: boolean;
25
25
  /**
26
26
  * Defines the name of an existing icon in a Kendo UI theme.
27
- * If provided, the icon will be rendered inside the dial item by a `span.k-icon` element, instead of the default numeric or text content.
27
+ * If set, the icon is rendered inside the dial item by a `span.k-icon` element instead of the default numeric or text content.
28
28
  */
29
29
  icon?: string;
30
30
  /**
31
- * Defines a CSS class or multiple classes separated by spaces which are applied to a span element.
32
- * Allows the usage of custom icons, rendered inside the dial item instead of the default numeric or text content.
31
+ * Defines a CSS class or multiple classes separated by spaces applied to a `span` element.
32
+ * Enables the use of custom icons rendered inside the dial item instead of the default numeric or text content.
33
33
  */
34
34
  iconClass?: string;
35
35
  /**
36
- * Defines an [`SVGIcon`](slug:api_icons_svgicon) to be rendered within the dial item.
36
+ * Defines an [`SVGIcon`](slug:api_icons_svgicon) to render within the dial item.
37
37
  */
38
38
  svgIcon?: SVGIcon;
39
39
  /**
40
40
  * Specifies the `title` attribute of the dial item.
41
- * If provided, the `title` value will be rendered in `aria-label` attribute on the element of the dial item.
41
+ * If set, the `title` value is rendered in the `aria-label` attribute on the dial item's element.
42
42
  */
43
43
  itemTitle?: string;
44
44
  /**
@@ -3,8 +3,13 @@
3
3
  * Licensed under commercial license. See LICENSE.md in the project root for more information
4
4
  *-------------------------------------------------------------------------------------------*/
5
5
  /**
6
- * Specifies the horizontal and vertical offset position of the FloatingActionButton
7
- * ([see example]({% slug positioning_floatingactionbutton %}#toc-offset)).
6
+ * Specifies the horizontal and vertical offset positions of the FloatingActionButton
7
+ * ([see example]({% slug positioning_floatingactionbutton %}#offset)).
8
+ *
9
+ * @example
10
+ * ```typescript
11
+ * const offset: FabOffset = { x: '10px', y: '20px' };
12
+ * ```
8
13
  */
9
14
  export interface FabOffset {
10
15
  /**
@@ -3,11 +3,11 @@
3
3
  * Licensed under commercial license. See LICENSE.md in the project root for more information
4
4
  *-------------------------------------------------------------------------------------------*/
5
5
  /**
6
- * Specifies the positionMode of the FloatingActionButton
7
- * ([see example](slug:positioning_floatingactionbutton#toc-position-mode)).
6
+ * Specifies the `positionMode` of the FloatingActionButton
7
+ * ([see example](slug:positioning_floatingactionbutton#position-mode)).
8
8
  *
9
- * * The possible values are:
10
- * * `absolute`&mdash;Positions the FloatingActionButton absolutely to its first positioned parent element.
11
- * * `fixed` (Default)&mdash;Positions the FloatingActionButton relative to the viewport. It always stays in the same place even if the page is scrolled.
9
+ * The possible values are:
10
+ * - `absolute`&mdash;Positions the FloatingActionButton absolutely to its first positioned parent element.
11
+ * - `fixed` (Default)&mdash;Positions the FloatingActionButton relative to the viewport. It remains in the same place even when the page scrolls.
12
12
  */
13
13
  export type FabPositionMode = 'absolute' | 'fixed';
@@ -5,10 +5,18 @@
5
5
  import { TemplateRef } from '@angular/core';
6
6
  import * as i0 from "@angular/core";
7
7
  /**
8
- * Represents a template that defines the content of the whole dial item.
9
- * To define the template, nest an `<ng-template>` tag
10
- * with the `kendoDialItemTemplate` directive inside the `<kendo-floatingactionbutton>` tag
11
- * ([see example]({% slug templates_floatingactionbutton %}#toc-dial-item-template)).
8
+ * Represents a template that defines the content of a dial item.
9
+ * To define the template, nest an `<ng-template>` tag with the `kendoDialItemTemplate` directive inside the `<kendo-floatingactionbutton>` tag
10
+ *([see example]({% slug templates_floatingactionbutton %}#dial-item-template)).
11
+ *
12
+ * @example
13
+ * ```html
14
+ * <kendo-floatingactionbutton>
15
+ * <ng-template kendoDialItemTemplate let-item="item">
16
+ * {{ item.label }}
17
+ * </ng-template>
18
+ * </kendo-floatingactionbutton>
19
+ * ```
12
20
  */
13
21
  export declare class DialItemTemplateDirective {
14
22
  templateRef: TemplateRef<any>;
@@ -6,9 +6,18 @@ import { TemplateRef } from '@angular/core';
6
6
  import * as i0 from "@angular/core";
7
7
  /**
8
8
  * Represents a template that defines the content of the FloatingActionButton.
9
- * To define the template, nest an `<ng-template>` tag
10
- * with the `kendoFloatingActionButtonTemplate` directive inside the `<kendo-floatingactionbutton>` tag
11
- * ([see example]({% slug templates_floatingactionbutton %}#toc-floatingactionbutton-template)).
9
+ * To define the template, nest an `<ng-template>` tag with the `kendoFloatingActionButtonTemplate` directive inside the `<kendo-floatingactionbutton>` tag
10
+ *
11
+ * ([see example](slug:templates_floatingactionbutton#floatingactionbutton-template)).
12
+ *
13
+ * @example
14
+ * ```html
15
+ * <kendo-floatingactionbutton>
16
+ * <ng-template kendoFloatingActionButtonTemplate>
17
+ * Custom Content
18
+ * </ng-template>
19
+ * </kendo-floatingactionbutton>
20
+ * ```
12
21
  */
13
22
  export declare class FloatingActionButtonTemplateDirective {
14
23
  templateRef: TemplateRef<any>;
@@ -5,49 +5,27 @@
5
5
  import { TemplateRef } from '@angular/core';
6
6
  import * as i0 from "@angular/core";
7
7
  /**
8
- * Used for rendering the list item content.
8
+ * Renders the list item content.
9
9
  *
10
10
  * To define the item template, nest a `<ng-template>` tag with the `kendo<ComponentName>ItemTemplate` directive inside the component tag.
11
11
  *
12
- * For the DropDownButton, use the `kendoDropDownButtonItemTemplate` directive.
13
- * For the SplitButton, use the `kendoSplitButtonItemTemplate` directive.
12
+ * - Use the `kendoDropDownButtonItemTemplate` directive for the DropDownButton.
13
+ * - Use the `kendoSplitButtonItemTemplate` directive for the SplitButton.
14
14
  *
15
- * The template context is set to the current component. To get a reference to the current data item, use the `let-dataItem` directive.
15
+ * The template context is set to the current component. Use the `let-dataItem` directive to reference the current data item.
16
16
  *
17
17
  * @example
18
- * ```ts
19
- * _@Component({
20
- * selector: 'my-app',
21
- * template: `
22
- * <kendo-splitbutton [data]="listItems">
23
- * <ng-template kendoSplitButtonItemTemplate let-dataItem>
24
- * <span>{{dataItem}} option</span>
25
- * </ng-template>
26
- * </kendo-splitbutton>
27
- * <kendo-dropdownbutton [data]="listItems">
28
- * <ng-template kendoDropDownButtonItemTemplate let-dataItem>
29
- * <span>{{dataItem}} option</span>
30
- * </ng-template>
31
- * </kendo-dropdownbutton>
32
- * `
33
- * })
34
- * class AppComponent {
35
- * public listItems: Array<any> = [{
36
- * text: 'item1',
37
- * icon: 'arrow-rotate-cw',
38
- * disabled: false,
39
- * click: (dataItem: any) => {
40
- * //action
41
- * }
42
- * }, {
43
- * text: 'item2',
44
- * icon: 'arrow-rotate-cw',
45
- * disabled: false,
46
- * click: (dataItem: any) => {
47
- * //action
48
- * }
49
- * }]
50
- * }
18
+ * ```html
19
+ * <kendo-splitbutton [data]="listItems">
20
+ * <ng-template kendoSplitButtonItemTemplate let-dataItem>
21
+ * <span>{{dataItem}} option</span>
22
+ * </ng-template>
23
+ * </kendo-splitbutton>
24
+ * <kendo-dropdownbutton [data]="listItems">
25
+ * <ng-template kendoDropDownButtonItemTemplate let-dataItem>
26
+ * <span>{{dataItem}} option</span>
27
+ * </ng-template>
28
+ * </kendo-dropdownbutton>
51
29
  * ```
52
30
  *
53
31
  * For more examples, refer to the article on the [DropDownButton templates](slug:itemstemplates_dropdownbutton).
@@ -49,26 +49,30 @@ export declare class ListButton extends MultiTabStop implements OnDestroy {
49
49
  container: ViewContainerRef;
50
50
  /**
51
51
  * Sets the disabled state of the DropDownButton.
52
+ * When `true`, the button is disabled and cannot be interacted with.
52
53
  */
53
54
  set disabled(value: boolean);
54
55
  get disabled(): boolean;
55
56
  /**
56
57
  * Specifies the [`tabIndex`](https://developer.mozilla.org/en-US/docs/Web/HTML/Global_attributes/tabindex) of the component.
58
+ * Determines the order of focus when navigating with the keyboard.
59
+ *
60
+ * @default 0
57
61
  */
58
62
  tabIndex: number;
59
63
  /**
60
- * The CSS classes that will be rendered on the main button.
61
- * Supports the type of values that are supported by [`ngClass`](link:site.data.urls.angular['ngclassapi']).
64
+ * The CSS classes applied to the main button.
65
+ * Supports the same values as [`ngClass`](link:site.data.urls.angular['ngclassapi']).
62
66
  */
63
67
  buttonClass: any;
64
68
  /**
65
- * Fires each time the popup is about to open.
66
- * This event is preventable. If you cancel the event, the popup will remain closed.
69
+ * Fires when the popup is about to open.
70
+ * This event is preventable. Canceling the event keeps the popup closed.
67
71
  */
68
72
  open: EventEmitter<PreventableEvent>;
69
73
  /**
70
- * Fires each time the popup is about to close.
71
- * This event is preventable. If you cancel the event, the popup will remain open.
74
+ * Fires when the popup is about to close.
75
+ * This event is preventable. Canceling the event keeps the popup open.
72
76
  */
73
77
  close: EventEmitter<PreventableEvent>;
74
78
  /**
@@ -84,12 +88,6 @@ export declare class ListButton extends MultiTabStop implements OnDestroy {
84
88
  private get appendTo();
85
89
  /**
86
90
  * Configures the popup of the DropDownButton.
87
- *
88
- * The available options are:
89
- * - `animate: Boolean`&mdash;Controls the popup animation. By default, the open and close animations are enabled.
90
- * - `popupClass: String`&mdash;Specifies a list of CSS classes that are used to style the popup.
91
- * - `appendTo: "root" | "component" | ViewContainerRef`&mdash;Specifies the component to which the popup will be appended.
92
- * - `align: "left" | "center" | "right"`&mdash;Specifies the alignment of the popup.
93
91
  */
94
92
  set popupSettings(settings: PopupSettings);
95
93
  get popupSettings(): PopupSettings;
@@ -129,9 +127,9 @@ export declare class ListButton extends MultiTabStop implements OnDestroy {
129
127
  protected subscribeNavigationEvents(): void;
130
128
  /**
131
129
  * Toggles the visibility of the popup.
132
- * If the `toggle` method is used to open or close the popup, the `open` and `close` events will not be fired.
130
+ * If the `toggle` method is used, the `open` and `close` events are not fired.
133
131
  *
134
- * @param open - The state of the popup.
132
+ * @param open - The desired state of the popup.
135
133
  */
136
134
  toggle(open: boolean): void;
137
135
  /**
@@ -8,15 +8,15 @@ import { SVGIcon } from "@progress/kendo-svg-icons";
8
8
  *
9
9
  * @example
10
10
  *
11
- * ```ts-preview
12
- * _@Component({
11
+ * ```typescript
12
+ * @Component({
13
13
  * selector: 'my-app',
14
14
  * template: `
15
- * <kendo-splitbutton [data]="listItems">SplitButton</kendo-splitbutton>
15
+ * <kendo-splitbutton [data]="items">SplitButton</kendo-splitbutton>
16
16
  * `
17
17
  * })
18
18
  * class AppComponent {
19
- * public listItems: ListItemModel[] = [{
19
+ * public items: ListItemModel[] = [{
20
20
  * text: 'item1',
21
21
  * icon: 'arrow-rotate-cw',
22
22
  * click: (dataItem: any) => {
@@ -28,18 +28,6 @@ import { SVGIcon } from "@progress/kendo-svg-icons";
28
28
  * click: (dataItem: any) => {
29
29
  * //action
30
30
  * }
31
- * }, {
32
- * text: 'item3',
33
- * imageUrl: 'https://demos.telerik.com/kendo-ui/content/web/toolbar/upload.png',
34
- * click: (dataItem: any) => {
35
- * //action
36
- * }
37
- * }, {
38
- * text: 'item4',
39
- * disabled: true,
40
- * click: (dataItem: any) => {
41
- * //action
42
- * }
43
31
  * }]
44
32
  * }
45
33
  * ```
@@ -50,35 +38,35 @@ export interface ListItemModel {
50
38
  */
51
39
  text?: string;
52
40
  /**
53
- * Defines an icon to be rendered next to the title.
41
+ * Defines an icon rendered next to the title.
54
42
  */
55
43
  icon?: string;
56
44
  /**
57
- * Defines an [SVGIcon](slug:api_icons_svgicon) to be rendered next to the title.
45
+ * Defines an [SVGIcon](slug:api_icons_svgicon) rendered next to the title.
58
46
  */
59
47
  svgIcon?: SVGIcon;
60
48
  /**
61
- * Defines an icon with a custom CSS class to be rendered next to the title.
49
+ * Defines an icon with a custom CSS class rendered next to the title.
62
50
  */
63
51
  iconClass?: string;
64
52
  /**
65
- * Defines the location of an image to be displayed next to the title.
53
+ * Specifies the location of an image displayed next to the title.
66
54
  */
67
55
  imageUrl?: string;
68
56
  /**
69
- * Defines the value of the image element `alt` attribute.
57
+ * Specifies the value of the image element `alt` attribute.
70
58
  */
71
59
  imageAlt?: string;
72
60
  /**
73
- * When set to `true`, disables a button list item.
61
+ * Disables the button list item when set to `true`.
74
62
  */
75
63
  disabled?: boolean;
76
64
  /**
77
- * The CSS classes that will be rendered on the item element. Supports the type of values that are supported by ngClass.
65
+ * Specifies the CSS classes rendered on the item element. Supports the same values as `ngClass`.
78
66
  */
79
67
  cssClass?: any;
80
68
  /**
81
- * An event handler that is emitted when an item is clicked.
69
+ * Emits an event when the item is clicked.
82
70
  */
83
71
  click?: (dataItem?: any) => void;
84
72
  }