120 lines
2.7 KiB
TypeScript
120 lines
2.7 KiB
TypeScript
/**
|
|
*
|
|
* Splitter is utilized to separate and resize panels.
|
|
*
|
|
* [Live Demo](https://www.primevue.org/splitter/)
|
|
*
|
|
* @module splitter
|
|
*
|
|
*/
|
|
import { VNode } from 'vue';
|
|
import { ClassComponent, GlobalComponentConstructor } from '../ts-helpers';
|
|
|
|
/**
|
|
* Custom resize start event.
|
|
* @see {@link SplitterEmits.resizestar}
|
|
*/
|
|
export interface SplitterResizeStartEvent {
|
|
/**
|
|
* Browser event
|
|
*/
|
|
originalEvent: Event;
|
|
/**
|
|
* Sizes of the panels
|
|
*/
|
|
sizes: number[];
|
|
}
|
|
|
|
/**
|
|
* Custom resize end event.
|
|
* @see {@link PickListEmits.resizeend}
|
|
*/
|
|
export interface SplitterResizeEndEvent {
|
|
/**
|
|
* Browser event
|
|
*/
|
|
originalEvent: Event;
|
|
/**
|
|
* Sizes of the panels
|
|
*/
|
|
sizes: number[];
|
|
}
|
|
|
|
/**
|
|
* Defines valid properties in Splitter component.
|
|
*/
|
|
export interface SplitterProps {
|
|
/**
|
|
* Orientation of the panels.
|
|
* @defaultValue horizontal
|
|
*/
|
|
layout?: 'horizontal' | 'vertical' | undefined;
|
|
/**
|
|
* Size of the divider in pixels.
|
|
* @defaultValue 4
|
|
*/
|
|
gutterSize?: number | undefined;
|
|
/**
|
|
* Storage identifier of a stateful Splitter.
|
|
*/
|
|
stateKey?: string | undefined;
|
|
/**
|
|
* Defines where a stateful splitter keeps its state, valid values are 'session' for sessionStorage and 'local' for localStorage.
|
|
* @defaultValue session
|
|
*/
|
|
stateStorage?: 'local' | 'session' | undefined;
|
|
/**
|
|
* Step factor to increment/decrement the size of the panels while pressing the arrow keys.
|
|
* @defaultValue 1
|
|
*/
|
|
step?: number | undefined;
|
|
}
|
|
|
|
/**
|
|
* Defines valid slots in Splitter slots.
|
|
*/
|
|
export interface SplitterSlots {
|
|
/**
|
|
* Default slot to detect SplitterPanel components.
|
|
*/
|
|
default(): VNode[];
|
|
}
|
|
|
|
/**
|
|
* Defines valid emits in Splitter component.
|
|
*/
|
|
export interface SplitterEmits {
|
|
/**
|
|
* Callback to invoke when resize starts.
|
|
* @param {SplitterResizeStartEvent} event - Custom resize start event.
|
|
*/
|
|
resizestar(event: SplitterResizeStartEvent): void;
|
|
/**
|
|
* Callback to invoke when resize ends.
|
|
* @param {SplitterResizeEndEvent} event - Custom resize end event.
|
|
*/
|
|
resizeend(event: SplitterResizeEndEvent): void;
|
|
}
|
|
|
|
/**
|
|
* **PrimeVue - Splitter**
|
|
*
|
|
* _Splitter is utilized to separate and resize panels._
|
|
*
|
|
* [Live Demo](https://www.primevue.org/splitter/)
|
|
* --- ---
|
|
* 
|
|
*
|
|
* @group Component
|
|
*
|
|
*/
|
|
declare class Splitter extends ClassComponent<SplitterProps, SplitterSlots, SplitterEmits> {}
|
|
|
|
declare module '@vue/runtime-core' {
|
|
interface GlobalComponents {
|
|
Splitter: GlobalComponentConstructor<Splitter>;
|
|
}
|
|
}
|
|
|
|
export default Splitter;
|