146 lines
3.5 KiB
TypeScript
146 lines
3.5 KiB
TypeScript
/**
|
|
*
|
|
* SplitterPanel is a helper component for Splitter component.
|
|
*
|
|
* [Live Demo](https://www.primevue.org/splitter/)
|
|
*
|
|
* @module splitterpanel
|
|
*
|
|
*/
|
|
import { VNode } from 'vue';
|
|
import { ComponentHooks } from '../basecomponent';
|
|
import { PassThroughOptions } from '../passthrough';
|
|
import { ClassComponent, DesignToken, GlobalComponentConstructor, PassThrough } from '../ts-helpers';
|
|
|
|
export declare type SplitterPanelPassThroughOptionType = SplitterPanelPassThroughAttributes | ((options: SplitterPanelPassThroughMethodOptions) => SplitterPanelPassThroughAttributes | string) | string | null | undefined;
|
|
|
|
/**
|
|
* Custom passthrough(pt) option method.
|
|
*/
|
|
export interface SplitterPanelPassThroughMethodOptions {
|
|
/**
|
|
* Defines instance.
|
|
*/
|
|
instance: any;
|
|
/**
|
|
* Defines valid properties.
|
|
*/
|
|
props: SplitterPanelProps;
|
|
/**
|
|
* Defines current options.
|
|
*/
|
|
context: SplitterPanelContext;
|
|
/**
|
|
* Defines valid attributes.
|
|
*/
|
|
attrs: any;
|
|
/**
|
|
* Defines parent options.
|
|
*/
|
|
parent: any;
|
|
/**
|
|
* Defines passthrough(pt) options in global config.
|
|
*/
|
|
global: object | undefined;
|
|
}
|
|
|
|
/**
|
|
* Custom passthrough(pt) options.
|
|
* @see {@link PanelProps.pt}
|
|
*/
|
|
export interface SplitterPanelPassThroughOptions {
|
|
/**
|
|
* Used to pass attributes to the root's DOM element.
|
|
*/
|
|
root?: SplitterPanelPassThroughOptionType;
|
|
/**
|
|
* Used to manage all lifecycle hooks.
|
|
* @see {@link BaseComponent.ComponentHooks}
|
|
*/
|
|
hooks?: ComponentHooks;
|
|
}
|
|
|
|
/**
|
|
* Custom passthrough attributes for each DOM elements
|
|
*/
|
|
export interface SplitterPanelPassThroughAttributes {
|
|
[key: string]: any;
|
|
}
|
|
|
|
/**
|
|
* Defines options in SplitterPanel component.
|
|
*/
|
|
export interface SplitterPanelContext {
|
|
/**
|
|
* Current nested state of the panel.
|
|
*/
|
|
nested?: boolean;
|
|
}
|
|
|
|
/**
|
|
* Defines valid properties in SplitterPanel component.
|
|
*/
|
|
export interface SplitterPanelProps {
|
|
/**
|
|
* Size of the element relative to 100%.
|
|
*/
|
|
size?: number | undefined;
|
|
/**
|
|
* Minimum size of the element relative to 100%.
|
|
*/
|
|
minSize?: number | undefined;
|
|
/**
|
|
* It generates scoped CSS variables using design tokens for the component.
|
|
*/
|
|
dt?: DesignToken<any>;
|
|
/**
|
|
* Used to pass attributes to DOM elements inside the component.
|
|
* @type {SplitterPanelPassThroughOptions}
|
|
*/
|
|
pt?: PassThrough<SplitterPanelPassThroughOptions>;
|
|
/**
|
|
* Used to configure passthrough(pt) options of the component.
|
|
* @type {PassThroughOptions}
|
|
*/
|
|
ptOptions?: PassThroughOptions;
|
|
/**
|
|
* When enabled, it removes component related styles in the core.
|
|
* @defaultValue false
|
|
*/
|
|
unstyled?: boolean;
|
|
}
|
|
|
|
/**
|
|
* Defines valid slots in SplitterPanel slots.
|
|
*/
|
|
export interface SplitterPanelSlots {
|
|
/**
|
|
* Custom content template.
|
|
*/
|
|
default: () => VNode[];
|
|
}
|
|
|
|
export interface SplitterPanelEmits {}
|
|
|
|
/**
|
|
* **PrimeVue - SplitterPanel**
|
|
*
|
|
* _SplitterPanel is a helper component for Splitter component._
|
|
*
|
|
* [Live Demo](https://www.primevue.org/splitterpanel/)
|
|
* --- ---
|
|
* 
|
|
*
|
|
* @group Component
|
|
*
|
|
*/
|
|
declare class SplitterPanel extends ClassComponent<SplitterPanelProps, SplitterPanelSlots, SplitterPanelEmits> {}
|
|
|
|
declare module 'vue' {
|
|
export interface GlobalComponents {
|
|
SplitterPanel: GlobalComponentConstructor<SplitterPanel>;
|
|
}
|
|
}
|
|
|
|
export default SplitterPanel;
|