-
Notifications
You must be signed in to change notification settings - Fork 1.3k
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
1 parent
d2b59b6
commit 6f2c412
Showing
1 changed file
with
74 additions
and
7 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -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[]; | ||
} | ||
|
||
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; | ||
} | ||
|
||
declare class Splitter { | ||
$props: SplitterProps; | ||
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; |