/** * DevExtreme (ui/splitter.d.ts) * Version: 25.1.7 * Build date: Mon Nov 10 2025 * * Copyright (c) 2012 - 2025 Developer Express Inc. ALL RIGHTS RESERVED * Read about DevExtreme licensing here: https://js.devexpress.com/Licensing/ */ /* eslint-disable @typescript-eslint/no-unused-vars */ import { DataSourceLike } from '../data/data_source'; import { Cancelable, EventInfo, NativeEventInfo, InitializedEventInfo, ChangedOptionInfo, ItemInfo, InteractionEvent, PointerInteractionEvent, } from '../events'; import CollectionWidget, { CollectionWidgetItem, CollectionWidgetOptions, } from './collection/ui.collection_widget.base'; import { DxElement, } from '../core/element'; import { Mode, Orientation, } from '../common'; /** * * @deprecated Attention! This type is for internal purposes only. If you used it previously, please submit a ticket to our {@link https://supportcenter.devexpress.com/ticket/create Support Center}. We will check if there is an alternative solution. */ export interface ResizeInfo { /** * A resize handle element. */ readonly handleElement?: DxElement; } type ItemLike = string | Item | any; export { Mode, }; /** * The type of the contentReady event handler's argument. */ export type ContentReadyEvent = any, TKey = any> = EventInfo>; /** * The type of the disposing event handler's argument. */ export type DisposingEvent = any, TKey = any> = EventInfo>; /** * The type of the initialized event handler's argument. */ export type InitializedEvent = any, TKey = any> = InitializedEventInfo>; /** * The type of the itemClick event handler's argument. */ export type ItemClickEvent = any, TKey = any> = NativeEventInfo, MouseEvent | PointerEvent> & ItemInfo; /** * The type of the itemContextMenu event handler's argument. */ export type ItemContextMenuEvent = any, TKey = any> = NativeEventInfo, PointerInteractionEvent> & ItemInfo; /** * The type of the itemRendered event handler's argument. */ export type ItemRenderedEvent = any, TKey = any> = EventInfo> & ItemInfo; /** * The type of the optionChanged event handler's argument. */ export type OptionChangedEvent = any, TKey = any> = EventInfo> & ChangedOptionInfo; /** * The type of the resize event handler's argument. */ export type ResizeEvent = Cancelable & NativeEventInfo, InteractionEvent> & ResizeInfo; /** * The type of the resizeStart event handler's argument. */ export type ResizeStartEvent = Cancelable & NativeEventInfo, InteractionEvent> & ResizeInfo; /** * The type of the resizeEnd event handler's argument. */ export type ResizeEndEvent = NativeEventInfo, InteractionEvent> & ResizeInfo; /** * The type of the itemCollapsed event handler's argument. */ export type ItemCollapsedEvent = any, TKey = any> = NativeEventInfo, InteractionEvent> & ItemInfo; /** * The type of the itemExpanded event handler's argument. */ export type ItemExpandedEvent = any, TKey = any> = NativeEventInfo, InteractionEvent> & ItemInfo; /** * * @deprecated */ export interface dxSplitterOptions< TItem extends ItemLike = any, TKey = any, > extends CollectionWidgetOptions, TItem, TKey> { /** * Binds the UI component to data. */ dataSource?: DataSourceLike | null; /** * Specifies item orientation (layout). */ orientation?: Orientation; /** * An array of items (panes) displayed by the UI component. */ items?: Array; /** * Specifies whether to allow the Splitter to take focus and allow keyboard navigation. */ allowKeyboardNavigation?: boolean; /** * Specifies the size of a separator bar in pixels. */ separatorSize?: number; /** * A function that is executed each time an item (pane) is resized by one pixel. */ onResize?: ((e: ResizeEvent) => void); /** * A function that is called when resizing ends. */ onResizeEnd?: ((e: ResizeEndEvent) => void); /** * A function that is called when resizing starts. */ onResizeStart?: ((e: ResizeStartEvent) => void); /** * A function that is executed after an item (pane) is expanded. */ onItemExpanded?: ((e: ItemExpandedEvent) => void); /** * A function that is executed after an item (pane) is collapsed. */ onItemCollapsed?: ((e: ItemCollapsedEvent) => void); } /** * Splitter is a UI component that allows you to divide a page or section into multiple adjustable panes. */ export default class dxSplitter< TItem extends ItemLike = any, TKey = any, > extends CollectionWidget, TItem, TKey> { } export type Item = dxSplitterItem; /** * @deprecated Use Item instead * @deprecated Attention! This type is for internal purposes only. If you used it previously, please submit a ticket to our {@link https://supportcenter.devexpress.com/ticket/create Support Center}. We will check if there is an alternative solution. */ export interface dxSplitterItem extends CollectionWidgetItem { /** * Specifies a splitter inside an item (pane). */ splitter?: Properties | undefined; /** * Specifies the initial size of an item (pane) in pixels or as a percentage. The size changes after any layout alteration. */ size?: number | string | undefined; /** * Specifies the maximum size of an item (pane) in pixels or as a percentage. */ maxSize?: number | string | undefined; /** * Specifies the minimum size of an item (pane) in pixels or as a percentage. */ minSize?: number | string | undefined; /** * Specifies the size of a collapsible item (pane) when collapsed in pixels or as a percentage. */ collapsedSize?: number | string | undefined; /** * Specifies whether an item (pane) is initially collapsed. */ collapsed?: boolean; /** * Specifies whether an item (pane) is collapsible. */ collapsible?: boolean; /** * Specifies whether an item (pane) is resizable. */ resizable?: boolean; } export type ExplicitTypes< TItem extends ItemLike, TKey, > = { Properties: Properties; ContentReadyEvent: ContentReadyEvent; DisposingEvent: DisposingEvent; InitializedEvent: InitializedEvent; ItemClickEvent: ItemClickEvent; ItemContextMenuEvent: ItemContextMenuEvent; ItemRenderedEvent: ItemRenderedEvent; OptionChangedEvent: OptionChangedEvent; }; export type Properties< TItem extends ItemLike = any, TKey = any, > = dxSplitterOptions;