primevue-mirror/components/lib/splitterpanel/SplitterPanel.d.ts

148 lines
3.6 KiB
TypeScript
Raw Normal View History

2023-02-28 21:23:26 +00:00
/**
*
* SplitterPanel is a helper component for Splitter component.
*
* [Live Demo](https://www.primevue.org/splitter/)
*
* @module splitterpanel
*
*/
2022-09-06 12:03:37 +00:00
import { VNode } from 'vue';
2023-07-06 11:17:08 +00:00
import { ComponentHooks } from '../basecomponent';
2023-09-05 08:50:46 +00:00
import { PassThroughOptions } from '../passthrough';
import { DefineComponent, DesignToken, EmitFn, GlobalComponentConstructor, PassThrough } from '../ts-helpers';
2022-09-06 12:03:37 +00:00
export declare type SplitterPanelPassThroughOptionType = SplitterPanelPassThroughAttributes | ((options: SplitterPanelPassThroughMethodOptions) => SplitterPanelPassThroughAttributes | string) | string | null | undefined;
2023-03-27 07:13:31 +00:00
/**
* Custom passthrough(pt) option method.
*/
export interface SplitterPanelPassThroughMethodOptions {
/**
* Defines instance.
*/
2023-07-06 12:01:33 +00:00
instance: any;
/**
* Defines valid properties.
*/
2023-03-27 07:13:31 +00:00
props: SplitterPanelProps;
/**
* Defines current options.
*/
2023-07-25 09:22:30 +00:00
context: SplitterPanelContext;
/**
* Defines valid attributes.
*/
attrs: any;
/**
* Defines parent options.
*/
parent: any;
2023-09-05 08:50:46 +00:00
/**
* Defines passthrough(pt) options in global config.
*/
global: object | undefined;
2023-03-27 07:13:31 +00:00
}
/**
* Custom passthrough(pt) options.
2024-05-16 14:05:43 +00:00
* @see {@link SplitterPanelProps.pt}
2023-03-27 07:13:31 +00:00
*/
export interface SplitterPanelPassThroughOptions {
/**
* Used to pass attributes to the root's DOM element.
2023-03-27 07:13:31 +00:00
*/
root?: SplitterPanelPassThroughOptionType;
2023-07-06 11:09:01 +00:00
/**
2023-11-07 06:16:39 +00:00
* Used to manage all lifecycle hooks.
2023-07-06 11:09:01 +00:00
* @see {@link BaseComponent.ComponentHooks}
*/
hooks?: ComponentHooks;
2023-03-27 07:13:31 +00:00
}
/**
* Custom passthrough attributes for each DOM elements
*/
export interface SplitterPanelPassThroughAttributes {
[key: string]: any;
}
2023-07-25 09:22:30 +00:00
/**
* Defines options in SplitterPanel component.
*/
export interface SplitterPanelContext {
/**
* Current nested state of the panel.
*/
nested?: boolean;
}
2023-02-28 21:23:26 +00:00
/**
* Defines valid properties in SplitterPanel component.
*/
2022-09-06 12:03:37 +00:00
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>;
2023-03-27 07:13:31 +00:00
/**
2023-08-01 14:01:12 +00:00
* Used to pass attributes to DOM elements inside the component.
2023-03-27 07:13:31 +00:00
* @type {SplitterPanelPassThroughOptions}
*/
pt?: PassThrough<SplitterPanelPassThroughOptions>;
2023-09-05 08:50:46 +00:00
/**
* Used to configure passthrough(pt) options of the component.
* @type {PassThroughOptions}
*/
ptOptions?: PassThroughOptions;
2023-05-24 08:54:19 +00:00
/**
* When enabled, it removes component related styles in the core.
* @defaultValue false
*/
unstyled?: boolean;
2022-09-06 12:03:37 +00:00
}
2023-02-28 21:23:26 +00:00
/**
* Defines valid slots in SplitterPanel slots.
*/
2022-09-06 12:03:37 +00:00
export interface SplitterPanelSlots {
/**
* Custom content template.
*/
default: () => VNode[];
}
2024-05-16 14:05:43 +00:00
export interface SplitterPanelEmitsOptions {}
export declare type SplitterPanelEmits = EmitFn<SplitterPanelEmitsOptions>;
2022-09-06 12:03:37 +00:00
2023-02-28 21:23:26 +00:00
/**
* **PrimeVue - SplitterPanel**
*
* _SplitterPanel is a helper component for Splitter component._
*
* [Live Demo](https://www.primevue.org/splitterpanel/)
* --- ---
2023-03-03 10:55:20 +00:00
* ![PrimeVue](https://primefaces.org/cdn/primevue/images/logo-100.png)
2023-02-28 21:23:26 +00:00
*
* @group Component
*
*/
declare const SplitterPanel: DefineComponent<SplitterPanelProps, SplitterPanelSlots, SplitterPanelEmits>;
2022-09-06 12:03:37 +00:00
declare module 'vue' {
export interface GlobalComponents {
SplitterPanel: GlobalComponentConstructor<SplitterPanelProps, SplitterPanelSlots, SplitterPanelEmits>;
2022-09-06 12:03:37 +00:00
}
}
export default SplitterPanel;