@progress/kendo-angular-toolbar 24.2.2 → 25.0.0-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.
- package/fesm2022/progress-kendo-angular-toolbar.mjs +60 -60
- package/index.d.ts +1529 -21
- package/package-metadata.mjs +2 -2
- package/package.json +13 -13
- package/common/fillmode.d.ts +0 -8
- package/common/overflow-mode.d.ts +0 -8
- package/common/overflow-settings.d.ts +0 -45
- package/common/preventable-event.d.ts +0 -21
- package/common/renderer-click.d.ts +0 -12
- package/common/scroll-buttons.d.ts +0 -22
- package/common/size.d.ts +0 -8
- package/direction.d.ts +0 -8
- package/directives.d.ts +0 -35
- package/display-mode.d.ts +0 -16
- package/group-selection-settings.d.ts +0 -9
- package/localization/custom-messages.component.d.ts +0 -30
- package/localization/localized-toolbar-messages.directive.d.ts +0 -16
- package/localization/messages.d.ts +0 -25
- package/navigation.service.d.ts +0 -36
- package/package-metadata.d.ts +0 -9
- package/popup-settings.d.ts +0 -60
- package/refresh.service.d.ts +0 -16
- package/render-location.d.ts +0 -8
- package/renderer.component.d.ts +0 -47
- package/renderer.service.d.ts +0 -24
- package/scroll.service.d.ts +0 -43
- package/scrollable-button.component.d.ts +0 -40
- package/tool-options.d.ts +0 -15
- package/toolbar.component.d.ts +0 -316
- package/toolbar.module.d.ts +0 -32
- package/tools/toolbar-button.component.d.ts +0 -198
- package/tools/toolbar-buttongroup.component.d.ts +0 -117
- package/tools/toolbar-dropdownbutton.component.d.ts +0 -195
- package/tools/toolbar-separator.component.d.ts +0 -40
- package/tools/toolbar-spacer.component.d.ts +0 -43
- package/tools/toolbar-splitbutton.component.d.ts +0 -194
- package/tools/toolbar-tool.component.d.ts +0 -77
- package/tools/tools.service.d.ts +0 -21
- package/util.d.ts +0 -115
package/index.d.ts
CHANGED
|
@@ -2,24 +2,1532 @@
|
|
|
2
2
|
* Copyright © 2026 Progress Software Corporation. All rights reserved.
|
|
3
3
|
* Licensed under commercial license. See LICENSE.md in the project root for more information
|
|
4
4
|
*-------------------------------------------------------------------------------------------*/
|
|
5
|
-
|
|
6
|
-
|
|
7
|
-
|
|
8
|
-
|
|
9
|
-
|
|
10
|
-
|
|
11
|
-
|
|
12
|
-
|
|
13
|
-
|
|
14
|
-
|
|
15
|
-
|
|
16
|
-
|
|
17
|
-
|
|
18
|
-
|
|
19
|
-
|
|
20
|
-
|
|
21
|
-
|
|
22
|
-
|
|
23
|
-
|
|
24
|
-
|
|
25
|
-
|
|
5
|
+
import * as i0 from '@angular/core';
|
|
6
|
+
import { TemplateRef, ElementRef, EventEmitter, OnInit, OnDestroy, Renderer2, ViewContainerRef, NgZone, QueryList, ChangeDetectorRef, SimpleChanges, AfterViewInit } from '@angular/core';
|
|
7
|
+
import { Align, PopupRef, PopupService } from '@progress/kendo-angular-popup';
|
|
8
|
+
import { ResizeSensorComponent } from '@progress/kendo-angular-common';
|
|
9
|
+
import { LocalizationService, ComponentMessages } from '@progress/kendo-angular-l10n';
|
|
10
|
+
import { LicenseMessage } from '@progress/kendo-licensing';
|
|
11
|
+
import { Subject } from 'rxjs';
|
|
12
|
+
import { SVGIcon } from '@progress/kendo-svg-icons';
|
|
13
|
+
import { ButtonFillMode, ButtonRounded, ButtonThemeColor, PreventableEvent as PreventableEvent$1, ArrowIconSettings, DropDownButtonComponent } from '@progress/kendo-angular-buttons';
|
|
14
|
+
|
|
15
|
+
/**
|
|
16
|
+
* @hidden
|
|
17
|
+
*/
|
|
18
|
+
type RenderLocation = 'toolbar' | 'overflow' | 'section';
|
|
19
|
+
|
|
20
|
+
/**
|
|
21
|
+
* Represents the base ToolBar Tool component for Angular.
|
|
22
|
+
*
|
|
23
|
+
* Extend this class to create a custom tool for the ToolBar.
|
|
24
|
+
*
|
|
25
|
+
* @example
|
|
26
|
+
* ```typescript
|
|
27
|
+
* import { Component } from '@angular/core';
|
|
28
|
+
* import { ToolBarToolComponent } from '@progress/kendo-angular-toolbar';
|
|
29
|
+
*
|
|
30
|
+
* @Component({
|
|
31
|
+
* providers: [{ provide: ToolBarToolComponent, useExisting: forwardRef(() => CustomToolComponent) }],
|
|
32
|
+
* selector: 'custom-tool',
|
|
33
|
+
* })
|
|
34
|
+
*
|
|
35
|
+
* export class CustomToolComponent extends ToolBarToolComponent {
|
|
36
|
+
*
|
|
37
|
+
* constructor() {
|
|
38
|
+
* super();
|
|
39
|
+
* }
|
|
40
|
+
* }
|
|
41
|
+
* ```
|
|
42
|
+
*/
|
|
43
|
+
declare class ToolBarToolComponent {
|
|
44
|
+
toolbarTemplate: TemplateRef<any>;
|
|
45
|
+
sectionTemplate: TemplateRef<any>;
|
|
46
|
+
popupTemplate: TemplateRef<any>;
|
|
47
|
+
tabIndex: number;
|
|
48
|
+
overflows: boolean;
|
|
49
|
+
visibility: string;
|
|
50
|
+
element: ElementRef;
|
|
51
|
+
isBuiltInTool: boolean;
|
|
52
|
+
/**
|
|
53
|
+
* @hidden
|
|
54
|
+
*/
|
|
55
|
+
isHidden: boolean;
|
|
56
|
+
/**
|
|
57
|
+
* @hidden
|
|
58
|
+
*/
|
|
59
|
+
location: RenderLocation;
|
|
60
|
+
constructor();
|
|
61
|
+
/**
|
|
62
|
+
* @hidden
|
|
63
|
+
*/
|
|
64
|
+
responsive: boolean;
|
|
65
|
+
get toolbarDisplay(): string;
|
|
66
|
+
get overflowDisplay(): string;
|
|
67
|
+
/**
|
|
68
|
+
* Determines if the tool can receive focus.
|
|
69
|
+
* Returns `true` if the tool participates in keyboard navigation.
|
|
70
|
+
* @returns `true` if the tool is focusable.
|
|
71
|
+
*/
|
|
72
|
+
canFocus(): boolean;
|
|
73
|
+
/**
|
|
74
|
+
* Called when the tool receives focus.
|
|
75
|
+
* Accepts the original browser event, which can be a `KeyboardEvent`, `MouseEvent`, or `FocusEvent`.
|
|
76
|
+
* @param {Event} _ev - The event that triggers focus for the tool.
|
|
77
|
+
*/
|
|
78
|
+
focus(_ev?: Event): void;
|
|
79
|
+
/**
|
|
80
|
+
* Called when the tool is focused and an arrow key is pressed.
|
|
81
|
+
* Returns a boolean value that determines if the `ToolBarComponent` moves focus to the next or previous tool
|
|
82
|
+
* ([see example](https://www.telerik.com/kendo-angular-ui/components/toolbar/custom-control-types#adding-keyboard-navigation)).
|
|
83
|
+
* @param {KeyboardEvent} _ev - The last pressed arrow key.
|
|
84
|
+
* @returns `true` if focus moves to another tool.
|
|
85
|
+
*/
|
|
86
|
+
handleKey(_ev: KeyboardEvent): boolean;
|
|
87
|
+
static ɵfac: i0.ɵɵFactoryDeclaration<ToolBarToolComponent, never>;
|
|
88
|
+
static ɵdir: i0.ɵɵDirectiveDeclaration<ToolBarToolComponent, never, never, { "responsive": { "alias": "responsive"; "required": false; }; }, {}, never, never, true, never>;
|
|
89
|
+
}
|
|
90
|
+
|
|
91
|
+
/**
|
|
92
|
+
* @hidden
|
|
93
|
+
*/
|
|
94
|
+
declare class RefreshService {
|
|
95
|
+
onRefresh: EventEmitter<any>;
|
|
96
|
+
refresh(tool: ToolBarToolComponent): void;
|
|
97
|
+
static ɵfac: i0.ɵɵFactoryDeclaration<RefreshService, never>;
|
|
98
|
+
static ɵprov: i0.ɵɵInjectableDeclaration<RefreshService>;
|
|
99
|
+
}
|
|
100
|
+
|
|
101
|
+
/**
|
|
102
|
+
* @hidden
|
|
103
|
+
*/
|
|
104
|
+
declare class RendererService {
|
|
105
|
+
element: ElementRef;
|
|
106
|
+
renderer: ToolBarRendererComponent;
|
|
107
|
+
getElement(): HTMLElement;
|
|
108
|
+
querySelector(selector: string): HTMLElement;
|
|
109
|
+
querySelectorAll(selector: string): NodeList;
|
|
110
|
+
findFocusable(): HTMLElement;
|
|
111
|
+
findFocusableChild(element?: HTMLElement): HTMLElement;
|
|
112
|
+
findNextFocusableSibling(element?: HTMLElement): HTMLElement;
|
|
113
|
+
findPrevFocusableSibling(element?: HTMLElement): HTMLElement;
|
|
114
|
+
setAttribute(element: HTMLElement, attr: string, value: string): void;
|
|
115
|
+
static ɵfac: i0.ɵɵFactoryDeclaration<RendererService, never>;
|
|
116
|
+
static ɵprov: i0.ɵɵInjectableDeclaration<RendererService>;
|
|
117
|
+
}
|
|
118
|
+
|
|
119
|
+
/**
|
|
120
|
+
* @hidden
|
|
121
|
+
*/
|
|
122
|
+
interface RendererClickPayload {
|
|
123
|
+
context: ToolBarRendererComponent;
|
|
124
|
+
event: Event;
|
|
125
|
+
}
|
|
126
|
+
|
|
127
|
+
/**
|
|
128
|
+
* @hidden
|
|
129
|
+
*/
|
|
130
|
+
declare class ToolbarToolsService {
|
|
131
|
+
renderedToolsChange: Subject<ToolBarRendererComponent[]>;
|
|
132
|
+
overflowToolsChange: Subject<ToolBarRendererComponent[]>;
|
|
133
|
+
renderedTools: ToolBarRendererComponent[];
|
|
134
|
+
overflowTools: ToolBarRendererComponent[];
|
|
135
|
+
allTools: ToolBarToolComponent[];
|
|
136
|
+
reset(): void;
|
|
137
|
+
static ɵfac: i0.ɵɵFactoryDeclaration<ToolbarToolsService, never>;
|
|
138
|
+
static ɵprov: i0.ɵɵInjectableDeclaration<ToolbarToolsService>;
|
|
139
|
+
}
|
|
140
|
+
|
|
141
|
+
/**
|
|
142
|
+
* @hidden
|
|
143
|
+
*/
|
|
144
|
+
declare class ToolBarRendererComponent implements OnInit, OnDestroy {
|
|
145
|
+
private renderer;
|
|
146
|
+
private rendererService;
|
|
147
|
+
private refreshService;
|
|
148
|
+
private toolsService;
|
|
149
|
+
private viewContainer;
|
|
150
|
+
tool: ToolBarToolComponent;
|
|
151
|
+
location: RenderLocation;
|
|
152
|
+
resizable: boolean;
|
|
153
|
+
rendererClick: EventEmitter<RendererClickPayload>;
|
|
154
|
+
template: TemplateRef<any>;
|
|
155
|
+
element: ElementRef;
|
|
156
|
+
private get isSpacer();
|
|
157
|
+
private refreshSubscription;
|
|
158
|
+
private internalComponentRef;
|
|
159
|
+
constructor(renderer: Renderer2, rendererService: RendererService, refreshService: RefreshService, toolsService: ToolbarToolsService, viewContainer: ViewContainerRef);
|
|
160
|
+
ngOnInit(): void;
|
|
161
|
+
ngOnDestroy(): void;
|
|
162
|
+
ngAfterViewInit(): void;
|
|
163
|
+
/**
|
|
164
|
+
* @hidden
|
|
165
|
+
*/
|
|
166
|
+
get width(): number;
|
|
167
|
+
isDisplayed(): boolean;
|
|
168
|
+
refresh(): void;
|
|
169
|
+
setAttribute(element: HTMLElement, attr: string, value: string): void;
|
|
170
|
+
private onClick;
|
|
171
|
+
private updateTools;
|
|
172
|
+
private hideTool;
|
|
173
|
+
static ɵfac: i0.ɵɵFactoryDeclaration<ToolBarRendererComponent, never>;
|
|
174
|
+
static ɵdir: i0.ɵɵDirectiveDeclaration<ToolBarRendererComponent, "[kendoToolbarRenderer]", never, { "tool": { "alias": "tool"; "required": false; }; "location": { "alias": "location"; "required": false; }; "resizable": { "alias": "resizable"; "required": false; }; }, { "rendererClick": "rendererClick"; }, never, never, true, never>;
|
|
175
|
+
}
|
|
176
|
+
|
|
177
|
+
/**
|
|
178
|
+
* @hidden
|
|
179
|
+
*/
|
|
180
|
+
declare class NavigationService {
|
|
181
|
+
private zone;
|
|
182
|
+
overflowButton: ElementRef<HTMLButtonElement>;
|
|
183
|
+
private focused;
|
|
184
|
+
private renderedTools;
|
|
185
|
+
private isPopupFocused;
|
|
186
|
+
private isOverflowButtonFocused;
|
|
187
|
+
constructor(zone: NgZone);
|
|
188
|
+
setRenderedTools(rts: ToolBarRendererComponent[]): void;
|
|
189
|
+
click({ context, event: ev }: RendererClickPayload): void;
|
|
190
|
+
moveFocusToToolBar(): void;
|
|
191
|
+
moveFocusToPopup(): void;
|
|
192
|
+
focusNext(ev: KeyboardEvent): void;
|
|
193
|
+
focusPrev(ev: KeyboardEvent): void;
|
|
194
|
+
resetNavigation(): void;
|
|
195
|
+
focusFirst(ev: Event): void;
|
|
196
|
+
focusLast(ev: Event): void;
|
|
197
|
+
private getFocusableTools;
|
|
198
|
+
private focus;
|
|
199
|
+
private blurOverflowButton;
|
|
200
|
+
private focusOverflowButton;
|
|
201
|
+
private isOverflowButtonVisible;
|
|
202
|
+
static ɵfac: i0.ɵɵFactoryDeclaration<NavigationService, never>;
|
|
203
|
+
static ɵprov: i0.ɵɵInjectableDeclaration<NavigationService>;
|
|
204
|
+
}
|
|
205
|
+
|
|
206
|
+
/**
|
|
207
|
+
* Configures the options for the popup container.
|
|
208
|
+
*
|
|
209
|
+
* Represents the Kendo UI for Angular ToolBar popup settings.
|
|
210
|
+
*
|
|
211
|
+
* @example
|
|
212
|
+
* ```ts
|
|
213
|
+
* @Component({
|
|
214
|
+
* selector: 'my-app',
|
|
215
|
+
* template: `
|
|
216
|
+
* <kendo-toolbar [overflow]="true" [popupSettings]="{ animate: false }">
|
|
217
|
+
* <kendo-toolbar-button text="my button"></kendo-toolbar-button>
|
|
218
|
+
* </kendo-toolbar>
|
|
219
|
+
* `
|
|
220
|
+
* })
|
|
221
|
+
* class AppComponent { }
|
|
222
|
+
* ```
|
|
223
|
+
*/
|
|
224
|
+
interface PopupSettings {
|
|
225
|
+
/**
|
|
226
|
+
* Controls the popup animation.
|
|
227
|
+
* By default, the open and close animations are enabled.
|
|
228
|
+
*/
|
|
229
|
+
animate?: boolean;
|
|
230
|
+
/**
|
|
231
|
+
* Controls the popup container.
|
|
232
|
+
* By default, the popup is appended to the root component.
|
|
233
|
+
*/
|
|
234
|
+
appendTo?: 'root' | 'component' | ViewContainerRef;
|
|
235
|
+
/**
|
|
236
|
+
* Sets CSS classes for styling the popup.
|
|
237
|
+
*/
|
|
238
|
+
popupClass?: string | string[] | Set<string> | object;
|
|
239
|
+
/**
|
|
240
|
+
* Sets the anchor pivot point.
|
|
241
|
+
*/
|
|
242
|
+
anchorAlign?: Align;
|
|
243
|
+
/**
|
|
244
|
+
* Sets the popup pivot point.
|
|
245
|
+
*/
|
|
246
|
+
popupAlign?: Align;
|
|
247
|
+
/**
|
|
248
|
+
* Sets the popup width.
|
|
249
|
+
* The default value is `150` pixels.
|
|
250
|
+
* Use a number for pixels or a string for arbitrary units like `"50%"`.
|
|
251
|
+
*/
|
|
252
|
+
width?: number | string;
|
|
253
|
+
/**
|
|
254
|
+
* Sets the popup height.
|
|
255
|
+
* By default, the popup height matches its content.
|
|
256
|
+
* Use a number for pixels or a string for arbitrary units like `"50%"`.
|
|
257
|
+
*/
|
|
258
|
+
height?: number | string;
|
|
259
|
+
}
|
|
260
|
+
|
|
261
|
+
/**
|
|
262
|
+
* Represents the possible size options of the ToolBar.
|
|
263
|
+
*/
|
|
264
|
+
type ToolbarSize = 'small' | 'medium' | 'large';
|
|
265
|
+
|
|
266
|
+
/**
|
|
267
|
+
* @hidden
|
|
268
|
+
*/
|
|
269
|
+
declare class PreventableEvent {
|
|
270
|
+
private prevented;
|
|
271
|
+
/**
|
|
272
|
+
* Prevents the default action for a specified event.
|
|
273
|
+
* In this way, the source component suppresses the built-in behavior that follows the event.
|
|
274
|
+
*/
|
|
275
|
+
preventDefault(): void;
|
|
276
|
+
/**
|
|
277
|
+
* If the event is prevented by any of its subscribers, returns `true`.
|
|
278
|
+
*
|
|
279
|
+
* @returns `true` if the default action was prevented. Otherwise, returns `false`.
|
|
280
|
+
*/
|
|
281
|
+
isDefaultPrevented(): boolean;
|
|
282
|
+
}
|
|
283
|
+
|
|
284
|
+
/**
|
|
285
|
+
* @hidden
|
|
286
|
+
*/
|
|
287
|
+
type Direction = 'rtl' | 'ltr';
|
|
288
|
+
|
|
289
|
+
/**
|
|
290
|
+
* Represents the possible fill mode options of the ToolBar.
|
|
291
|
+
*/
|
|
292
|
+
type ToolbarFillMode = 'solid' | 'flat' | 'outline';
|
|
293
|
+
|
|
294
|
+
/**
|
|
295
|
+
* Sets how the ToolBar handles overflow when there is not enough space to display all tools.
|
|
296
|
+
*/
|
|
297
|
+
type OverflowMode = 'scroll' | 'section' | 'menu' | 'none';
|
|
298
|
+
|
|
299
|
+
/**
|
|
300
|
+
* Controls when the ToolBar renders scroll buttons.
|
|
301
|
+
*
|
|
302
|
+
* The possible options are:
|
|
303
|
+
* - `auto`(default)—Renders the scroll buttons only when the tools overflow the ToolBar container.
|
|
304
|
+
* - `visible`—Always renders the scroll buttons.
|
|
305
|
+
* - `hidden`—Never renders the scroll buttons.
|
|
306
|
+
*/
|
|
307
|
+
type ToolbarScrollButtonsVisibility = 'hidden' | 'visible' | 'auto';
|
|
308
|
+
/**
|
|
309
|
+
* Controls where the ToolBar renders scroll buttons.
|
|
310
|
+
*
|
|
311
|
+
* The possible options are:
|
|
312
|
+
* - `start`—Renders the scroll buttons at the start before all tools.
|
|
313
|
+
* - `end`—Renders the scroll buttons at the end after all tools.
|
|
314
|
+
* - `split`(default)—Renders the scroll buttons on both sides of the tools list.
|
|
315
|
+
*/
|
|
316
|
+
type ToolbarScrollButtonsPosition = 'start' | 'end' | 'split';
|
|
317
|
+
|
|
318
|
+
/**
|
|
319
|
+
* Represents the overflow settings for the ToolBar.
|
|
320
|
+
*/
|
|
321
|
+
interface ToolbarOverflowSettings {
|
|
322
|
+
/**
|
|
323
|
+
* Sets the ToolBar overflow mode.
|
|
324
|
+
* @default 'none'
|
|
325
|
+
*/
|
|
326
|
+
mode?: OverflowMode;
|
|
327
|
+
/**
|
|
328
|
+
* Sets the ToolBar scroll buttons visibility mode. Applies when the overflow mode is set to `'scroll'`.
|
|
329
|
+
*/
|
|
330
|
+
scrollButtons?: ToolbarScrollButtonsVisibility;
|
|
331
|
+
/**
|
|
332
|
+
* Sets the ToolBar scroll buttons position. Applies when the overflow mode is set to `'scroll'`.
|
|
333
|
+
*/
|
|
334
|
+
scrollButtonsPosition?: ToolbarScrollButtonsPosition;
|
|
335
|
+
/**
|
|
336
|
+
* Adds a custom CSS class or multiple classes to the span element of the previous scroll button. Applies when the overflow mode is set to `'scroll'`.
|
|
337
|
+
*
|
|
338
|
+
* Allows the usage of custom icons.
|
|
339
|
+
*/
|
|
340
|
+
prevButtonIcon?: string;
|
|
341
|
+
/**
|
|
342
|
+
* Adds a custom CSS class or multiple classes to the span element of the next scroll button. Applies when the overflow mode is set to `'scroll'`.
|
|
343
|
+
*
|
|
344
|
+
* Allows the usage of custom icons.
|
|
345
|
+
*/
|
|
346
|
+
nextButtonIcon?: string;
|
|
347
|
+
/**
|
|
348
|
+
* Sets an `SVGIcon` for the previous button icon. Accepts an [existing Kendo SVG icon](https://www.telerik.com/kendo-angular-ui/components/icons/svgicon/svgicon-list) or a custom one. Applies when the overflow mode is set to `'scroll'`.
|
|
349
|
+
*/
|
|
350
|
+
prevSVGButtonIcon?: SVGIcon;
|
|
351
|
+
/**
|
|
352
|
+
* Sets an `SVGIcon` for the next button icon. Accepts an [existing Kendo SVG icon](https://www.telerik.com/kendo-angular-ui/components/icons/svgicon/svgicon-list) or a custom one. Applies when the overflow mode is set to `'scroll'`.
|
|
353
|
+
*/
|
|
354
|
+
nextSVGButtonIcon?: SVGIcon;
|
|
355
|
+
}
|
|
356
|
+
|
|
357
|
+
/**
|
|
358
|
+
* @hidden
|
|
359
|
+
*/
|
|
360
|
+
type ScrollButtonActiveStateChange = {
|
|
361
|
+
buttonType: string;
|
|
362
|
+
active: boolean;
|
|
363
|
+
};
|
|
364
|
+
/**
|
|
365
|
+
* @hidden
|
|
366
|
+
*/
|
|
367
|
+
declare class ScrollService {
|
|
368
|
+
private ngZone;
|
|
369
|
+
private localization;
|
|
370
|
+
owner: ToolBarComponent;
|
|
371
|
+
position: number;
|
|
372
|
+
scrollButtonActiveStateChange: Subject<ScrollButtonActiveStateChange>;
|
|
373
|
+
get scrollElement(): HTMLElement;
|
|
374
|
+
get scrollContainerOverflowSize(): number;
|
|
375
|
+
get toolsOverflow(): boolean;
|
|
376
|
+
constructor(ngZone: NgZone, localization: LocalizationService);
|
|
377
|
+
toggleScrollButtonsState(): void;
|
|
378
|
+
onScroll(e: Event): void;
|
|
379
|
+
scrollTools(direction: string): void;
|
|
380
|
+
updateScrollPosition(element: HTMLElement): void;
|
|
381
|
+
calculateListPosition(direction: string, scrollSpeed: number): void;
|
|
382
|
+
private toggleButtonActiveState;
|
|
383
|
+
private isDisabled;
|
|
384
|
+
static ɵfac: i0.ɵɵFactoryDeclaration<ScrollService, never>;
|
|
385
|
+
static ɵprov: i0.ɵɵInjectableDeclaration<ScrollService>;
|
|
386
|
+
}
|
|
387
|
+
|
|
388
|
+
/**
|
|
389
|
+
* Sets the visibility for the ToolBar tool text or icon.
|
|
390
|
+
*
|
|
391
|
+
* The possible values are:
|
|
392
|
+
* - `always`—Always shows the text or icon regardless of the overflow mode.
|
|
393
|
+
* - `toolbar`—Shows in the main ToolBar and in the overflow element when using `section` overflow mode.
|
|
394
|
+
* - `menu`—Shows only in the overflow popup when using `menu` overflow mode.
|
|
395
|
+
* - `never`—Never renders the text or icon.
|
|
396
|
+
*
|
|
397
|
+
* @default 'always'
|
|
398
|
+
*/
|
|
399
|
+
type DisplayMode = 'always' | 'toolbar' | 'menu' | 'never';
|
|
400
|
+
|
|
401
|
+
/**
|
|
402
|
+
* Represents the [Kendo UI ToolBar component for Angular](https://www.telerik.com/kendo-angular-ui/components/toolbar).
|
|
403
|
+
*
|
|
404
|
+
* @example
|
|
405
|
+
* ```html
|
|
406
|
+
* <kendo-toolbar>
|
|
407
|
+
* <kendo-toolbar-button text="Button"></kendo-toolbar-button>
|
|
408
|
+
* </kendo-toolbar>
|
|
409
|
+
* ```
|
|
410
|
+
*
|
|
411
|
+
* @remarks
|
|
412
|
+
* Supported children components are:
|
|
413
|
+
* {@link ToolBarButtonComponent},
|
|
414
|
+
* {@link ToolBarButtonGroupComponent},
|
|
415
|
+
* {@link ToolBarDropDownButtonComponent},
|
|
416
|
+
* {@link ToolBarSplitButtonComponent},
|
|
417
|
+
* {@link ToolBarSeparatorComponent},
|
|
418
|
+
* {@link ToolBarSpacerComponent},
|
|
419
|
+
* {@link ToolbarCustomMessagesComponent},
|
|
420
|
+
* {@link ToolBarToolComponent},
|
|
421
|
+
* {@link EditorColorPickerComponent},
|
|
422
|
+
* {@link EditorFontFamilyComponent},
|
|
423
|
+
* {@link EditorFontSizeComponent},
|
|
424
|
+
* {@link EditorFormatComponent},
|
|
425
|
+
* {@link EditorInsertTableButtonComponent},
|
|
426
|
+
* {@link SelectAllToolbarToolComponent}.
|
|
427
|
+
*/
|
|
428
|
+
declare class ToolBarComponent {
|
|
429
|
+
localization: LocalizationService;
|
|
430
|
+
private popupService;
|
|
431
|
+
refreshService: RefreshService;
|
|
432
|
+
private navigationService;
|
|
433
|
+
element: ElementRef;
|
|
434
|
+
private zone;
|
|
435
|
+
private renderer;
|
|
436
|
+
private _cdr;
|
|
437
|
+
private toolsService;
|
|
438
|
+
private scrollService;
|
|
439
|
+
get overflowClass(): string;
|
|
440
|
+
/**
|
|
441
|
+
* Sets the overflow mode for the ToolBar.
|
|
442
|
+
* Use this property to control how tools render when their total size is greater than the ToolBar container.
|
|
443
|
+
* @default false
|
|
444
|
+
*/
|
|
445
|
+
set overflow(overflow: boolean | OverflowMode | ToolbarOverflowSettings);
|
|
446
|
+
get overflow(): boolean | OverflowMode | ToolbarOverflowSettings;
|
|
447
|
+
get showScrollButtons(): boolean;
|
|
448
|
+
/**
|
|
449
|
+
* @hidden
|
|
450
|
+
*/
|
|
451
|
+
set resizable(value: boolean);
|
|
452
|
+
get resizable(): boolean;
|
|
453
|
+
/**
|
|
454
|
+
* @hidden
|
|
455
|
+
*/
|
|
456
|
+
get hasScrollButtons(): {
|
|
457
|
+
visible: boolean;
|
|
458
|
+
position: ToolbarScrollButtonsPosition;
|
|
459
|
+
};
|
|
460
|
+
/**
|
|
461
|
+
* @hidden
|
|
462
|
+
*/
|
|
463
|
+
get isScrollMode(): boolean;
|
|
464
|
+
/**
|
|
465
|
+
* @hidden
|
|
466
|
+
*/
|
|
467
|
+
get showMenu(): boolean;
|
|
468
|
+
/**
|
|
469
|
+
* @hidden
|
|
470
|
+
*/
|
|
471
|
+
get overflowEnabled(): boolean;
|
|
472
|
+
/**
|
|
473
|
+
* Configures the popup for the ToolBar overflow button.
|
|
474
|
+
* Use this property to customize the overflow popup appearance and behavior
|
|
475
|
+
* ([see example](https://www.telerik.com/kendo-angular-ui/components/toolbar/responsive-toolbar#customizing-the-popup)).
|
|
476
|
+
*/
|
|
477
|
+
set popupSettings(settings: PopupSettings);
|
|
478
|
+
get popupSettings(): PopupSettings;
|
|
479
|
+
/**
|
|
480
|
+
* Sets the fill mode for the ToolBar.
|
|
481
|
+
* This property controls the background and border styles of the ToolBar
|
|
482
|
+
* ([see example](https://www.telerik.com/kendo-angular-ui/components/toolbar/appearance#fill-mode)). The default value is set by the Kendo theme.
|
|
483
|
+
*/
|
|
484
|
+
set fillMode(fillMode: ToolbarFillMode);
|
|
485
|
+
get fillMode(): ToolbarFillMode;
|
|
486
|
+
/**
|
|
487
|
+
* Sets the `tabindex` attribute of the ToolBar.
|
|
488
|
+
* Use this property to control the tab order of the ToolBar component.
|
|
489
|
+
*
|
|
490
|
+
* @default 0
|
|
491
|
+
*/
|
|
492
|
+
tabindex: number;
|
|
493
|
+
/**
|
|
494
|
+
* Sets the size for all ToolBar elements.
|
|
495
|
+
* Use this property to control the padding of the ToolBar elements. The default value is set by the Kendo theme.
|
|
496
|
+
*/
|
|
497
|
+
set size(size: ToolbarSize);
|
|
498
|
+
get size(): ToolbarSize;
|
|
499
|
+
/**
|
|
500
|
+
* @hidden
|
|
501
|
+
*/
|
|
502
|
+
set tabIndex(tabIndex: number);
|
|
503
|
+
get tabIndex(): number;
|
|
504
|
+
/**
|
|
505
|
+
* Sets the icon visibility for all tools in the ToolBar.
|
|
506
|
+
* You can override this property for each tool using the `showIcon` property of the tool.
|
|
507
|
+
* @default 'always'
|
|
508
|
+
*/
|
|
509
|
+
set showIcon(value: DisplayMode | boolean);
|
|
510
|
+
/**
|
|
511
|
+
* Sets the text visibility for all tools in the ToolBar.
|
|
512
|
+
* You can override this property for each tool using the `showText` property of the tool.
|
|
513
|
+
* @default 'always'
|
|
514
|
+
*/
|
|
515
|
+
set showText(value: DisplayMode | boolean);
|
|
516
|
+
/**
|
|
517
|
+
* Emits when the overflow popup of the ToolBar opens.
|
|
518
|
+
*/
|
|
519
|
+
open: EventEmitter<PreventableEvent>;
|
|
520
|
+
/**
|
|
521
|
+
* Emits when the overflow popup of the ToolBar closes.
|
|
522
|
+
*/
|
|
523
|
+
close: EventEmitter<PreventableEvent>;
|
|
524
|
+
allTools: QueryList<ToolBarToolComponent>;
|
|
525
|
+
overflowButton: ElementRef;
|
|
526
|
+
popupTemplate: TemplateRef<any>;
|
|
527
|
+
popupSectionTemplate: TemplateRef<any>;
|
|
528
|
+
scrollContainer: ElementRef;
|
|
529
|
+
resizeSensor: ResizeSensorComponent;
|
|
530
|
+
container: ViewContainerRef;
|
|
531
|
+
prevScrollButton: ElementRef;
|
|
532
|
+
nextScrollButton: ElementRef;
|
|
533
|
+
startButtonGroup: ElementRef;
|
|
534
|
+
endButtonGroup: ElementRef;
|
|
535
|
+
scrollSeparator: ElementRef;
|
|
536
|
+
popupRef: PopupRef;
|
|
537
|
+
direction: Direction;
|
|
538
|
+
get appendTo(): ViewContainerRef;
|
|
539
|
+
set popupOpen(open: boolean);
|
|
540
|
+
get popupOpen(): boolean;
|
|
541
|
+
/**
|
|
542
|
+
* @hidden
|
|
543
|
+
*/
|
|
544
|
+
prevButtonIcon: SVGIcon;
|
|
545
|
+
/**
|
|
546
|
+
* @hidden
|
|
547
|
+
*/
|
|
548
|
+
nextButtonIcon: SVGIcon;
|
|
549
|
+
/**
|
|
550
|
+
* @hidden
|
|
551
|
+
*/
|
|
552
|
+
propertyChange: EventEmitter<{
|
|
553
|
+
property: string;
|
|
554
|
+
value: any;
|
|
555
|
+
}>;
|
|
556
|
+
hostClass: boolean;
|
|
557
|
+
get scrollableClass(): boolean;
|
|
558
|
+
get sectionClass(): boolean;
|
|
559
|
+
private _overflow;
|
|
560
|
+
private _popupSettings;
|
|
561
|
+
private cachedOverflowAnchorWidth;
|
|
562
|
+
private _open;
|
|
563
|
+
private toolbarKeydownListener;
|
|
564
|
+
private overflowKeydownListener;
|
|
565
|
+
private sectionKeydownListener;
|
|
566
|
+
private cancelRenderedToolsSubscription$;
|
|
567
|
+
private cachedGap;
|
|
568
|
+
private _size;
|
|
569
|
+
private _fillMode;
|
|
570
|
+
private _showText;
|
|
571
|
+
private _showIcon;
|
|
572
|
+
private overflowButtonClickedTime;
|
|
573
|
+
private showAutoButtons;
|
|
574
|
+
private scrollButtonStateChangeSub;
|
|
575
|
+
private scrollContainerScrollSub;
|
|
576
|
+
/**
|
|
577
|
+
* @hidden
|
|
578
|
+
*/
|
|
579
|
+
get normalizedOverflow(): ToolbarOverflowSettings;
|
|
580
|
+
private subscriptions;
|
|
581
|
+
private popupSubs;
|
|
582
|
+
private focusedByPointer;
|
|
583
|
+
/**
|
|
584
|
+
* @hidden
|
|
585
|
+
*/
|
|
586
|
+
onFocus(ev: any): void;
|
|
587
|
+
/**
|
|
588
|
+
* @hidden
|
|
589
|
+
*/
|
|
590
|
+
onFocusOut(event: any): void;
|
|
591
|
+
role: string;
|
|
592
|
+
get getDir(): string;
|
|
593
|
+
get resizableClass(): boolean;
|
|
594
|
+
/**
|
|
595
|
+
* @hidden
|
|
596
|
+
*/
|
|
597
|
+
showLicenseWatermark: boolean;
|
|
598
|
+
/**
|
|
599
|
+
* @hidden
|
|
600
|
+
*/
|
|
601
|
+
licenseMessage?: LicenseMessage;
|
|
602
|
+
constructor(localization: LocalizationService, popupService: PopupService, refreshService: RefreshService, navigationService: NavigationService, element: ElementRef, zone: NgZone, renderer: Renderer2, _cdr: ChangeDetectorRef, toolsService: ToolbarToolsService, scrollService: ScrollService);
|
|
603
|
+
ngAfterContentInit(): void;
|
|
604
|
+
ngAfterViewInit(): void;
|
|
605
|
+
ngOnInit(): void;
|
|
606
|
+
ngOnChanges(changes: SimpleChanges): void;
|
|
607
|
+
ngOnDestroy(): void;
|
|
608
|
+
/**
|
|
609
|
+
* @hidden
|
|
610
|
+
*/
|
|
611
|
+
showOverflowSeparator: boolean;
|
|
612
|
+
/**
|
|
613
|
+
* @hidden
|
|
614
|
+
*/
|
|
615
|
+
get moreToolsTitle(): string;
|
|
616
|
+
/**
|
|
617
|
+
* @hidden
|
|
618
|
+
*/
|
|
619
|
+
get cdr(): ChangeDetectorRef;
|
|
620
|
+
/**
|
|
621
|
+
* @hidden
|
|
622
|
+
*/
|
|
623
|
+
get sectionSizeClass(): string;
|
|
624
|
+
/**
|
|
625
|
+
* @hidden
|
|
626
|
+
*/
|
|
627
|
+
getScrollButtonTitle(buttonType: string): string;
|
|
628
|
+
/**
|
|
629
|
+
* @hidden
|
|
630
|
+
*/
|
|
631
|
+
scrollTools(dir: string): void;
|
|
632
|
+
/**
|
|
633
|
+
* @hidden
|
|
634
|
+
*/
|
|
635
|
+
onRendererClick(data: RendererClickPayload): void;
|
|
636
|
+
/**
|
|
637
|
+
* @hidden
|
|
638
|
+
*/
|
|
639
|
+
overflowButtonIcon(iconType: string): any;
|
|
640
|
+
/**
|
|
641
|
+
* @hidden
|
|
642
|
+
*/
|
|
643
|
+
showPopup(): void;
|
|
644
|
+
/**
|
|
645
|
+
* Toggles the visibility of the overflow popup.
|
|
646
|
+
*/
|
|
647
|
+
toggle(popupOpen?: boolean): void;
|
|
648
|
+
/**
|
|
649
|
+
* @hidden
|
|
650
|
+
*/
|
|
651
|
+
onResize(): void;
|
|
652
|
+
/**
|
|
653
|
+
* @hidden
|
|
654
|
+
*/
|
|
655
|
+
onPopupOpen(): void;
|
|
656
|
+
/**
|
|
657
|
+
* @hidden
|
|
658
|
+
*/
|
|
659
|
+
onPopupClose(): void;
|
|
660
|
+
/**
|
|
661
|
+
* @hidden
|
|
662
|
+
*/
|
|
663
|
+
overflowBtnId: string;
|
|
664
|
+
/**
|
|
665
|
+
* @hidden
|
|
666
|
+
*/
|
|
667
|
+
popupId: string;
|
|
668
|
+
private displayAnchor;
|
|
669
|
+
private get popupWidth();
|
|
670
|
+
private get popupHeight();
|
|
671
|
+
private get overflowAnchorWidth();
|
|
672
|
+
private get gap();
|
|
673
|
+
private get childrenWidth();
|
|
674
|
+
get visibleTools(): ToolBarToolComponent[];
|
|
675
|
+
get overflowTools(): ToolBarToolComponent[];
|
|
676
|
+
private shrink;
|
|
677
|
+
private stretch;
|
|
678
|
+
private hideLastVisibleTool;
|
|
679
|
+
private showFirstHiddenTool;
|
|
680
|
+
private setPopupContentDimensions;
|
|
681
|
+
private destroyPopup;
|
|
682
|
+
private handleClasses;
|
|
683
|
+
private normalizePopupClasses;
|
|
684
|
+
private setScrollableOverlayClasses;
|
|
685
|
+
private handleScrollModeUpdates;
|
|
686
|
+
private removeSubscriptions;
|
|
687
|
+
private normalizeDisplayValue;
|
|
688
|
+
static ɵfac: i0.ɵɵFactoryDeclaration<ToolBarComponent, never>;
|
|
689
|
+
static ɵcmp: i0.ɵɵComponentDeclaration<ToolBarComponent, "kendo-toolbar", ["kendoToolBar"], { "overflow": { "alias": "overflow"; "required": false; }; "resizable": { "alias": "resizable"; "required": false; }; "popupSettings": { "alias": "popupSettings"; "required": false; }; "fillMode": { "alias": "fillMode"; "required": false; }; "tabindex": { "alias": "tabindex"; "required": false; }; "size": { "alias": "size"; "required": false; }; "tabIndex": { "alias": "tabIndex"; "required": false; }; "showIcon": { "alias": "showIcon"; "required": false; }; "showText": { "alias": "showText"; "required": false; }; }, { "open": "open"; "close": "close"; }, ["allTools"], never, true, never>;
|
|
690
|
+
}
|
|
691
|
+
|
|
692
|
+
/**
|
|
693
|
+
* @hidden
|
|
694
|
+
*/
|
|
695
|
+
interface ToolOptions {
|
|
696
|
+
text: string;
|
|
697
|
+
icon: string;
|
|
698
|
+
iconClass: string;
|
|
699
|
+
svgIcon: SVGIcon;
|
|
700
|
+
imageUrl: string;
|
|
701
|
+
}
|
|
702
|
+
|
|
703
|
+
/**
|
|
704
|
+
* Represents the [Kendo UI ToolBar Button tool for Angular](https://www.telerik.com/kendo-angular-ui/components/toolbar/control-types#buttons).
|
|
705
|
+
*
|
|
706
|
+
* Use this component to render a button inside the ToolBar.
|
|
707
|
+
*
|
|
708
|
+
* @example
|
|
709
|
+
* ```html
|
|
710
|
+
* <kendo-toolbar>
|
|
711
|
+
* <kendo-toolbar-button text="Button"></kendo-toolbar-button>
|
|
712
|
+
* </kendo-toolbar>
|
|
713
|
+
* ```
|
|
714
|
+
*
|
|
715
|
+
*/
|
|
716
|
+
declare class ToolBarButtonComponent extends ToolBarToolComponent {
|
|
717
|
+
element: ElementRef;
|
|
718
|
+
private zone;
|
|
719
|
+
host: ToolBarComponent;
|
|
720
|
+
/**
|
|
721
|
+
* Specifies the button text visibility.
|
|
722
|
+
* Accepts a `DisplayMode` value.
|
|
723
|
+
* @default 'always'
|
|
724
|
+
*/
|
|
725
|
+
set showText(value: DisplayMode);
|
|
726
|
+
get showText(): DisplayMode;
|
|
727
|
+
/**
|
|
728
|
+
* Specifies the button icon visibility.
|
|
729
|
+
* Accepts a `DisplayMode` value.
|
|
730
|
+
* @default 'always'
|
|
731
|
+
*/
|
|
732
|
+
set showIcon(value: DisplayMode);
|
|
733
|
+
get showIcon(): DisplayMode;
|
|
734
|
+
/**
|
|
735
|
+
* Specifies the text of the Button
|
|
736
|
+
* ([see example](https://www.telerik.com/kendo-angular-ui/components/toolbar/control-types#buttons)).
|
|
737
|
+
*/
|
|
738
|
+
set text(text: string);
|
|
739
|
+
get text(): string;
|
|
740
|
+
/**
|
|
741
|
+
* @hidden
|
|
742
|
+
*/
|
|
743
|
+
get size(): any;
|
|
744
|
+
/**
|
|
745
|
+
* Specifies custom inline CSS styles for the Button.
|
|
746
|
+
*/
|
|
747
|
+
style: {
|
|
748
|
+
[key: string]: string | number;
|
|
749
|
+
};
|
|
750
|
+
/**
|
|
751
|
+
* Specifies custom CSS class names to be added to the Button.
|
|
752
|
+
*/
|
|
753
|
+
className: string | Array<string> | {
|
|
754
|
+
[key: string]: boolean;
|
|
755
|
+
};
|
|
756
|
+
/**
|
|
757
|
+
* Specifies the `title` attribute of the Button.
|
|
758
|
+
*
|
|
759
|
+
* @remarks
|
|
760
|
+
* This property is related to accessibility.
|
|
761
|
+
*/
|
|
762
|
+
title: string;
|
|
763
|
+
/**
|
|
764
|
+
* Disables the Button when set to `true`
|
|
765
|
+
* ([see example](https://www.telerik.com/kendo-angular-ui/components/toolbar/control-types#buttons)).
|
|
766
|
+
*/
|
|
767
|
+
disabled: boolean;
|
|
768
|
+
/**
|
|
769
|
+
* Provides visual styling to indicate if the Button is active
|
|
770
|
+
* ([see example](https://www.telerik.com/kendo-angular-ui/components/toolbar/control-types#toggle-buttons)).
|
|
771
|
+
* For toggleable buttons, set this to `true`.
|
|
772
|
+
* @default false
|
|
773
|
+
*/
|
|
774
|
+
toggleable: boolean;
|
|
775
|
+
/**
|
|
776
|
+
* @hidden
|
|
777
|
+
*/
|
|
778
|
+
set look(look: 'default' | 'flat' | 'outline');
|
|
779
|
+
/**
|
|
780
|
+
* @hidden
|
|
781
|
+
*/
|
|
782
|
+
get togglable(): boolean;
|
|
783
|
+
set togglable(value: boolean);
|
|
784
|
+
/**
|
|
785
|
+
* Sets the selected state of the Button.
|
|
786
|
+
* Use with the `toggleable` property.
|
|
787
|
+
* @default false
|
|
788
|
+
*/
|
|
789
|
+
selected: boolean;
|
|
790
|
+
/**
|
|
791
|
+
* Specifies the background and border styles of the Button. The default value is set by the Kendo theme.
|
|
792
|
+
*/
|
|
793
|
+
fillMode: ButtonFillMode;
|
|
794
|
+
/**
|
|
795
|
+
* Specifies the border radius of the Button. The default value is set by the Kendo theme.
|
|
796
|
+
*/
|
|
797
|
+
rounded: ButtonRounded;
|
|
798
|
+
/**
|
|
799
|
+
* Specifies the predefined theme color of the Button. The default value is set by the Kendo theme.
|
|
800
|
+
*/
|
|
801
|
+
themeColor: ButtonThemeColor;
|
|
802
|
+
/**
|
|
803
|
+
* Defines the name for an existing icon in a Kendo UI theme
|
|
804
|
+
* ([see example](https://www.telerik.com/kendo-angular-ui/components/toolbar/control-types#buttons)).
|
|
805
|
+
* The icon is rendered inside the Button by a `span.k-icon` element.
|
|
806
|
+
*/
|
|
807
|
+
set icon(icon: string);
|
|
808
|
+
/**
|
|
809
|
+
* Defines a CSS class or multiple classes to be applied to a `span` element inside the Button.
|
|
810
|
+
* Allows the usage of custom icons.
|
|
811
|
+
*/
|
|
812
|
+
set iconClass(iconClass: string);
|
|
813
|
+
/**
|
|
814
|
+
* Defines an SVGIcon to be rendered within the button.
|
|
815
|
+
* Accepts either an [existing Kendo SVG icon](https://www.telerik.com/kendo-angular-ui/components/icons/svgicon/svgicon-list) or a custom one.
|
|
816
|
+
*/
|
|
817
|
+
set svgIcon(icon: SVGIcon);
|
|
818
|
+
/**
|
|
819
|
+
* Defines a URL for an image to be rendered inside the Button.
|
|
820
|
+
* The URL can be relative or absolute.
|
|
821
|
+
*/
|
|
822
|
+
set imageUrl(imageUrl: string);
|
|
823
|
+
/**
|
|
824
|
+
* Fires each time the Button is clicked.
|
|
825
|
+
*/
|
|
826
|
+
click: EventEmitter<any>;
|
|
827
|
+
/**
|
|
828
|
+
* Fires when the Button's `pointerdown` event is triggered.
|
|
829
|
+
*/
|
|
830
|
+
pointerdown: EventEmitter<any>;
|
|
831
|
+
/**
|
|
832
|
+
* Fires each time the selected state of a toggleable Button is changed.
|
|
833
|
+
* The event argument is the new selected state (Boolean).
|
|
834
|
+
*/
|
|
835
|
+
selectedChange: EventEmitter<any>;
|
|
836
|
+
toolbarOptions: ToolOptions;
|
|
837
|
+
overflowOptions: ToolOptions;
|
|
838
|
+
/**
|
|
839
|
+
* @hidden
|
|
840
|
+
*/
|
|
841
|
+
hasBadgeContainer: boolean;
|
|
842
|
+
/**
|
|
843
|
+
* @hidden
|
|
844
|
+
*/
|
|
845
|
+
showBadge: boolean;
|
|
846
|
+
toolbarButtonElement: ElementRef;
|
|
847
|
+
sectionButtonElement: ElementRef;
|
|
848
|
+
private overflowButtonElement;
|
|
849
|
+
private _showText;
|
|
850
|
+
private _showIcon;
|
|
851
|
+
private _text;
|
|
852
|
+
private propertyChangeSub;
|
|
853
|
+
constructor(element: ElementRef, zone: NgZone, host: ToolBarComponent);
|
|
854
|
+
ngOnInit(): void;
|
|
855
|
+
ngOnDestroy(): void;
|
|
856
|
+
ngOnChanges(changes: any): void;
|
|
857
|
+
/**
|
|
858
|
+
* @hidden
|
|
859
|
+
*/
|
|
860
|
+
onBlur(): void;
|
|
861
|
+
/**
|
|
862
|
+
* @hidden
|
|
863
|
+
*/
|
|
864
|
+
canFocus(): boolean;
|
|
865
|
+
/**
|
|
866
|
+
* @hidden
|
|
867
|
+
*/
|
|
868
|
+
focus(ev: Event): void;
|
|
869
|
+
/**
|
|
870
|
+
* @hidden
|
|
871
|
+
*/
|
|
872
|
+
handleKey(): boolean;
|
|
873
|
+
/**
|
|
874
|
+
* @hidden
|
|
875
|
+
*/
|
|
876
|
+
handleClick(ev: Event): void;
|
|
877
|
+
/**
|
|
878
|
+
* @hidden
|
|
879
|
+
*/
|
|
880
|
+
selectedChangeHandler(state: boolean): void;
|
|
881
|
+
/**
|
|
882
|
+
* @hidden
|
|
883
|
+
*/
|
|
884
|
+
getButton(): HTMLElement;
|
|
885
|
+
private setTextDisplayMode;
|
|
886
|
+
static ɵfac: i0.ɵɵFactoryDeclaration<ToolBarButtonComponent, never>;
|
|
887
|
+
static ɵcmp: i0.ɵɵComponentDeclaration<ToolBarButtonComponent, "kendo-toolbar-button", ["kendoToolBarButton"], { "showText": { "alias": "showText"; "required": false; }; "showIcon": { "alias": "showIcon"; "required": false; }; "text": { "alias": "text"; "required": false; }; "style": { "alias": "style"; "required": false; }; "className": { "alias": "className"; "required": false; }; "title": { "alias": "title"; "required": false; }; "disabled": { "alias": "disabled"; "required": false; }; "toggleable": { "alias": "toggleable"; "required": false; }; "look": { "alias": "look"; "required": false; }; "togglable": { "alias": "togglable"; "required": false; }; "selected": { "alias": "selected"; "required": false; }; "fillMode": { "alias": "fillMode"; "required": false; }; "rounded": { "alias": "rounded"; "required": false; }; "themeColor": { "alias": "themeColor"; "required": false; }; "icon": { "alias": "icon"; "required": false; }; "iconClass": { "alias": "iconClass"; "required": false; }; "svgIcon": { "alias": "svgIcon"; "required": false; }; "imageUrl": { "alias": "imageUrl"; "required": false; }; }, { "click": "click"; "pointerdown": "pointerdown"; "selectedChange": "selectedChange"; }, never, never, true, never>;
|
|
888
|
+
}
|
|
889
|
+
|
|
890
|
+
/**
|
|
891
|
+
* Тhe selection mode for the ToolBar ButtonGroup.
|
|
892
|
+
* For more information, see [`ToolBarButtonGroupComponent`](https://www.telerik.com/kendo-angular-ui/components/toolbar/api/toolbarbuttongroupcomponent).
|
|
893
|
+
*/
|
|
894
|
+
type ButtonGroupSelection = "single" | "multiple";
|
|
895
|
+
|
|
896
|
+
/**
|
|
897
|
+
* Represents the [Kendo UI Toolbar ButtonGroup for Angular](https://www.telerik.com/kendo-angular-ui/components/toolbar/control-types#button-groups).
|
|
898
|
+
*
|
|
899
|
+
* Use this component to group buttons in a ButtonGroup inside the ToolBar.
|
|
900
|
+
*
|
|
901
|
+
* @example
|
|
902
|
+
* ```html
|
|
903
|
+
* <kendo-toolbar>
|
|
904
|
+
* <kendo-toolbar-buttongroup>
|
|
905
|
+
* <kendo-toolbar-button text="Bold"></kendo-toolbar-button>
|
|
906
|
+
* <kendo-toolbar-button text="Underline"></kendo-toolbar-button>
|
|
907
|
+
* <kendo-toolbar-button text="Italic"></kendo-toolbar-button>
|
|
908
|
+
* </kendo-toolbar-buttongroup>
|
|
909
|
+
* </kendo-toolbar>
|
|
910
|
+
* ```
|
|
911
|
+
*
|
|
912
|
+
* @remarks
|
|
913
|
+
* Supported children components are: {@link ToolBarButtonComponent}
|
|
914
|
+
*/
|
|
915
|
+
declare class ToolBarButtonGroupComponent extends ToolBarToolComponent {
|
|
916
|
+
private localization;
|
|
917
|
+
private host;
|
|
918
|
+
/**
|
|
919
|
+
* When `true`, disables the whole group of buttons.
|
|
920
|
+
* If you set the `disabled` property of the group, it overrides the `disabled` property of individual buttons.
|
|
921
|
+
*/
|
|
922
|
+
disabled: boolean;
|
|
923
|
+
/**
|
|
924
|
+
* @hidden
|
|
925
|
+
*
|
|
926
|
+
* Used to set different fillmode in Spreadsheet and Toolbar to comply with referent rendering.
|
|
927
|
+
* @default undefined
|
|
928
|
+
*/
|
|
929
|
+
fillMode: 'solid' | 'flat';
|
|
930
|
+
/**
|
|
931
|
+
* Sets the selection mode of the ButtonGroup.
|
|
932
|
+
* @default 'multiple'
|
|
933
|
+
*/
|
|
934
|
+
selection: ButtonGroupSelection;
|
|
935
|
+
/**
|
|
936
|
+
* Sets the width of the ButtonGroup.
|
|
937
|
+
* When you set the width of the ButtonGroup, the buttons have the same width and resize to fill the group wrapper.
|
|
938
|
+
*/
|
|
939
|
+
width: string;
|
|
940
|
+
/**
|
|
941
|
+
* @hidden
|
|
942
|
+
*/
|
|
943
|
+
set look(look: 'default' | 'flat' | 'outline');
|
|
944
|
+
private toolbarButtonGroup;
|
|
945
|
+
private sectionButtonGroup;
|
|
946
|
+
overflowListItems: QueryList<ElementRef>;
|
|
947
|
+
buttonComponents: QueryList<ToolBarButtonComponent>;
|
|
948
|
+
private get buttonElements();
|
|
949
|
+
private focusedIndex;
|
|
950
|
+
private getNextKey;
|
|
951
|
+
private getPrevKey;
|
|
952
|
+
constructor(localization: LocalizationService, host: ToolBarComponent);
|
|
953
|
+
/**
|
|
954
|
+
* @hidden
|
|
955
|
+
*/
|
|
956
|
+
onFocus(): void;
|
|
957
|
+
/**
|
|
958
|
+
* @hidden
|
|
959
|
+
*/
|
|
960
|
+
onNavigate(ev: PreventableEvent$1): void;
|
|
961
|
+
/**
|
|
962
|
+
* @hidden
|
|
963
|
+
*/
|
|
964
|
+
selectedChangeHandler(state: boolean, button: ToolBarButtonComponent): void;
|
|
965
|
+
/**
|
|
966
|
+
* @hidden
|
|
967
|
+
*/
|
|
968
|
+
overflowSelectedChangeHandler(button: ToolBarButtonComponent): void;
|
|
969
|
+
/**
|
|
970
|
+
* @hidden
|
|
971
|
+
*/
|
|
972
|
+
onButtonClick(ev: MouseEvent): void;
|
|
973
|
+
/**
|
|
974
|
+
* @hidden
|
|
975
|
+
*/
|
|
976
|
+
canFocus(): boolean;
|
|
977
|
+
/**
|
|
978
|
+
* @hidden
|
|
979
|
+
*/
|
|
980
|
+
focus(ev?: Partial<Event>): void;
|
|
981
|
+
/**
|
|
982
|
+
* @hidden
|
|
983
|
+
*/
|
|
984
|
+
handleKey(ev: any): boolean;
|
|
985
|
+
/**
|
|
986
|
+
* @hidden
|
|
987
|
+
*/
|
|
988
|
+
handleClick(ev: any, button: ToolBarButtonComponent): void;
|
|
989
|
+
/**
|
|
990
|
+
* @hidden
|
|
991
|
+
*/
|
|
992
|
+
getIconClasses(button: any): any;
|
|
993
|
+
/**
|
|
994
|
+
* @hidden
|
|
995
|
+
*/
|
|
996
|
+
get size(): any;
|
|
997
|
+
private focusButton;
|
|
998
|
+
static ɵfac: i0.ɵɵFactoryDeclaration<ToolBarButtonGroupComponent, never>;
|
|
999
|
+
static ɵcmp: i0.ɵɵComponentDeclaration<ToolBarButtonGroupComponent, "kendo-toolbar-buttongroup", ["kendoToolBarButtonGroup"], { "disabled": { "alias": "disabled"; "required": false; }; "fillMode": { "alias": "fillMode"; "required": false; }; "selection": { "alias": "selection"; "required": false; }; "width": { "alias": "width"; "required": false; }; "look": { "alias": "look"; "required": false; }; }, {}, ["buttonComponents"], never, true, never>;
|
|
1000
|
+
}
|
|
1001
|
+
|
|
1002
|
+
/**
|
|
1003
|
+
* Represents the [Kendo UI ToolBar DropDownButton for Angular](https://www.telerik.com/kendo-angular-ui/components/toolbar/control-types#drop-down-buttons).
|
|
1004
|
+
*
|
|
1005
|
+
* Use this component to add a button that opens a popup with a list of items in the ToolBar.
|
|
1006
|
+
*
|
|
1007
|
+
* @example
|
|
1008
|
+
* ```html
|
|
1009
|
+
* <kendo-toolbar>
|
|
1010
|
+
* <kendo-toolbar-dropdownbutton text="Paste Variations" [data]="data">
|
|
1011
|
+
* </kendo-toolbar-dropdownbutton>
|
|
1012
|
+
* </kendo-toolbar>
|
|
1013
|
+
* ```
|
|
1014
|
+
*
|
|
1015
|
+
*/
|
|
1016
|
+
declare class ToolBarDropDownButtonComponent extends ToolBarToolComponent implements OnInit {
|
|
1017
|
+
private zone;
|
|
1018
|
+
private renderer;
|
|
1019
|
+
private host;
|
|
1020
|
+
/**
|
|
1021
|
+
* Shows the default arrow icon or lets you provide a custom one.
|
|
1022
|
+
* @default false
|
|
1023
|
+
*/
|
|
1024
|
+
arrowIcon: boolean | ArrowIconSettings;
|
|
1025
|
+
/**
|
|
1026
|
+
* Sets the `title` attribute of the underlying button element.
|
|
1027
|
+
* @default ''
|
|
1028
|
+
*
|
|
1029
|
+
* @remarks
|
|
1030
|
+
* This property is related to accessibility.
|
|
1031
|
+
*/
|
|
1032
|
+
title: string;
|
|
1033
|
+
/**
|
|
1034
|
+
* Controls the button text visibility.
|
|
1035
|
+
* @default 'always'
|
|
1036
|
+
*/
|
|
1037
|
+
set showText(value: DisplayMode);
|
|
1038
|
+
get showText(): DisplayMode;
|
|
1039
|
+
/**
|
|
1040
|
+
* Controls the button icon visibility.
|
|
1041
|
+
* @default 'always'
|
|
1042
|
+
*/
|
|
1043
|
+
set showIcon(value: DisplayMode);
|
|
1044
|
+
get showIcon(): DisplayMode;
|
|
1045
|
+
/**
|
|
1046
|
+
* Sets the text of the DropDownButton
|
|
1047
|
+
* ([see example](https://www.telerik.com/kendo-angular-ui/components/toolbar/control-types#drop-down-buttons)).
|
|
1048
|
+
*/
|
|
1049
|
+
set text(text: string);
|
|
1050
|
+
get text(): string;
|
|
1051
|
+
/**
|
|
1052
|
+
* Sets the icon rendered next to the button text.
|
|
1053
|
+
*/
|
|
1054
|
+
set icon(icon: string);
|
|
1055
|
+
/**
|
|
1056
|
+
* Sets the `SVGIcon` rendered in the button.
|
|
1057
|
+
* Accepts an [existing Kendo SVG icon](https://www.telerik.com/kendo-angular-ui/components/icons/svgicon/svgicon-list) or a custom one.
|
|
1058
|
+
*/
|
|
1059
|
+
set svgIcon(icon: SVGIcon);
|
|
1060
|
+
/**
|
|
1061
|
+
* Sets a custom CSS class icon rendered next to the button text.
|
|
1062
|
+
*/
|
|
1063
|
+
set iconClass(iconClass: string);
|
|
1064
|
+
/**
|
|
1065
|
+
* Sets a URL for the image displayed next to the button text.
|
|
1066
|
+
*/
|
|
1067
|
+
set imageUrl(imageUrl: string);
|
|
1068
|
+
/**
|
|
1069
|
+
* Configures the popup of the DropDownButton.
|
|
1070
|
+
* Accepts a `PopupSettings` object that allows you to customize the popup behavior and appearance.
|
|
1071
|
+
*/
|
|
1072
|
+
set popupSettings(settings: PopupSettings);
|
|
1073
|
+
get popupSettings(): PopupSettings;
|
|
1074
|
+
/**
|
|
1075
|
+
* @hidden
|
|
1076
|
+
*/
|
|
1077
|
+
set look(look: 'default' | 'flat' | 'outline');
|
|
1078
|
+
/**
|
|
1079
|
+
* @hidden
|
|
1080
|
+
*/
|
|
1081
|
+
set primary(primary: boolean);
|
|
1082
|
+
/**
|
|
1083
|
+
* Sets the fill mode for the button.
|
|
1084
|
+
* The fill mode represents the background and border styles. The default value is set by the Kendo theme.
|
|
1085
|
+
*/
|
|
1086
|
+
fillMode: ButtonFillMode;
|
|
1087
|
+
/**
|
|
1088
|
+
* Sets the predefined theme color for the button.
|
|
1089
|
+
* The theme color applies to the background, border, and text
|
|
1090
|
+
* ([see example](https://www.telerik.com/kendo-angular-ui/components/buttons/api/dropdownbuttoncomponent#themecolor)). The default value is set by the Kendo theme.
|
|
1091
|
+
*/
|
|
1092
|
+
themeColor: ButtonThemeColor;
|
|
1093
|
+
/**
|
|
1094
|
+
* Sets the CSS classes for the main button.
|
|
1095
|
+
* Accepts values supported by [`ngClass`](link:site.data.urls.angular['ngclassapi']).
|
|
1096
|
+
*/
|
|
1097
|
+
buttonClass: string;
|
|
1098
|
+
/**
|
|
1099
|
+
* Sets the data item field that repesents the item text.
|
|
1100
|
+
* If the data contains only primitive values, do not set this property.
|
|
1101
|
+
*/
|
|
1102
|
+
textField: string;
|
|
1103
|
+
/**
|
|
1104
|
+
* When `true`, disables the DropDownButton.
|
|
1105
|
+
*/
|
|
1106
|
+
disabled: boolean;
|
|
1107
|
+
/**
|
|
1108
|
+
* Sets the data of the DropDownButton
|
|
1109
|
+
* ([see example](https://www.telerik.com/kendo-angular-ui/components/toolbar/control-types#drop-down-buttons)).
|
|
1110
|
+
*
|
|
1111
|
+
* > Provide the data as an array-like list.
|
|
1112
|
+
*/
|
|
1113
|
+
set data(data: any[]);
|
|
1114
|
+
get data(): any[];
|
|
1115
|
+
/**
|
|
1116
|
+
* Fires each time the user clicks a DropDownButton item.
|
|
1117
|
+
* The event data contains the clicked item's data.
|
|
1118
|
+
*/
|
|
1119
|
+
itemClick: EventEmitter<any>;
|
|
1120
|
+
/**
|
|
1121
|
+
* Fires when the popup is about to open.
|
|
1122
|
+
* This event is preventable. If you cancel the event, the popup stays closed.
|
|
1123
|
+
*/
|
|
1124
|
+
open: EventEmitter<PreventableEvent$1>;
|
|
1125
|
+
/**
|
|
1126
|
+
* Fires when the popup is about to close.
|
|
1127
|
+
* This event is preventable. If you cancel the event, the popup stays open.
|
|
1128
|
+
*/
|
|
1129
|
+
close: EventEmitter<PreventableEvent$1>;
|
|
1130
|
+
dropdownButton: ElementRef;
|
|
1131
|
+
toolbarDropDownButton: DropDownButtonComponent;
|
|
1132
|
+
sectionDropDownButton: DropDownButtonComponent;
|
|
1133
|
+
overflowListItems: QueryList<ElementRef>;
|
|
1134
|
+
toolbarOptions: ToolOptions;
|
|
1135
|
+
overflowOptions: ToolOptions;
|
|
1136
|
+
private get overflowButtons();
|
|
1137
|
+
private _data;
|
|
1138
|
+
private _popupSettings;
|
|
1139
|
+
private focusedIndex;
|
|
1140
|
+
private _showText;
|
|
1141
|
+
private _showIcon;
|
|
1142
|
+
private _text;
|
|
1143
|
+
private propertyChangeSub;
|
|
1144
|
+
private getNextKey;
|
|
1145
|
+
private getPrevKey;
|
|
1146
|
+
constructor(zone: NgZone, renderer: Renderer2, host: ToolBarComponent);
|
|
1147
|
+
ngOnInit(): void;
|
|
1148
|
+
ngOnDestroy(): void;
|
|
1149
|
+
ngAfterViewInit(): void;
|
|
1150
|
+
/**
|
|
1151
|
+
* @hidden
|
|
1152
|
+
*/
|
|
1153
|
+
onButtonListClick(ev: MouseEvent): void;
|
|
1154
|
+
/**
|
|
1155
|
+
* @hidden
|
|
1156
|
+
*/
|
|
1157
|
+
get size(): any;
|
|
1158
|
+
/**
|
|
1159
|
+
* @hidden
|
|
1160
|
+
*/
|
|
1161
|
+
canFocus(): boolean;
|
|
1162
|
+
/**
|
|
1163
|
+
* @hidden
|
|
1164
|
+
*/
|
|
1165
|
+
focus(ev?: Partial<Event>): void;
|
|
1166
|
+
/**
|
|
1167
|
+
* @hidden
|
|
1168
|
+
*/
|
|
1169
|
+
handleKey(ev: any): boolean;
|
|
1170
|
+
/**
|
|
1171
|
+
* @hidden
|
|
1172
|
+
*/
|
|
1173
|
+
getText(dataItem: any): any;
|
|
1174
|
+
/**
|
|
1175
|
+
* @hidden
|
|
1176
|
+
*/
|
|
1177
|
+
handleClick(ev: any, item: any, index: number): void;
|
|
1178
|
+
private focusButton;
|
|
1179
|
+
private setTextDisplayMode;
|
|
1180
|
+
static ɵfac: i0.ɵɵFactoryDeclaration<ToolBarDropDownButtonComponent, never>;
|
|
1181
|
+
static ɵcmp: i0.ɵɵComponentDeclaration<ToolBarDropDownButtonComponent, "kendo-toolbar-dropdownbutton", ["kendoToolBarDropDownButton"], { "arrowIcon": { "alias": "arrowIcon"; "required": false; }; "title": { "alias": "title"; "required": false; }; "showText": { "alias": "showText"; "required": false; }; "showIcon": { "alias": "showIcon"; "required": false; }; "text": { "alias": "text"; "required": false; }; "icon": { "alias": "icon"; "required": false; }; "svgIcon": { "alias": "svgIcon"; "required": false; }; "iconClass": { "alias": "iconClass"; "required": false; }; "imageUrl": { "alias": "imageUrl"; "required": false; }; "popupSettings": { "alias": "popupSettings"; "required": false; }; "look": { "alias": "look"; "required": false; }; "primary": { "alias": "primary"; "required": false; }; "fillMode": { "alias": "fillMode"; "required": false; }; "themeColor": { "alias": "themeColor"; "required": false; }; "buttonClass": { "alias": "buttonClass"; "required": false; }; "textField": { "alias": "textField"; "required": false; }; "disabled": { "alias": "disabled"; "required": false; }; "data": { "alias": "data"; "required": false; }; }, { "itemClick": "itemClick"; "open": "open"; "close": "close"; }, never, never, true, never>;
|
|
1182
|
+
}
|
|
1183
|
+
|
|
1184
|
+
/**
|
|
1185
|
+
* Represents the [Kendo UI ToolBar SplitButton for Angular](https://www.telerik.com/kendo-angular-ui/components/toolbar/control-types#split-buttons).
|
|
1186
|
+
*
|
|
1187
|
+
* Use the ToolBar SplitButton to create a split button with a main button and a drop-down list of actions in the ToolBar.
|
|
1188
|
+
*
|
|
1189
|
+
* @example
|
|
1190
|
+
* ```html
|
|
1191
|
+
* <kendo-toolbar>
|
|
1192
|
+
* <kendo-toolbar-splitbutton text="Paste" [data]="data">
|
|
1193
|
+
* </kendo-toolbar-splitbutton>
|
|
1194
|
+
* </kendo-toolbar>
|
|
1195
|
+
* ```
|
|
1196
|
+
*/
|
|
1197
|
+
declare class ToolBarSplitButtonComponent extends ToolBarToolComponent implements OnInit {
|
|
1198
|
+
private host;
|
|
1199
|
+
/**
|
|
1200
|
+
* Controls the button text visibility.
|
|
1201
|
+
* @default 'always'
|
|
1202
|
+
*/
|
|
1203
|
+
set showText(value: DisplayMode);
|
|
1204
|
+
get showText(): DisplayMode;
|
|
1205
|
+
/**
|
|
1206
|
+
* Controls the button icon visibility.
|
|
1207
|
+
* @default 'always'
|
|
1208
|
+
*/
|
|
1209
|
+
set showIcon(value: DisplayMode);
|
|
1210
|
+
get showIcon(): DisplayMode;
|
|
1211
|
+
/**
|
|
1212
|
+
* Sets the text of the SplitButton ([see example](https://www.telerik.com/kendo-angular-ui/components/toolbar/control-types#split-buttons)).
|
|
1213
|
+
*/
|
|
1214
|
+
set text(text: string);
|
|
1215
|
+
get text(): string;
|
|
1216
|
+
/**
|
|
1217
|
+
* Sets the icon rendered next to the button text
|
|
1218
|
+
* ([see example](https://www.telerik.com/kendo-angular-ui/components/toolbar/control-types#split-buttons)).
|
|
1219
|
+
*/
|
|
1220
|
+
set icon(icon: string);
|
|
1221
|
+
/**
|
|
1222
|
+
* Sets the `SVGIcon` rendered in the main button.
|
|
1223
|
+
* Accepts an [existing Kendo SVG icon](https://www.telerik.com/kendo-angular-ui/components/icons/svgicon/svgicon-list) or a custom one.
|
|
1224
|
+
*/
|
|
1225
|
+
set svgIcon(icon: SVGIcon);
|
|
1226
|
+
/**
|
|
1227
|
+
* Sets a custom CSS class icon rendered next to the button text.
|
|
1228
|
+
*/
|
|
1229
|
+
set iconClass(iconClass: string);
|
|
1230
|
+
/**
|
|
1231
|
+
* Sets a URL for the image displayed next to the button text.
|
|
1232
|
+
*/
|
|
1233
|
+
set imageUrl(imageUrl: string);
|
|
1234
|
+
/**
|
|
1235
|
+
* When `true`, disables a SplitButton item.
|
|
1236
|
+
*/
|
|
1237
|
+
disabled: boolean;
|
|
1238
|
+
/**
|
|
1239
|
+
* Configures the popup of the SplitButton.
|
|
1240
|
+
* Accepts a `PopupSettings` object that allows you to customize the popup behavior and appearance.
|
|
1241
|
+
|
|
1242
|
+
*/
|
|
1243
|
+
set popupSettings(value: PopupSettings);
|
|
1244
|
+
get popupSettings(): PopupSettings;
|
|
1245
|
+
/**
|
|
1246
|
+
* Sets the fill mode for the button.
|
|
1247
|
+
* The fill mode represents the background and border styles. The default value is set by the Kendo theme.
|
|
1248
|
+
*/
|
|
1249
|
+
fillMode: ButtonFillMode;
|
|
1250
|
+
/**
|
|
1251
|
+
* Sets the predefined theme color for the button.
|
|
1252
|
+
* The theme color applies to the background, border, and text. The default value is set by the Kendo theme.
|
|
1253
|
+
*/
|
|
1254
|
+
themeColor: ButtonThemeColor;
|
|
1255
|
+
/**
|
|
1256
|
+
* @hidden
|
|
1257
|
+
*/
|
|
1258
|
+
set look(look: 'default' | 'flat' | 'outline');
|
|
1259
|
+
/**
|
|
1260
|
+
* Sets the CSS classes for the main button.
|
|
1261
|
+
* Accepts values supported by [`ngClass`](link:site.data.urls.angular['ngclassapi']).
|
|
1262
|
+
*/
|
|
1263
|
+
buttonClass: string;
|
|
1264
|
+
/**
|
|
1265
|
+
* Sets the CSS classes for the arrow button that opens the popup.
|
|
1266
|
+
* Accepts values supported by [`ngClass`](link:site.data.urls.angular['ngclassapi']).
|
|
1267
|
+
*/
|
|
1268
|
+
arrowButtonClass: any;
|
|
1269
|
+
/**
|
|
1270
|
+
* Sets the name of the [font icon](https://www.telerik.com/kendo-angular-ui/components/styling/icons#icons-list) for the arrow button.
|
|
1271
|
+
*/
|
|
1272
|
+
arrowButtonIcon: string;
|
|
1273
|
+
/**
|
|
1274
|
+
* Sets the [`SVGIcon`](https://www.telerik.com/kendo-angular-ui/components/icons/api/svgicon) for the arrow button.
|
|
1275
|
+
*/
|
|
1276
|
+
arrowButtonSvgIcon: SVGIcon;
|
|
1277
|
+
/**
|
|
1278
|
+
* Sets the text field for the button-list popup.
|
|
1279
|
+
* @default 'text'
|
|
1280
|
+
*/
|
|
1281
|
+
textField: string;
|
|
1282
|
+
/**
|
|
1283
|
+
* Sets the data of the SplitButton ([see example](https://www.telerik.com/kendo-angular-ui/components/toolbar/control-types#split-buttons)).
|
|
1284
|
+
*
|
|
1285
|
+
* > Provide the data as an array-like list.
|
|
1286
|
+
*/
|
|
1287
|
+
set data(data: any[]);
|
|
1288
|
+
get data(): any[];
|
|
1289
|
+
/**
|
|
1290
|
+
* Fires when the user clicks the main button.
|
|
1291
|
+
*/
|
|
1292
|
+
buttonClick: EventEmitter<any>;
|
|
1293
|
+
/**
|
|
1294
|
+
* Fires when the user clicks a drop-down list item.
|
|
1295
|
+
* The event data contains the clicked item's data.
|
|
1296
|
+
*/
|
|
1297
|
+
itemClick: EventEmitter<any>;
|
|
1298
|
+
/**
|
|
1299
|
+
* Fires when the popup is about to open.
|
|
1300
|
+
* This event is preventable. If you cancel the event, the popup stays closed.
|
|
1301
|
+
*/
|
|
1302
|
+
open: EventEmitter<PreventableEvent$1>;
|
|
1303
|
+
/**
|
|
1304
|
+
* Fires when the popup is about to close.
|
|
1305
|
+
* This event is preventable. If you cancel the event, the popup stays open.
|
|
1306
|
+
*/
|
|
1307
|
+
close: EventEmitter<PreventableEvent$1>;
|
|
1308
|
+
toolbarOptions: ToolOptions;
|
|
1309
|
+
overflowOptions: ToolOptions;
|
|
1310
|
+
ngOnInit(): void;
|
|
1311
|
+
ngOnDestroy(): void;
|
|
1312
|
+
private get overflowButtons();
|
|
1313
|
+
private _data;
|
|
1314
|
+
private _popupSettings;
|
|
1315
|
+
private focusedIndex;
|
|
1316
|
+
private _showText;
|
|
1317
|
+
private _showIcon;
|
|
1318
|
+
private _text;
|
|
1319
|
+
private propertyChangeSub;
|
|
1320
|
+
private getNextKey;
|
|
1321
|
+
private getPrevKey;
|
|
1322
|
+
private toolbarSplitButton;
|
|
1323
|
+
private sectionSplitButton;
|
|
1324
|
+
private overflowMainButton;
|
|
1325
|
+
overflowListItems: QueryList<ElementRef>;
|
|
1326
|
+
constructor(host: ToolBarComponent);
|
|
1327
|
+
/**
|
|
1328
|
+
* @hidden
|
|
1329
|
+
*/
|
|
1330
|
+
onButtonListClick(ev: MouseEvent): void;
|
|
1331
|
+
/**
|
|
1332
|
+
* @hidden
|
|
1333
|
+
*/
|
|
1334
|
+
onMainButtonClick(ev: MouseEvent): void;
|
|
1335
|
+
/**
|
|
1336
|
+
* @hidden
|
|
1337
|
+
*/
|
|
1338
|
+
canFocus(): boolean;
|
|
1339
|
+
/**
|
|
1340
|
+
* @hidden
|
|
1341
|
+
*/
|
|
1342
|
+
get size(): any;
|
|
1343
|
+
/**
|
|
1344
|
+
* @hidden
|
|
1345
|
+
*/
|
|
1346
|
+
focus(ev?: Partial<Event>): void;
|
|
1347
|
+
/**
|
|
1348
|
+
* @hidden
|
|
1349
|
+
*/
|
|
1350
|
+
handleKey(ev: any): boolean;
|
|
1351
|
+
/**
|
|
1352
|
+
* @hidden
|
|
1353
|
+
*/
|
|
1354
|
+
getText(dataItem: any): any;
|
|
1355
|
+
/**
|
|
1356
|
+
* @hidden
|
|
1357
|
+
*/
|
|
1358
|
+
handleClick(ev: any, item: any, index: number): void;
|
|
1359
|
+
private focusButton;
|
|
1360
|
+
private setTextDisplayMode;
|
|
1361
|
+
static ɵfac: i0.ɵɵFactoryDeclaration<ToolBarSplitButtonComponent, never>;
|
|
1362
|
+
static ɵcmp: i0.ɵɵComponentDeclaration<ToolBarSplitButtonComponent, "kendo-toolbar-splitbutton", ["kendoToolBarSplitButton"], { "showText": { "alias": "showText"; "required": false; }; "showIcon": { "alias": "showIcon"; "required": false; }; "text": { "alias": "text"; "required": false; }; "icon": { "alias": "icon"; "required": false; }; "svgIcon": { "alias": "svgIcon"; "required": false; }; "iconClass": { "alias": "iconClass"; "required": false; }; "imageUrl": { "alias": "imageUrl"; "required": false; }; "disabled": { "alias": "disabled"; "required": false; }; "popupSettings": { "alias": "popupSettings"; "required": false; }; "fillMode": { "alias": "fillMode"; "required": false; }; "themeColor": { "alias": "themeColor"; "required": false; }; "look": { "alias": "look"; "required": false; }; "buttonClass": { "alias": "buttonClass"; "required": false; }; "arrowButtonClass": { "alias": "arrowButtonClass"; "required": false; }; "arrowButtonIcon": { "alias": "arrowButtonIcon"; "required": false; }; "arrowButtonSvgIcon": { "alias": "arrowButtonSvgIcon"; "required": false; }; "textField": { "alias": "textField"; "required": false; }; "data": { "alias": "data"; "required": false; }; }, { "buttonClick": "buttonClick"; "itemClick": "itemClick"; "open": "open"; "close": "close"; }, never, never, true, never>;
|
|
1363
|
+
}
|
|
1364
|
+
|
|
1365
|
+
/**
|
|
1366
|
+
* Represents the [Kendo UI ToolBar Separator for Angular](https://www.telerik.com/kendo-angular-ui/components/toolbar/control-types#separators).
|
|
1367
|
+
*
|
|
1368
|
+
* Use this component to add a visual separator between ToolBar tools.
|
|
1369
|
+
*
|
|
1370
|
+
* @example
|
|
1371
|
+
* ```html
|
|
1372
|
+
* <kendo-toolbar>
|
|
1373
|
+
* <kendo-toolbar-button text="Button 1"></kendo-toolbar-button>
|
|
1374
|
+
* <kendo-toolbar-separator></kendo-toolbar-separator>
|
|
1375
|
+
* <kendo-toolbar-button text="Button 2"></kendo-toolbar-button>
|
|
1376
|
+
* </kendo-toolbar>
|
|
1377
|
+
* ```
|
|
1378
|
+
*/
|
|
1379
|
+
declare class ToolBarSeparatorComponent extends ToolBarToolComponent implements AfterViewInit {
|
|
1380
|
+
separator: ElementRef;
|
|
1381
|
+
constructor();
|
|
1382
|
+
/**
|
|
1383
|
+
* @hidden
|
|
1384
|
+
*/
|
|
1385
|
+
canFocus(): boolean;
|
|
1386
|
+
/**
|
|
1387
|
+
* @hidden
|
|
1388
|
+
*/
|
|
1389
|
+
focus(): void;
|
|
1390
|
+
/**
|
|
1391
|
+
* @hidden
|
|
1392
|
+
*/
|
|
1393
|
+
handleKey(): boolean;
|
|
1394
|
+
ngAfterViewInit(): void;
|
|
1395
|
+
static ɵfac: i0.ɵɵFactoryDeclaration<ToolBarSeparatorComponent, never>;
|
|
1396
|
+
static ɵcmp: i0.ɵɵComponentDeclaration<ToolBarSeparatorComponent, "kendo-toolbar-separator", ["kendoToolBarSeparator"], {}, {}, never, never, true, never>;
|
|
1397
|
+
}
|
|
1398
|
+
|
|
1399
|
+
/**
|
|
1400
|
+
* Represents the [Kendo UI ToolBar Spacer for Angular](https://www.telerik.com/kendo-angular-ui/components/toolbar/control-types#separators).
|
|
1401
|
+
*
|
|
1402
|
+
* Use the ToolBar Spacer to add flexible space between ToolBar tools.
|
|
1403
|
+
*
|
|
1404
|
+
* @example
|
|
1405
|
+
* ```html
|
|
1406
|
+
* <kendo-toolbar>
|
|
1407
|
+
* <kendo-toolbar-button text="Button 1"></kendo-toolbar-button>
|
|
1408
|
+
* <kendo-toolbar-spacer></kendo-toolbar-spacer>
|
|
1409
|
+
* <kendo-toolbar-button text="Button 2"></kendo-toolbar-button>
|
|
1410
|
+
* </kendo-toolbar>
|
|
1411
|
+
* ```
|
|
1412
|
+
*/
|
|
1413
|
+
declare class ToolBarSpacerComponent extends ToolBarToolComponent implements AfterViewInit {
|
|
1414
|
+
/**
|
|
1415
|
+
* @hidden
|
|
1416
|
+
*/
|
|
1417
|
+
readonly __isSpacer = true;
|
|
1418
|
+
constructor();
|
|
1419
|
+
/**
|
|
1420
|
+
* @hidden
|
|
1421
|
+
*/
|
|
1422
|
+
canFocus(): boolean;
|
|
1423
|
+
/**
|
|
1424
|
+
* @hidden
|
|
1425
|
+
*/
|
|
1426
|
+
focus(): void;
|
|
1427
|
+
/**
|
|
1428
|
+
* @hidden
|
|
1429
|
+
*/
|
|
1430
|
+
handleKey(): boolean;
|
|
1431
|
+
ngAfterViewInit(): void;
|
|
1432
|
+
static ɵfac: i0.ɵɵFactoryDeclaration<ToolBarSpacerComponent, never>;
|
|
1433
|
+
static ɵcmp: i0.ɵɵComponentDeclaration<ToolBarSpacerComponent, "kendo-toolbar-spacer", ["kendoToolBarSpacer"], {}, {}, never, never, true, never>;
|
|
1434
|
+
}
|
|
1435
|
+
|
|
1436
|
+
/**
|
|
1437
|
+
* @hidden
|
|
1438
|
+
*/
|
|
1439
|
+
declare class ToolbarMessages extends ComponentMessages {
|
|
1440
|
+
/**
|
|
1441
|
+
* Sets the title of the **More Tools** button in a responsive ToolBar.
|
|
1442
|
+
*/
|
|
1443
|
+
moreToolsTitle: string;
|
|
1444
|
+
/**
|
|
1445
|
+
* Sets the title for the **Previous Tool** button when the ToolBar is scrollable.
|
|
1446
|
+
*/
|
|
1447
|
+
previousToolButton: string;
|
|
1448
|
+
/**
|
|
1449
|
+
* Sets the title for the **Next Tool** button when the ToolBar is scrollable.
|
|
1450
|
+
*/
|
|
1451
|
+
nextToolButton: string;
|
|
1452
|
+
static ɵfac: i0.ɵɵFactoryDeclaration<ToolbarMessages, never>;
|
|
1453
|
+
static ɵdir: i0.ɵɵDirectiveDeclaration<ToolbarMessages, "kendo-toolbar-messages-base", never, { "moreToolsTitle": { "alias": "moreToolsTitle"; "required": false; }; "previousToolButton": { "alias": "previousToolButton"; "required": false; }; "nextToolButton": { "alias": "nextToolButton"; "required": false; }; }, {}, never, never, true, never>;
|
|
1454
|
+
}
|
|
1455
|
+
|
|
1456
|
+
/**
|
|
1457
|
+
* Represents the custom messages component of the ToolBar.
|
|
1458
|
+
*
|
|
1459
|
+
* Use this component to override default messages for the ToolBar.
|
|
1460
|
+
*
|
|
1461
|
+
* @example
|
|
1462
|
+
* ```html
|
|
1463
|
+
* <kendo-toolbar>
|
|
1464
|
+
* <kendo-toolbar-messages
|
|
1465
|
+
* moreToolsTitle="More options"
|
|
1466
|
+
* previousToolButton="Previous"
|
|
1467
|
+
* nextToolButton="Next">
|
|
1468
|
+
* </kendo-toolbar-messages>
|
|
1469
|
+
* </kendo-toolbar>
|
|
1470
|
+
* ```
|
|
1471
|
+
*/
|
|
1472
|
+
declare class ToolbarCustomMessagesComponent extends ToolbarMessages {
|
|
1473
|
+
protected service: LocalizationService;
|
|
1474
|
+
constructor(service: LocalizationService);
|
|
1475
|
+
protected get override(): boolean;
|
|
1476
|
+
static ɵfac: i0.ɵɵFactoryDeclaration<ToolbarCustomMessagesComponent, never>;
|
|
1477
|
+
static ɵcmp: i0.ɵɵComponentDeclaration<ToolbarCustomMessagesComponent, "kendo-toolbar-messages", never, {}, {}, never, never, true, never>;
|
|
1478
|
+
}
|
|
1479
|
+
|
|
1480
|
+
/**
|
|
1481
|
+
* Represents the [`NgModule`](link:site.data.urls.angular['ngmoduleapi']) definition for the ToolBar component.
|
|
1482
|
+
*
|
|
1483
|
+
* @example
|
|
1484
|
+
* ```typescript
|
|
1485
|
+
* import { ToolBarModule } from '@progress/kendo-angular-toolbar';
|
|
1486
|
+
*
|
|
1487
|
+
* @NgModule({
|
|
1488
|
+
* imports: [ToolBarModule]
|
|
1489
|
+
* })
|
|
1490
|
+
* export class AppModule {}
|
|
1491
|
+
* ```
|
|
1492
|
+
*/
|
|
1493
|
+
declare class ToolBarModule {
|
|
1494
|
+
static ɵfac: i0.ɵɵFactoryDeclaration<ToolBarModule, never>;
|
|
1495
|
+
static ɵmod: i0.ɵɵNgModuleDeclaration<ToolBarModule, never, [typeof ToolBarComponent, typeof ToolbarCustomMessagesComponent, typeof ToolBarButtonComponent, typeof ToolBarButtonGroupComponent, typeof ToolBarDropDownButtonComponent, typeof ToolBarSeparatorComponent, typeof ToolBarSpacerComponent, typeof ToolBarSplitButtonComponent, typeof ToolBarToolComponent], [typeof ToolBarComponent, typeof ToolbarCustomMessagesComponent, typeof ToolBarButtonComponent, typeof ToolBarButtonGroupComponent, typeof ToolBarDropDownButtonComponent, typeof ToolBarSeparatorComponent, typeof ToolBarSpacerComponent, typeof ToolBarSplitButtonComponent, typeof ToolBarToolComponent]>;
|
|
1496
|
+
static ɵinj: i0.ɵɵInjectorDeclaration<ToolBarModule>;
|
|
1497
|
+
}
|
|
1498
|
+
|
|
1499
|
+
/**
|
|
1500
|
+
* @hidden
|
|
1501
|
+
*/
|
|
1502
|
+
declare class LocalizedToolbarMessagesDirective extends ToolbarMessages {
|
|
1503
|
+
protected service: LocalizationService;
|
|
1504
|
+
constructor(service: LocalizationService);
|
|
1505
|
+
static ɵfac: i0.ɵɵFactoryDeclaration<LocalizedToolbarMessagesDirective, never>;
|
|
1506
|
+
static ɵdir: i0.ɵɵDirectiveDeclaration<LocalizedToolbarMessagesDirective, "[kendoToolbarLocalizedMessages]", never, {}, {}, never, never, true, never>;
|
|
1507
|
+
}
|
|
1508
|
+
|
|
1509
|
+
/**
|
|
1510
|
+
* Use this utility array to access all `@progress/kendo-angular-toolbar`-related components and directives in a standalone Angular component.
|
|
1511
|
+
*
|
|
1512
|
+
* @example
|
|
1513
|
+
* ```typescript
|
|
1514
|
+
* import { Component } from '@angular/core';
|
|
1515
|
+
* import { KENDO_TOOLBAR } from '@progress/kendo-angular-toolbar';
|
|
1516
|
+
*
|
|
1517
|
+
* @Component({
|
|
1518
|
+
* selector: 'my-app',
|
|
1519
|
+
* standalone: true,
|
|
1520
|
+
* imports: [KENDO_TOOLBAR],
|
|
1521
|
+
* template: `
|
|
1522
|
+
* <kendo-toolbar>
|
|
1523
|
+
* <kendo-toolbar-button text="Button"></kendo-toolbar-button>
|
|
1524
|
+
* </kendo-toolbar>
|
|
1525
|
+
* `
|
|
1526
|
+
* })
|
|
1527
|
+
* export class AppComponent {}
|
|
1528
|
+
* ```
|
|
1529
|
+
*/
|
|
1530
|
+
declare const KENDO_TOOLBAR: readonly [typeof ToolBarComponent, typeof ToolbarCustomMessagesComponent, typeof ToolBarButtonComponent, typeof ToolBarButtonGroupComponent, typeof ToolBarDropDownButtonComponent, typeof ToolBarSeparatorComponent, typeof ToolBarSpacerComponent, typeof ToolBarSplitButtonComponent, typeof ToolBarToolComponent];
|
|
1531
|
+
|
|
1532
|
+
export { KENDO_TOOLBAR, LocalizedToolbarMessagesDirective, RefreshService, ToolBarButtonComponent, ToolBarButtonGroupComponent, ToolBarComponent, ToolBarDropDownButtonComponent, ToolBarModule, ToolBarSeparatorComponent, ToolBarSpacerComponent, ToolBarSplitButtonComponent, ToolBarToolComponent, ToolbarCustomMessagesComponent };
|
|
1533
|
+
export type { ButtonGroupSelection, DisplayMode, OverflowMode, PopupSettings, ToolbarFillMode, ToolbarOverflowSettings, ToolbarScrollButtonsPosition, ToolbarScrollButtonsVisibility, ToolbarSize };
|