Fixed #1836 - For Splitter

pull/1846/head
mertsincan 2021-12-01 17:21:13 +03:00
parent d2b59b60ba
commit 6f2c412c28
1 changed files with 74 additions and 7 deletions

View File

@ -1,12 +1,79 @@
interface SplitterProps {
layout?: string;
gutterSize?: number;
stateKey?: string;
stateStorage?: string;
import { VNode } from 'vue';
import { ClassComponent, GlobalComponentConstructor } from '../ts-helpers';
type SplitterLayoutType = 'horizontal' | 'vertical';
type SplitterStateStorageType = 'local' | 'session';
export interface SplitterResizeEndEvent {
/**
* Browser event
*/
originalEvent: Event;
/**
* Sizes of the panels
*/
sizes: number[];
}
declare class Splitter {
$props: SplitterProps;
export interface SplitterProps {
/**
* Orientation of the panels.
* @see SplitterLayoutType
* Default value is 'horizontal'.
*/
layout?: SplitterLayoutType;
/**
* Size of the divider in pixels.
* Default value is 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.
* @see SplitterStateStorageType
* Default value is 'session'.
*/
stateStorage?: SplitterStateStorageType;
}
export interface SplitterSlots {
/**
* Default slot to detect SplitterPanel components.
*/
default: () => VNode[];
}
export declare type SplitterEmits = {
/**
* Callback to invoke when resize ends.
* @param {SplitterResizeEndEvent} event - Custom resize end event.
*/
'resizeend': (event: SplitterResizeEndEvent) => void;
}
declare class Splitter extends ClassComponent<SplitterProps, SplitterSlots, SplitterEmits> { }
declare module '@vue/runtime-core' {
interface GlobalComponents {
Splitter: GlobalComponentConstructor<Splitter>
}
}
/**
*
* Splitter is utilized to separate and resize panels.
*
* Helper Components:
*
* - SplitterPanel
*
* Demos:
*
* - [Splitter](https://www.primefaces.org/primevue/showcase/#/splitter)
*
*/
export default Splitter;