@progress/kendo-angular-toolbar
Version:
Kendo UI Angular Toolbar component - a single UI element that organizes buttons and other navigation elements
54 lines (53 loc) • 2.84 kB
TypeScript
/**-----------------------------------------------------------------------------------------
* Copyright © 2025 Progress Software Corporation. All rights reserved.
* Licensed under commercial license. See LICENSE.md in the project root for more information
*-------------------------------------------------------------------------------------------*/
import { SVGIcon } from "@progress/kendo-svg-icons";
import { OverflowMode } from "./overflow-mode";
import { ToolbarScrollButtonsPosition, ToolbarScrollButtonsVisibility } from "./scroll-buttons";
/**
* The settings for the overflow functionality of the Toolbar.
*/
export interface ToolbarOverflowSettings {
/**
* Determines the Toolbar overflow mode.
* @default 'none'
*/
mode?: OverflowMode;
/**
* Determines the Toolbar scroll buttons visibility mode. Applicable when the overflow mode is set to 'scroll'. The possible options are:
* - 'auto' (default) - The scroll buttons will be rendered only when the tools list overflows its container.
* - 'visible' - The scroll buttons will be always visible.
* - 'hidden' - No scroll buttons will be rendered.
*/
scrollButtons?: ToolbarScrollButtonsVisibility;
/**
* Determines the Toolbar scroll buttons position. Applicable when the overflow mode is set to 'scroll'. The possible options are:
* - 'start'—The scroll buttons will be rendered at the start before all tools.
* - 'end'—The scroll buttons will be rendered at the end after all tools.
* - 'split'(default)—The scroll buttons will be rendered at each side of the tools list.
*/
scrollButtonsPosition?: ToolbarScrollButtonsPosition;
/**
* Allows defining a custom CSS class, or multiple classes separated by spaces, which will be applied to the span element of the prev scroll button. Applicable when the overflow mode is set to 'scroll'.
*
* Allows the usage of custom icons.
*/
prevButtonIcon?: string;
/**
* Allows defining a custom CSS class, or multiple classes separated by spaces, which will be applied to the span element of the next scroll button. Applicable when the overflow mode is set to 'scroll'.
*
* Allows the usage of custom icons.
*/
nextButtonIcon?: string;
/**
* Defines an SVGIcon to be rendered for the previous button icon.
* The input can take either an [existing Kendo SVG icon](slug:svgicon_list) or a custom one. Applicable when the overflow mode is set to 'scroll'.
*/
prevSVGButtonIcon?: SVGIcon;
/**
* Defines an SVGIcon to be rendered for the next button icon.
* The input can take either an [existing Kendo SVG icon](slug:svgicon_list) or a custom one. Applicable when the overflow mode is set to 'scroll'.
*/
nextSVGButtonIcon?: SVGIcon;
}