@progress/kendo-angular-layout
Version:
Kendo UI for Angular Layout Package - a collection of components to create professional application layoyts
71 lines (70 loc) • 3.1 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 { TabStripScrollButtonsVisibility } from "./scroll-buttons-visibility";
/**
* The settings for the scrollable functionality of the TabStrip. ([see example]({% slug scrollable_tabstrip %}))
*/
export interface TabStripScrollableSettings {
/**
* Determines whether the TabStrip will be scrollable.
* @default true
*/
enabled?: boolean;
/**
* Determines the TabStrip scroll buttons visibility mode. The possible options are:
* - 'auto'(default) - The scroll buttons will be rendered only when the tabs list overflows its container.
* - 'visible' - The scroll buttons will be always visible.
* - 'hidden' - No scroll buttons will be rendered.
*/
scrollButtons?: TabStripScrollButtonsVisibility;
/**
* Determines whether the TabStrip will be scrolled with the mouse or other pointer devices such as touchpads and touch screens.
* @default true
*/
mouseScroll?: boolean;
/**
* Sets the tab list scroll speed in pixels when clicking the scroll buttons.
* @default 100
*/
buttonScrollSpeed?: number;
/**
* 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.
*
* 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.
*
* 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.
*/
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.
*/
nextSVGButtonIcon?: SVGIcon;
/**
* Determines the TabStrip scroll buttons position. The possible options are:
* - 'start'—The scroll buttons will be rendered at the start before all tabs.
* - 'end'—The scroll buttons will be rendered at the end after all tabs.
* - 'split'(default)—The scroll buttons will be rendered at each side of the tabs.
*/
scrollButtonsPosition?: TabStripScrollButtonsPosition;
}
/**
* The available options for the `scrollButtonsPosition` option.
*/
export type TabStripScrollButtonsPosition = 'start' | 'end' | 'split';
/**
* @hidden
*/
export declare const normalizeScrollableSettings: (settings: any) => any;