@progress/kendo-angular-toolbar 19.1.0-develop.2 → 19.1.1-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 (33) hide show
  1. package/common/fillmode.d.ts +1 -1
  2. package/common/overflow-mode.d.ts +1 -1
  3. package/common/overflow-settings.d.ts +8 -16
  4. package/common/scroll-buttons.d.ts +12 -2
  5. package/common/size.d.ts +1 -1
  6. package/display-mode.d.ts +5 -5
  7. package/esm2022/localization/custom-messages.component.mjs +14 -1
  8. package/esm2022/localization/messages.mjs +3 -3
  9. package/esm2022/package-metadata.mjs +2 -2
  10. package/esm2022/toolbar.component.mjs +28 -22
  11. package/esm2022/toolbar.module.mjs +2 -2
  12. package/esm2022/tools/toolbar-button.component.mjs +38 -39
  13. package/esm2022/tools/toolbar-buttongroup.component.mjs +20 -11
  14. package/esm2022/tools/toolbar-dropdownbutton.component.mjs +39 -47
  15. package/esm2022/tools/toolbar-separator.component.mjs +11 -0
  16. package/esm2022/tools/toolbar-spacer.component.mjs +11 -0
  17. package/esm2022/tools/toolbar-splitbutton.component.mjs +45 -54
  18. package/esm2022/tools/toolbar-tool.component.mjs +31 -12
  19. package/fesm2022/progress-kendo-angular-toolbar.mjs +244 -193
  20. package/group-selection-settings.d.ts +2 -2
  21. package/localization/custom-messages.component.d.ts +14 -1
  22. package/localization/messages.d.ts +3 -3
  23. package/package.json +9 -9
  24. package/popup-settings.d.ts +23 -20
  25. package/toolbar.component.d.ts +28 -22
  26. package/toolbar.module.d.ts +2 -2
  27. package/tools/toolbar-button.component.d.ts +38 -39
  28. package/tools/toolbar-buttongroup.component.d.ts +20 -11
  29. package/tools/toolbar-dropdownbutton.component.d.ts +39 -47
  30. package/tools/toolbar-separator.component.d.ts +11 -0
  31. package/tools/toolbar-spacer.component.d.ts +11 -0
  32. package/tools/toolbar-splitbutton.component.d.ts +45 -54
  33. package/tools/toolbar-tool.component.d.ts +31 -12
@@ -26,8 +26,8 @@ const packageMetadata = {
26
26
  productName: 'Kendo UI for Angular',
27
27
  productCode: 'KENDOUIANGULAR',
28
28
  productCodes: ['KENDOUIANGULAR'],
29
- publishDate: 1748526935,
30
- version: '19.1.0-develop.2',
29
+ publishDate: 1749139799,
30
+ version: '19.1.1-develop.1',
31
31
  licensingDocsUrl: 'https://www.telerik.com/kendo-angular-ui/my-license/'
32
32
  };
33
33
 
@@ -437,8 +437,27 @@ i0.ɵɵngDeclareClassMetadata({ minVersion: "12.0.0", version: "16.2.12", ngImpo
437
437
  }], ctorParameters: function () { return [{ type: i0.NgZone }]; } });
438
438
 
439
439
  /**
440
- * Represents the Base ToolBar Tool component for Angular.
441
- * Extend this class to create custom tools.
440
+ * Represents the base ToolBar Tool component for Angular.
441
+ *
442
+ * Extend this class to create a custom tool for the ToolBar.
443
+ *
444
+ * @example
445
+ * ```typescript
446
+ * import { Component } from '@angular/core';
447
+ * import { ToolBarToolComponent } from '@progress/kendo-angular-toolbar';
448
+ *
449
+ * @Component({
450
+ * providers: [{ provide: ToolBarToolComponent, useExisting: forwardRef(() => CustomToolComponent) }],
451
+ * selector: 'custom-tool',
452
+ * })
453
+ *
454
+ * export class CustomToolComponent extends ToolBarToolComponent {
455
+ *
456
+ * constructor() {
457
+ * super();
458
+ * }
459
+ * }
460
+ * ```
442
461
  */
443
462
  class ToolBarToolComponent {
444
463
  toolbarTemplate;
@@ -472,27 +491,27 @@ class ToolBarToolComponent {
472
491
  return this.overflows ? 'block' : 'none';
473
492
  }
474
493
  /**
475
- * Determines if the tool can be focused.
476
- * If the returned value is `false`, the tool will not be part of the keyboard navigation.
477
- * @returns `true` if the tool should take part in keyboard navigation.
494
+ * Determines if the tool can receive focus.
495
+ * Returns `true` if the tool participates in keyboard navigation.
496
+ * @returns `true` if the tool is focusable.
478
497
  */
479
498
  canFocus() {
480
499
  return false;
481
500
  }
482
501
  /**
483
- * Called when the tool is focused.
484
- * The method accepts as argument the original browser event, which can be a `KeyboardEvent`, `MouseEvent` or `FocusEvent`.
485
- * @param {Event} _ev - This is the event that caused the tool to be focused.
502
+ * Called when the tool receives focus.
503
+ * Accepts the original browser event, which can be a `KeyboardEvent`, `MouseEvent`, or `FocusEvent`.
504
+ * @param {Event} _ev - The event that triggers focus for the tool.
486
505
  */
487
506
  focus(_ev) {
488
507
  /* noop */
489
508
  }
490
509
  /**
491
- * Called when the tool is focused and one of the arrow keys is pressed.
492
- * The returned boolean value determines whether the `ToolBarComponent` will move the focus to the next/previous `ToolBarToolComponent`
510
+ * Called when the tool is focused and an arrow key is pressed.
511
+ * Returns a boolean value that determines if the `ToolBarComponent` moves focus to the next or previous tool
493
512
  * ([see example]({% slug customcontroltypes_toolbar %}#toc-adding-keyboard-navigation)).
494
- * @param {KeyboardEvent} _ev - The last pressed arrow key
495
- * @returns a boolean value determines whether the focus will move to the next/previous component.
513
+ * @param {KeyboardEvent} _ev - The last pressed arrow key.
514
+ * @returns `true` if focus moves to another tool.
496
515
  */
497
516
  handleKey(_ev) {
498
517
  return false;
@@ -787,15 +806,15 @@ i0.ɵɵngDeclareClassMetadata({ minVersion: "12.0.0", version: "16.2.12", ngImpo
787
806
  */
788
807
  class ToolbarMessages extends ComponentMessages {
789
808
  /**
790
- * The title of the **More Tools** button in a responsive ToolBar
809
+ * Sets the title of the **More Tools** button in a responsive ToolBar.
791
810
  */
792
811
  moreToolsTitle;
793
812
  /**
794
- * The title for the **Previous Tool** button when the Toolbar is scrollable.
813
+ * Sets the title for the **Previous Tool** button when the ToolBar is scrollable.
795
814
  */
796
815
  previousToolButton;
797
816
  /**
798
- * The title for the **Next Tool** button when the Toolbar is scrollable.
817
+ * Sets the title for the **Next Tool** button when the ToolBar is scrollable.
799
818
  */
800
819
  nextToolButton;
801
820
  static ɵfac = i0.ɵɵngDeclareFactory({ minVersion: "12.0.0", version: "16.2.12", ngImport: i0, type: ToolbarMessages, deps: null, target: i0.ɵɵFactoryTarget.Directive });
@@ -1100,6 +1119,13 @@ const getInitialPopupSettings = (isRtl) => ({
1100
1119
  });
1101
1120
  /**
1102
1121
  * Represents the [Kendo UI ToolBar component for Angular]({% slug overview_toolbar %}).
1122
+ *
1123
+ * @example
1124
+ * ```html
1125
+ * <kendo-toolbar>
1126
+ * <kendo-toolbar-button text="Button"></kendo-toolbar-button>
1127
+ * </kendo-toolbar>
1128
+ * ```
1103
1129
  */
1104
1130
  class ToolBarComponent {
1105
1131
  localization;
@@ -1116,7 +1142,8 @@ class ToolBarComponent {
1116
1142
  return `k-button-${SIZES[this.size]}`;
1117
1143
  }
1118
1144
  /**
1119
- * Configures the overflow mode. Used to specify how tools will be rendered when the total size of all tools is greater than the size of the Toolbar container.
1145
+ * Sets the overflow mode for the ToolBar.
1146
+ * Use this property to control how tools render when their total size is greater than the ToolBar container.
1120
1147
  * @default false
1121
1148
  */
1122
1149
  set overflow(overflow) {
@@ -1178,11 +1205,9 @@ class ToolBarComponent {
1178
1205
  return this.normalizedOverflow.mode !== 'none';
1179
1206
  }
1180
1207
  /**
1181
- * Configures the popup of the ToolBar overflow button ([see example](slug:responsive_toolbar#customizing-the-popup)).
1182
- *
1183
- * The available options are:
1184
- * - `animate: Boolean`&mdash;Controls the popup animation. By default, the open and close animations are enabled.
1185
- * - `popupClass: String`&mdash;Specifies a list of CSS classes that are used to style the popup.
1208
+ * Configures the popup for the ToolBar overflow button.
1209
+ * Use this property to customize the overflow popup appearance and behavior
1210
+ * ([see example](slug:responsive_toolbar#customizing-the-popup)).
1186
1211
  */
1187
1212
  set popupSettings(settings) {
1188
1213
  this._popupSettings = Object.assign({}, getInitialPopupSettings(this.localization.rtl), settings);
@@ -1191,9 +1216,9 @@ class ToolBarComponent {
1191
1216
  return this._popupSettings || getInitialPopupSettings(this.localization.rtl);
1192
1217
  }
1193
1218
  /**
1194
- * The fillMode property specifies the background and border styles of the Toolbar
1219
+ * Sets the fill mode for the ToolBar.
1220
+ * This property controls the background and border styles of the ToolBar
1195
1221
  * ([see example](slug:appearance_toolbar#toc-fill-mode)).
1196
- *
1197
1222
  * @default 'solid'
1198
1223
  */
1199
1224
  set fillMode(fillMode) {
@@ -1205,17 +1230,15 @@ class ToolBarComponent {
1205
1230
  return this._fillMode;
1206
1231
  }
1207
1232
  /**
1208
- * Specifies the [`tabindex`](https://developer.mozilla.org/en-US/docs/Web/HTML/Global_attributes/tabindex) of the ToolBar.
1233
+ * Sets the `tabindex` attribute of the ToolBar.
1234
+ * Use this property to control the tab order of the ToolBar component.
1235
+ * @default 0
1209
1236
  */
1210
1237
  tabindex = 0;
1211
1238
  /**
1212
- * Specifies the padding of all Toolbar elements.
1213
- *
1214
- * The possible values are:
1215
- * * `small`
1216
- * * `medium` (default)
1217
- * * `large`
1218
- * * `none`
1239
+ * Sets the size for all ToolBar elements.
1240
+ * Use this property to control the padding of the ToolBar elements.
1241
+ * @default 'medium'
1219
1242
  */
1220
1243
  set size(size) {
1221
1244
  const newSize = size ? size : DEFAULT_SIZE;
@@ -1235,8 +1258,9 @@ class ToolBarComponent {
1235
1258
  return this.tabindex;
1236
1259
  }
1237
1260
  /**
1238
- * Specifies the icons visibility for all tools in the ToolBar.
1239
- * This can be overridden by the `showIcon` property of each tool.
1261
+ * Sets the icon visibility for all tools in the ToolBar.
1262
+ * You can override this property for each tool using the `showIcon` property of the tool.
1263
+ * @default 'always'
1240
1264
  */
1241
1265
  set showIcon(value) {
1242
1266
  if (this._showIcon === value) {
@@ -1250,8 +1274,9 @@ class ToolBarComponent {
1250
1274
  });
1251
1275
  }
1252
1276
  /**
1253
- * Specifies the text visibility for all tools in the ToolBar.
1254
- * This can be overridden by the `showText` property of each tool.
1277
+ * Sets the text visibility for all tools in the ToolBar.
1278
+ * You can override this property for each tool using the `showText` property of the tool.
1279
+ * @default 'always'
1255
1280
  */
1256
1281
  set showText(value) {
1257
1282
  if (this._showText === value) {
@@ -1265,11 +1290,11 @@ class ToolBarComponent {
1265
1290
  });
1266
1291
  }
1267
1292
  /**
1268
- * Fires when the overflow popup of the ToolBar is opened.
1293
+ * Emits when the overflow popup of the ToolBar opens.
1269
1294
  */
1270
1295
  open = new EventEmitter();
1271
1296
  /**
1272
- * Fires when the overflow popup of the ToolBar is closed.
1297
+ * Emits when the overflow popup of the ToolBar closes.
1273
1298
  */
1274
1299
  close = new EventEmitter();
1275
1300
  allTools;
@@ -2567,6 +2592,16 @@ i0.ɵɵngDeclareClassMetadata({ minVersion: "12.0.0", version: "16.2.12", ngImpo
2567
2592
 
2568
2593
  /**
2569
2594
  * Represents the [Kendo UI ToolBar Button tool for Angular]({% slug controltypes_toolbar %}#toc-buttons).
2595
+ *
2596
+ * Use this component to render a button inside the ToolBar.
2597
+ *
2598
+ * @example
2599
+ * ```html
2600
+ * <kendo-toolbar>
2601
+ * <kendo-toolbar-button text="Button"></kendo-toolbar-button>
2602
+ * </kendo-toolbar>
2603
+ * ```
2604
+ *
2570
2605
  */
2571
2606
  class ToolBarButtonComponent extends ToolBarToolComponent {
2572
2607
  element;
@@ -2575,6 +2610,8 @@ class ToolBarButtonComponent extends ToolBarToolComponent {
2575
2610
  // showText and showIcon showIcon should be declared first
2576
2611
  /**
2577
2612
  * Specifies the button text visibility.
2613
+ * Accepts a `DisplayMode` value.
2614
+ * @default 'always'
2578
2615
  */
2579
2616
  set showText(value) {
2580
2617
  this._showText = value;
@@ -2585,6 +2622,8 @@ class ToolBarButtonComponent extends ToolBarToolComponent {
2585
2622
  }
2586
2623
  /**
2587
2624
  * Specifies the button icon visibility.
2625
+ * Accepts a `DisplayMode` value.
2626
+ * @default 'always'
2588
2627
  */
2589
2628
  set showIcon(value) {
2590
2629
  this._showIcon = value;
@@ -2594,7 +2633,8 @@ class ToolBarButtonComponent extends ToolBarToolComponent {
2594
2633
  return this._showIcon;
2595
2634
  }
2596
2635
  /**
2597
- * Specifies the text of the Button ([see example]({% slug controltypes_toolbar %}#toc-buttons)).
2636
+ * Specifies the text of the Button
2637
+ * ([see example]({% slug controltypes_toolbar %}#toc-buttons)).
2598
2638
  */
2599
2639
  set text(text) {
2600
2640
  this._text = text;
@@ -2610,26 +2650,27 @@ class ToolBarButtonComponent extends ToolBarToolComponent {
2610
2650
  return this.host.size;
2611
2651
  }
2612
2652
  /**
2613
- * Specifies custom inline CSS styles of the Button.
2653
+ * Specifies custom inline CSS styles for the Button.
2614
2654
  */
2615
2655
  style;
2616
2656
  /**
2617
- * Specifies custom CSS class names that will be added to the Button.
2657
+ * Specifies custom CSS class names to be added to the Button.
2618
2658
  */
2619
2659
  className;
2620
2660
  /**
2621
- * Specifies the title of the Button.
2661
+ * Specifies the `title` attribute of the Button.
2622
2662
  */
2623
2663
  title;
2624
2664
  /**
2625
- * If `disabled` is set to `true`, the Button is disabled
2665
+ * Disables the Button when set to `true`
2626
2666
  * ([see example]({% slug controltypes_toolbar %}#toc-buttons)).
2627
2667
  */
2628
2668
  disabled;
2629
2669
  /**
2630
- * Provides visual styling that indicates if the Button is active
2670
+ * Provides visual styling to indicate if the Button is active
2631
2671
  * ([see example]({% slug controltypes_toolbar %}#toc-toggle-buttons)).
2632
- * By default, `toggleable` is set to `false`.
2672
+ * For toggleable buttons, set this to `true`.
2673
+ * @default false
2633
2674
  */
2634
2675
  toggleable = false;
2635
2676
  /**
@@ -2651,37 +2692,20 @@ class ToolBarButtonComponent extends ToolBarToolComponent {
2651
2692
  }
2652
2693
  /**
2653
2694
  * Sets the selected state of the Button.
2695
+ * Use with the `toggleable` property.
2696
+ * @default false
2654
2697
  */
2655
2698
  selected = false;
2656
2699
  /**
2657
- * The fillMode property specifies the background and border styles of the Button.
2658
- *
2659
- * The available values are:
2660
- * * `solid` (default)
2661
- * * `flat`
2662
- * * `outline`
2663
- * * `link`
2664
- * * `null`
2700
+ * Specifies the background and border styles of the Button.
2701
+ * Accepts a `ButtonFillMode` value.
2702
+ * @default 'solid'
2665
2703
  */
2666
2704
  fillMode = 'solid';
2667
2705
  /**
2668
- * The Button allows you to specify predefined theme colors.
2669
- * The theme color will be applied as a background and border color while also amending the text color accordingly
2670
- * ([see example]({% slug api_buttons_dropdownbuttoncomponent %}#toc-themeColor)).
2671
- *
2672
- * The possible values are:
2673
- * * `base` &mdash;Applies coloring based on the `base` theme color. (default)
2674
- * * `primary` &mdash;Applies coloring based on the `primary` theme color.
2675
- * * `secondary`&mdash;Applies coloring based on the `secondary` theme color.
2676
- * * `tertiary`&mdash; Applies coloring based on the `tertiary` theme color.
2677
- * * `info`&mdash;Applies coloring based on the `info` theme color.
2678
- * * `success`&mdash; Applies coloring based on the `success` theme color.
2679
- * * `warning`&mdash; Applies coloring based on the `warning` theme color.
2680
- * * `error`&mdash; Applies coloring based on the `error` theme color.
2681
- * * `dark`&mdash; Applies coloring based on the `dark` theme color.
2682
- * * `light`&mdash; Applies coloring based on the `light` theme color.
2683
- * * `inverse`&mdash; Applies coloring based on the `inverse` theme color.
2684
- * * `null` &mdash;Removes the default CSS class (no class would be rendered).
2706
+ * Specifies the predefined theme color of the Button.
2707
+ * Accepts a `ButtonThemeColor` value.
2708
+ * @default 'base'
2685
2709
  */
2686
2710
  themeColor = 'base';
2687
2711
  /**
@@ -2694,8 +2718,8 @@ class ToolBarButtonComponent extends ToolBarToolComponent {
2694
2718
  this.overflowOptions.icon = getValueForLocation(icon, this.showIcon, true);
2695
2719
  }
2696
2720
  /**
2697
- * Defines a CSS class&mdash;or multiple classes separated by spaces&mdash;
2698
- * which are applied to a `span` element inside the Button. Allows the usage of custom icons.
2721
+ * Defines a CSS class or multiple classes to be applied to a `span` element inside the Button.
2722
+ * Allows the usage of custom icons.
2699
2723
  */
2700
2724
  set iconClass(iconClass) {
2701
2725
  this.toolbarOptions.iconClass = getValueForLocation(iconClass, this.showIcon, false);
@@ -2703,7 +2727,7 @@ class ToolBarButtonComponent extends ToolBarToolComponent {
2703
2727
  }
2704
2728
  /**
2705
2729
  * Defines an SVGIcon to be rendered within the button.
2706
- * The input can take either an [existing Kendo SVG icon](slug:svgicon_list) or a custom one.
2730
+ * Accepts either an [existing Kendo SVG icon](slug:svgicon_list) or a custom one.
2707
2731
  */
2708
2732
  set svgIcon(icon) {
2709
2733
  const isIconSet = this.toolbarOptions.icon || this.overflowOptions.icon;
@@ -2718,8 +2742,8 @@ class ToolBarButtonComponent extends ToolBarToolComponent {
2718
2742
  this.overflowOptions.svgIcon = getValueForLocation(icon, this.showIcon, true);
2719
2743
  }
2720
2744
  /**
2721
- * Defines a URL which is used for an `img` element inside the Button.
2722
- * The URL can be relative or absolute. If relative, it is evaluated with relation to the web page URL.
2745
+ * Defines a URL for an image to be rendered inside the Button.
2746
+ * The URL can be relative or absolute.
2723
2747
  */
2724
2748
  set imageUrl(imageUrl) {
2725
2749
  this.toolbarOptions.imageUrl = getValueForLocation(imageUrl, this.showIcon, false);
@@ -2730,11 +2754,11 @@ class ToolBarButtonComponent extends ToolBarToolComponent {
2730
2754
  */
2731
2755
  click = new EventEmitter();
2732
2756
  /**
2733
- * Fires when the Button [pointerdown](https://developer.mozilla.org/en-US/docs/Web/API/HTMLElement/pointerdown_event) event is triggered.
2757
+ * Fires when the Button's `pointerdown` event is triggered.
2734
2758
  */
2735
2759
  pointerdown = new EventEmitter();
2736
2760
  /**
2737
- * Fires each time the selected state of a Toggle Button is changed.
2761
+ * Fires each time the selected state of a toggleable Button is changed.
2738
2762
  * The event argument is the new selected state (Boolean).
2739
2763
  */
2740
2764
  selectedChange = new EventEmitter();
@@ -3199,35 +3223,44 @@ i0.ɵɵngDeclareClassMetadata({ minVersion: "12.0.0", version: "16.2.12", ngImpo
3199
3223
  }] } });
3200
3224
 
3201
3225
  /**
3202
- * Represents the Kendo UI Toolbar ButtonGroup for Angular.
3226
+ * Represents the [Kendo UI Toolbar ButtonGroup for Angular](slug:controltypes_toolbar#button-groups).
3227
+ *
3228
+ * Use this component to group buttons in a ButtonGroup inside the ToolBar.
3229
+ *
3230
+ * @example
3231
+ * ```html
3232
+ * <kendo-toolbar>
3233
+ * <kendo-toolbar-buttongroup>
3234
+ * <kendo-toolbar-button text="Bold"></kendo-toolbar-button>
3235
+ * <kendo-toolbar-button text="Underline"></kendo-toolbar-button>
3236
+ * <kendo-toolbar-button text="Italic"></kendo-toolbar-button>
3237
+ * </kendo-toolbar-buttongroup>
3238
+ * </kendo-toolbar>
3239
+ * ```
3203
3240
  */
3204
3241
  class ToolBarButtonGroupComponent extends ToolBarToolComponent {
3205
3242
  localization;
3206
3243
  host;
3207
3244
  /**
3208
- * By default, the ButtonGroup is enabled. To disable the whole group of buttons, set its `disabled`
3209
- * attribute to `true`. To disable a specific button, set the `disabled` attribute of the button to
3210
- * `true` and leave the `disabled` attribute of the ButtonGroup undefined. If you define the `disabled`
3211
- * attribute of the ButtonGroup, it will take precedence over the `disabled` attributes of the underlying
3212
- * buttons and they will be ignored.
3245
+ * When `true`, disables the whole group of buttons.
3246
+ * If you set the `disabled` property of the group, it overrides the `disabled` property of individual buttons.
3213
3247
  */
3214
3248
  disabled;
3215
3249
  /**
3216
3250
  * @hidden
3217
3251
  *
3218
3252
  * Used to set different fillmode in Spreadsheet and Toolbar to comply with referent rendering.
3253
+ * @default 'solid'
3219
3254
  */
3220
3255
  fillMode = 'solid';
3221
3256
  /**
3222
- * By default, the selection mode of the ButtonGroup is set to `multiple`.
3257
+ * Sets the selection mode of the ButtonGroup.
3258
+ * @default 'multiple'
3223
3259
  */
3224
3260
  selection = 'multiple';
3225
3261
  /**
3226
3262
  * Sets the width of the ButtonGroup.
3227
- *
3228
- * If the width of the ButtonGroup is set:
3229
- * - The buttons resize automatically to fill the full width of the group wrapper.
3230
- * - The buttons acquire the same width.
3263
+ * When you set the width of the ButtonGroup, the buttons have the same width and resize to fill the group wrapper.
3231
3264
  */
3232
3265
  width;
3233
3266
  /**
@@ -3609,13 +3642,24 @@ i0.ɵɵngDeclareClassMetadata({ minVersion: "12.0.0", version: "16.2.12", ngImpo
3609
3642
 
3610
3643
  /**
3611
3644
  * Represents the [Kendo UI ToolBar DropDownButton for Angular](slug:controltypes_toolbar#drop-down-buttons).
3645
+ *
3646
+ * Use this component to add a button that opens a popup with a list of items in the ToolBar.
3647
+ *
3648
+ * @example
3649
+ * ```html
3650
+ * <kendo-toolbar>
3651
+ * <kendo-toolbar-dropdownbutton text="Paste Variations" [data]="data">
3652
+ * </kendo-toolbar-dropdownbutton>
3653
+ * </kendo-toolbar>
3654
+ * ```
3655
+ *
3612
3656
  */
3613
3657
  class ToolBarDropDownButtonComponent extends ToolBarToolComponent {
3614
3658
  zone;
3615
3659
  renderer;
3616
3660
  host;
3617
3661
  /**
3618
- * Allows showing the default arrow icon or providing alternative one instead.
3662
+ * Shows the default arrow icon or lets you provide a custom one.
3619
3663
  * @default false
3620
3664
  */
3621
3665
  arrowIcon = false;
@@ -3626,7 +3670,8 @@ class ToolBarDropDownButtonComponent extends ToolBarToolComponent {
3626
3670
  title = '';
3627
3671
  // showText and showIcon showIcon should be declared first
3628
3672
  /**
3629
- * Specifies the button text visibility.
3673
+ * Controls the button text visibility.
3674
+ * @default 'always'
3630
3675
  */
3631
3676
  set showText(value) {
3632
3677
  this._showText = value;
@@ -3636,7 +3681,8 @@ class ToolBarDropDownButtonComponent extends ToolBarToolComponent {
3636
3681
  return this._showText;
3637
3682
  }
3638
3683
  /**
3639
- * Specifies the button icon visibility.
3684
+ * Controls the button icon visibility.
3685
+ * @default 'always'
3640
3686
  */
3641
3687
  set showIcon(value) {
3642
3688
  this._showIcon = value;
@@ -3656,15 +3702,15 @@ class ToolBarDropDownButtonComponent extends ToolBarToolComponent {
3656
3702
  return this._text;
3657
3703
  }
3658
3704
  /**
3659
- * Defines an icon that will be rendered next to the button text.
3705
+ * Sets the icon rendered next to the button text.
3660
3706
  */
3661
3707
  set icon(icon) {
3662
3708
  this.toolbarOptions.icon = getValueForLocation(icon, this.showIcon, false);
3663
3709
  this.overflowOptions.icon = getValueForLocation(icon, this.showIcon, true);
3664
3710
  }
3665
3711
  /**
3666
- * Defines an SVGIcon to be rendered within the button.
3667
- * The input can take either an [existing Kendo SVG icon](slug:svgicon_list) or a custom one.
3712
+ * Sets the `SVGIcon` rendered in the button.
3713
+ * Accepts an [existing Kendo SVG icon](slug:svgicon_list) or a custom one.
3668
3714
  */
3669
3715
  set svgIcon(icon) {
3670
3716
  const isIconSet = this.toolbarOptions.icon || this.overflowOptions.icon;
@@ -3679,14 +3725,14 @@ class ToolBarDropDownButtonComponent extends ToolBarToolComponent {
3679
3725
  this.overflowOptions.svgIcon = getValueForLocation(icon, this.showIcon, true);
3680
3726
  }
3681
3727
  /**
3682
- * Defines an icon with a custom CSS class that will be rendered next to the button text.
3728
+ * Sets a custom CSS class icon rendered next to the button text.
3683
3729
  */
3684
3730
  set iconClass(iconClass) {
3685
3731
  this.toolbarOptions.iconClass = getValueForLocation(iconClass, this.showIcon, false);
3686
3732
  this.overflowOptions.iconClass = getValueForLocation(iconClass, this.showIcon, true);
3687
3733
  }
3688
3734
  /**
3689
- * Defines the location of an image that will be displayed next to the button text.
3735
+ * Sets a URL for the image displayed next to the button text.
3690
3736
  */
3691
3737
  set imageUrl(imageUrl) {
3692
3738
  this.toolbarOptions.imageUrl = getValueForLocation(imageUrl, this.showIcon, false);
@@ -3694,10 +3740,7 @@ class ToolBarDropDownButtonComponent extends ToolBarToolComponent {
3694
3740
  }
3695
3741
  /**
3696
3742
  * Configures the popup of the DropDownButton.
3697
- *
3698
- * The available options are:
3699
- * - `animate:Boolean`&mdash;Controls the popup animation. By default, the open and close animations are enabled.
3700
- * - `popupClass:String`&mdash;Specifies a list of CSS classes that are used to style the popup.
3743
+ * Accepts a `PopupSettings` object that allows you to customize the popup behavior and appearance.
3701
3744
  */
3702
3745
  set popupSettings(settings) {
3703
3746
  this._popupSettings = Object.assign({ animate: true, popupClass: '' }, settings);
@@ -3720,55 +3763,37 @@ class ToolBarDropDownButtonComponent extends ToolBarToolComponent {
3720
3763
  this.themeColor = primary ? 'primary' : 'base';
3721
3764
  }
3722
3765
  /**
3723
- * The fillMode property specifies the background and border styles of the Button.
3724
- *
3725
- * The available values are:
3726
- * * `solid` (default)
3727
- * * `flat`
3728
- * * `outline`
3729
- * * `link`
3730
- * * `null`
3766
+ * Sets the fill mode for the button.
3767
+ * The fill mode represents the background and border styles.
3768
+ * @default 'solid'
3731
3769
  */
3732
3770
  fillMode = 'solid';
3733
3771
  /**
3734
- * The Button allows you to specify predefined theme colors.
3735
- * The theme color will be applied as a background and border color while also amending the text color accordingly
3772
+ * Sets the predefined theme color for the button.
3773
+ * The theme color applies to the background, border, and text
3736
3774
  * ([see example]({% slug api_buttons_dropdownbuttoncomponent %}#toc-themeColor)).
3737
- *
3738
- * The possible values are:
3739
- * * `base` &mdash;Applies coloring based on the `base` theme color. (default)
3740
- * * `primary` &mdash;Applies coloring based on the `primary` theme color.
3741
- * * `secondary`&mdash;Applies coloring based on the `secondary` theme color.
3742
- * * `tertiary`&mdash; Applies coloring based on the `tertiary` theme color.
3743
- * * `info`&mdash;Applies coloring based on the `info` theme color.
3744
- * * `success`&mdash; Applies coloring based on the `success` theme color.
3745
- * * `warning`&mdash; Applies coloring based on the `warning` theme color.
3746
- * * `error`&mdash; Applies coloring based on the `error` theme color.
3747
- * * `dark`&mdash; Applies coloring based on the `dark` theme color.
3748
- * * `light`&mdash; Applies coloring based on the `light` theme color.
3749
- * * `inverse`&mdash; Applies coloring based on the `inverse` theme color.
3750
- * * `null` &mdash;Removes the default CSS class (no class would be rendered).
3775
+ * @default 'base'
3751
3776
  */
3752
3777
  themeColor = 'base';
3753
3778
  /**
3754
- * The CSS classes that will be rendered on the main button.
3755
- * Supports the type of values that are supported by [`ngClass`](link:site.data.urls.angular['ngclassapi']).
3779
+ * Sets the CSS classes for the main button.
3780
+ * Accepts values supported by [`ngClass`](link:site.data.urls.angular['ngclassapi']).
3756
3781
  */
3757
3782
  buttonClass;
3758
3783
  /**
3759
- * Sets the data item field that represents the item text.
3760
- * If the data contains only primitive values, do not define it.
3784
+ * Sets the data item field that repesents the item text.
3785
+ * If the data contains only primitive values, do not set this property.
3761
3786
  */
3762
3787
  textField;
3763
3788
  /**
3764
- * Sets the disabled state of the DropDownButton.
3789
+ * When `true`, disables the DropDownButton.
3765
3790
  */
3766
3791
  disabled;
3767
3792
  /**
3768
3793
  * Sets the data of the DropDownButton
3769
3794
  * ([see example](slug:controltypes_toolbar#drop-down-buttons)).
3770
3795
  *
3771
- * > The data has to be provided in an array-like list.
3796
+ * > Provide the data as an array-like list.
3772
3797
  */
3773
3798
  set data(data) {
3774
3799
  this._data = data || [];
@@ -3781,17 +3806,17 @@ class ToolBarDropDownButtonComponent extends ToolBarToolComponent {
3781
3806
  }
3782
3807
  /**
3783
3808
  * Fires each time the user clicks a DropDownButton item.
3784
- * The event data contains the data item that is bound to the clicked list item.
3809
+ * The event data contains the clicked item's data.
3785
3810
  */
3786
3811
  itemClick = new EventEmitter();
3787
3812
  /**
3788
- * Fires each time the popup is about to open.
3789
- * This event is preventable. If you cancel the event, the popup will remain closed.
3813
+ * Fires when the popup is about to open.
3814
+ * This event is preventable. If you cancel the event, the popup stays closed.
3790
3815
  */
3791
3816
  open = new EventEmitter();
3792
3817
  /**
3793
- * Fires each time the popup is about to close.
3794
- * This event is preventable. If you cancel the event, the popup will remain open.
3818
+ * Fires when the popup is about to close.
3819
+ * This event is preventable. If you cancel the event, the popup stays open.
3795
3820
  */
3796
3821
  close = new EventEmitter();
3797
3822
  dropdownButton;
@@ -4184,13 +4209,24 @@ i0.ɵɵngDeclareClassMetadata({ minVersion: "12.0.0", version: "16.2.12", ngImpo
4184
4209
  }] } });
4185
4210
 
4186
4211
  /**
4187
- * Represents the [Kendo UI ToolBar SplitButton for Angular](slug:controltypes_toolbar#toc-split-buttons).
4212
+ * Represents the [Kendo UI ToolBar SplitButton for Angular](slug:controltypes_toolbar#split-buttons).
4213
+ *
4214
+ * Use the ToolBar SplitButton to create a split button with a main button and a drop-down list of actions in the ToolBar.
4215
+ *
4216
+ * @example
4217
+ * ```html
4218
+ * <kendo-toolbar>
4219
+ * <kendo-toolbar-splitbutton text="Paste" [data]="data">
4220
+ * </kendo-toolbar-splitbutton>
4221
+ * </kendo-toolbar>
4222
+ * ```
4188
4223
  */
4189
4224
  class ToolBarSplitButtonComponent extends ToolBarToolComponent {
4190
4225
  host;
4191
4226
  // showText and showIcon showIcon should be declared first
4192
4227
  /**
4193
- * Specifies the button text visibility.
4228
+ * Controls the button text visibility.
4229
+ * @default 'always'
4194
4230
  */
4195
4231
  set showText(value) {
4196
4232
  this._showText = value;
@@ -4200,7 +4236,8 @@ class ToolBarSplitButtonComponent extends ToolBarToolComponent {
4200
4236
  return this._showText;
4201
4237
  }
4202
4238
  /**
4203
- * Specifies the button icon visibility.
4239
+ * Controls the button icon visibility.
4240
+ * @default 'always'
4204
4241
  */
4205
4242
  set showIcon(value) {
4206
4243
  this._showIcon = value;
@@ -4220,7 +4257,7 @@ class ToolBarSplitButtonComponent extends ToolBarToolComponent {
4220
4257
  return this._text;
4221
4258
  }
4222
4259
  /**
4223
- * Defines the icon that will be rendered next to the button text
4260
+ * Sets the icon rendered next to the button text
4224
4261
  * ([see example](slug:controltypes_toolbar#toc-split-buttons)).
4225
4262
  */
4226
4263
  set icon(icon) {
@@ -4228,8 +4265,8 @@ class ToolBarSplitButtonComponent extends ToolBarToolComponent {
4228
4265
  this.overflowOptions.icon = getValueForLocation(icon, this.showIcon, true);
4229
4266
  }
4230
4267
  /**
4231
- * Defines an SVGIcon to be rendered within the main button.
4232
- * The input can take either an [existing Kendo SVG icon](slug:svgicon_list) or a custom one.
4268
+ * Sets the `SVGIcon` rendered in the main button.
4269
+ * Accepts an [existing Kendo SVG icon](slug:svgicon_list) or a custom one.
4233
4270
  */
4234
4271
  set svgIcon(icon) {
4235
4272
  const isIconSet = this.toolbarOptions.icon || this.overflowOptions.icon;
@@ -4244,29 +4281,27 @@ class ToolBarSplitButtonComponent extends ToolBarToolComponent {
4244
4281
  this.overflowOptions.svgIcon = getValueForLocation(icon, this.showIcon, true);
4245
4282
  }
4246
4283
  /**
4247
- * Defines an icon with a custom CSS class that will be rendered next to the button text.
4284
+ * Sets a custom CSS class icon rendered next to the button text.
4248
4285
  */
4249
4286
  set iconClass(iconClass) {
4250
4287
  this.toolbarOptions.iconClass = getValueForLocation(iconClass, this.showIcon, false);
4251
4288
  this.overflowOptions.iconClass = getValueForLocation(iconClass, this.showIcon, true);
4252
4289
  }
4253
4290
  /**
4254
- * Defines the location of an image that will be displayed next to the button text.
4291
+ * Sets a URL for the image displayed next to the button text.
4255
4292
  */
4256
4293
  set imageUrl(imageUrl) {
4257
4294
  this.toolbarOptions.imageUrl = getValueForLocation(imageUrl, this.showIcon, false);
4258
4295
  this.overflowOptions.imageUrl = getValueForLocation(imageUrl, this.showIcon, true);
4259
4296
  }
4260
4297
  /**
4261
- * When set to `true`, disables a SplitButton item.
4298
+ * When `true`, disables a SplitButton item.
4262
4299
  */
4263
4300
  disabled;
4264
4301
  /**
4265
4302
  * Configures the popup of the SplitButton.
4266
- *
4267
- * The available options are:
4268
- * - `animate:Boolean`&mdash;Controls the popup animation. By default, the open and close animations are enabled.
4269
- * - `popupClass:String`&mdash;Specifies a list of CSS classes that are used to style the popup.
4303
+ * Accepts a `PopupSettings` object that allows you to customize the popup behavior and appearance.
4304
+
4270
4305
  */
4271
4306
  set popupSettings(value) {
4272
4307
  this._popupSettings = value;
@@ -4278,33 +4313,15 @@ class ToolBarSplitButtonComponent extends ToolBarToolComponent {
4278
4313
  return this._popupSettings;
4279
4314
  }
4280
4315
  /**
4281
- * The fillMode property specifies the background and border styles of the Button.
4282
- *
4283
- * The available values are:
4284
- * * `solid` (default)
4285
- * * `flat`
4286
- * * `outline`
4287
- * * `link`
4288
- * * `null`
4316
+ * Sets the fill mode for the button.
4317
+ * The fill mode represents the background and border styles.
4318
+ * @default 'solid'
4289
4319
  */
4290
4320
  fillMode = 'solid';
4291
4321
  /**
4292
- * The Button allows you to specify predefined theme colors.
4293
- * The theme color will be applied as a background and border color while also amending the text color accordingly.
4294
- *
4295
- * The possible values are:
4296
- * * `base` &mdash;Applies coloring based on the `base` theme color. (default)
4297
- * * `primary` &mdash;Applies coloring based on the `primary` theme color.
4298
- * * `secondary`&mdash;Applies coloring based on the `secondary` theme color.
4299
- * * `tertiary`&mdash; Applies coloring based on the `tertiary` theme color.
4300
- * * `info`&mdash;Applies coloring based on the `info` theme color.
4301
- * * `success`&mdash; Applies coloring based on the `success` theme color.
4302
- * * `warning`&mdash; Applies coloring based on the `warning` theme color.
4303
- * * `error`&mdash; Applies coloring based on the `error` theme color.
4304
- * * `dark`&mdash; Applies coloring based on the `dark` theme color.
4305
- * * `light`&mdash; Applies coloring based on the `light` theme color.
4306
- * * `inverse`&mdash; Applies coloring based on the `inverse` theme color.
4307
- * * `null` &mdash;Removes the default CSS class (no class would be rendered).
4322
+ * Sets the predefined theme color for the button.
4323
+ * The theme color applies to the background, border, and text.
4324
+ * @default 'base'
4308
4325
  */
4309
4326
  themeColor = 'base';
4310
4327
  /**
@@ -4316,33 +4333,32 @@ class ToolBarSplitButtonComponent extends ToolBarToolComponent {
4316
4333
  }
4317
4334
  }
4318
4335
  /**
4319
- * The CSS classes that will be rendered on the main button.
4320
- * Supports the type of values that are supported by [`ngClass`](link:site.data.urls.angular['ngclassapi']).
4336
+ * Sets the CSS classes for the main button.
4337
+ * Accepts values supported by [`ngClass`](link:site.data.urls.angular['ngclassapi']).
4321
4338
  */
4322
4339
  buttonClass;
4323
4340
  /**
4324
- * The CSS classes that will be rendered on the button which opens the popup.
4325
- * Supports the type of values that are supported by [`ngClass`](link:site.data.urls.angular['ngclassapi']).
4341
+ * Sets the CSS classes for the arrow button that opens the popup.
4342
+ * Accepts values supported by [`ngClass`](link:site.data.urls.angular['ngclassapi']).
4326
4343
  */
4327
4344
  arrowButtonClass;
4328
4345
  /**
4329
- * Specifies the name of the [font icon](slug:icons#icons-list) that will
4330
- * be rendered for the button which opens the popup.
4346
+ * Sets the name of the [font icon](slug:icons#icons-list) for the arrow button.
4331
4347
  */
4332
4348
  arrowButtonIcon = 'caret-alt-down';
4333
4349
  /**
4334
- * Specifies the [`SVGIcon`](slug:api_icons_svgicon) that will
4335
- * be rendered for the button which opens the popup.
4350
+ * Sets the [`SVGIcon`](slug:api_icons_svgicon) for the arrow button.
4336
4351
  */
4337
4352
  arrowButtonSvgIcon = caretAltDownIcon;
4338
4353
  /**
4339
- * Configures the text field of the button-list popup.
4354
+ * Sets the text field for the button-list popup.
4355
+ * @default 'text'
4340
4356
  */
4341
4357
  textField = 'text';
4342
4358
  /**
4343
4359
  * Sets the data of the SplitButton ([see example](slug:controltypes_toolbar#toc-split-buttons)).
4344
4360
  *
4345
- * > The data has to be provided in an array-like list.
4361
+ * > Provide the data as an array-like list.
4346
4362
  */
4347
4363
  set data(data) {
4348
4364
  this._data = data || [];
@@ -4354,22 +4370,22 @@ class ToolBarSplitButtonComponent extends ToolBarToolComponent {
4354
4370
  return this._data;
4355
4371
  }
4356
4372
  /**
4357
- * Fires each time the user clicks the main button.
4373
+ * Fires when the user clicks the main button.
4358
4374
  */
4359
4375
  buttonClick = new EventEmitter();
4360
4376
  /**
4361
- * Fires each time the user clicks the drop-down list.
4362
- * The event data contains the data item that is bound to the clicked list item.
4377
+ * Fires when the user clicks a drop-down list item.
4378
+ * The event data contains the clicked item's data.
4363
4379
  */
4364
4380
  itemClick = new EventEmitter();
4365
4381
  /**
4366
- * Fires each time the popup is about to open.
4367
- * This event is preventable. If you cancel the event, the popup will remain closed.
4382
+ * Fires when the popup is about to open.
4383
+ * This event is preventable. If you cancel the event, the popup stays closed.
4368
4384
  */
4369
4385
  open = new EventEmitter();
4370
4386
  /**
4371
- * Fires each time the popup is about to close.
4372
- * This event is preventable. If you cancel the event, the popup will remain open.
4387
+ * Fires when the popup is about to close.
4388
+ * This event is preventable. If you cancel the event, the popup stays open.
4373
4389
  */
4374
4390
  close = new EventEmitter();
4375
4391
  toolbarOptions = {
@@ -4774,6 +4790,17 @@ i0.ɵɵngDeclareClassMetadata({ minVersion: "12.0.0", version: "16.2.12", ngImpo
4774
4790
 
4775
4791
  /**
4776
4792
  * Represents the [Kendo UI ToolBar Separator for Angular]({% slug controltypes_toolbar %}#toc-separators).
4793
+ *
4794
+ * Use this component to add a visual separator between ToolBar tools.
4795
+ *
4796
+ * @example
4797
+ * ```html
4798
+ * <kendo-toolbar>
4799
+ * <kendo-toolbar-button text="Button 1"></kendo-toolbar-button>
4800
+ * <kendo-toolbar-separator></kendo-toolbar-separator>
4801
+ * <kendo-toolbar-button text="Button 2"></kendo-toolbar-button>
4802
+ * </kendo-toolbar>
4803
+ * ```
4777
4804
  */
4778
4805
  class ToolBarSeparatorComponent extends ToolBarToolComponent {
4779
4806
  separator;
@@ -4853,6 +4880,17 @@ i0.ɵɵngDeclareClassMetadata({ minVersion: "12.0.0", version: "16.2.12", ngImpo
4853
4880
 
4854
4881
  /**
4855
4882
  * Represents the [Kendo UI ToolBar Spacer for Angular]({% slug controltypes_toolbar %}#toc-separators).
4883
+ *
4884
+ * Use the ToolBar Spacer to add flexible space between ToolBar tools.
4885
+ *
4886
+ * @example
4887
+ * ```html
4888
+ * <kendo-toolbar>
4889
+ * <kendo-toolbar-button text="Button 1"></kendo-toolbar-button>
4890
+ * <kendo-toolbar-spacer></kendo-toolbar-spacer>
4891
+ * <kendo-toolbar-button text="Button 2"></kendo-toolbar-button>
4892
+ * </kendo-toolbar>
4893
+ * ```
4856
4894
  */
4857
4895
  class ToolBarSpacerComponent extends ToolBarToolComponent {
4858
4896
  /**
@@ -4911,7 +4949,20 @@ i0.ɵɵngDeclareClassMetadata({ minVersion: "12.0.0", version: "16.2.12", ngImpo
4911
4949
  }], ctorParameters: function () { return []; } });
4912
4950
 
4913
4951
  /**
4914
- * Custom component messages override default component messages.
4952
+ * Represents the custom messages component of the ToolBar.
4953
+ *
4954
+ * Use this component to override default messages for the ToolBar.
4955
+ *
4956
+ * @example
4957
+ * ```html
4958
+ * <kendo-toolbar>
4959
+ * <kendo-toolbar-messages
4960
+ * moreToolsTitle="More options"
4961
+ * previousToolButton="Previous"
4962
+ * nextToolButton="Next">
4963
+ * </kendo-toolbar-messages>
4964
+ * </kendo-toolbar>
4965
+ * ```
4915
4966
  */
4916
4967
  class ToolbarCustomMessagesComponent extends ToolbarMessages {
4917
4968
  service;
@@ -4962,10 +5013,10 @@ const KENDO_TOOLBAR = [
4962
5013
 
4963
5014
  // IMPORTANT: NgModule export kept for backwards compatibility
4964
5015
  /**
4965
- * Represents the [NgModule](link:site.data.urls.angular['ngmoduleapi']) definition for the ToolBar component.
5016
+ * Defines the [NgModule](link:site.data.urls.angular['ngmoduleapi']) for the ToolBar component.
4966
5017
  *
4967
5018
  * The package exports:
4968
- * - `ToolBarComponent`&mdash;The ToolBarComponent class.
5019
+ * - `ToolBarComponent`&mdash;The ToolBar component class.
4969
5020
  * - `ToolBarToolComponent`&mdash;The base Tool component class.
4970
5021
  * - `ToolBarButtonComponent`&mdash;The Button Tool component class.
4971
5022
  * - `ToolBarButtonGroupComponent`&mdash;The ButtonGroup Tool component class.