primevue-mirror/components/tabpanel/TabPanel.d.ts

101 lines
2.3 KiB
TypeScript
Raw Normal View History

2023-03-01 08:06:07 +00:00
/**
*
* TabPanel is a helper component for TabPanel component.
*
* [Live Demo](https://www.primevue.org/tabview/)
*
* @module tabpanel
*
*/
2022-09-14 11:26:01 +00:00
import { AnchorHTMLAttributes, HTMLAttributes, LiHTMLAttributes, VNode } from 'vue';
2022-09-06 12:03:37 +00:00
import { ClassComponent, GlobalComponentConstructor } from '../ts-helpers';
2023-03-01 08:06:07 +00:00
/**
* Defines valid properties in TabPanel component.
*/
2022-09-06 12:03:37 +00:00
export interface TabPanelProps {
/**
* Orientation of tab headers.
*/
header?: string | undefined;
2022-09-14 11:26:01 +00:00
/**
* Inline style of the tab header.
*/
headerStyle?: any;
/**
* Style class of the tab header.
*/
headerClass?: any;
/**
* Uses to pass all properties of the HTMLLiElement to the tab header.
*/
headerProps?: LiHTMLAttributes | undefined;
/**
* Uses to pass all properties of the HTMLAnchorElement to the focusable anchor element inside the tab header.
*/
headerActionProps?: AnchorHTMLAttributes | undefined;
/**
* Inline style of the tab content.
*/
contentStyle?: any;
/**
* Style class of the tab content.
*/
contentClass?: any;
/**
* Uses to pass all properties of the HTMLDivElement to the tab content.
*/
contentProps?: HTMLAttributes | undefined;
2022-09-06 12:03:37 +00:00
/**
* Whether the tab is disabled.
2023-03-01 08:06:07 +00:00
* @defaultValue false
2022-09-06 12:03:37 +00:00
*/
disabled?: boolean | undefined;
}
2023-03-01 08:06:07 +00:00
/**
* Defines valid slots in TabPanel slots.
*/
2022-09-06 12:03:37 +00:00
export interface TabPanelSlots {
/**
* Custom content template.
*/
default: () => VNode[];
/**
* Custom header template.
*/
header: () => VNode[];
}
2023-03-01 08:06:07 +00:00
export interface TabPanelEmits {}
2022-09-06 12:03:37 +00:00
2023-03-01 08:06:07 +00:00
/**
* **PrimeVue - TabPanel**
*
* _TabPanel is a helper component for TabPanel component._
*
* [Live Demo](https://www.primevue.org/tabview/)
* --- ---
* ![PrimeVue](https://primefaces.org/cdn/primevue/images/logo.svg)
*
* @group Component
*
*/
export declare class TabPanel extends ClassComponent<TabPanelProps, TabPanelSlots, TabPanelEmits> {}
2022-09-06 12:03:37 +00:00
declare module '@vue/runtime-core' {
interface GlobalComponents {
2022-09-14 11:26:01 +00:00
TabPanel: GlobalComponentConstructor<TabPanel>;
2022-09-06 12:03:37 +00:00
}
}
/**
*
2023-03-01 08:06:07 +00:00
* TabPanel is a helper component for TabPanel component.
2022-09-06 12:03:37 +00:00
*
* Demos:
*
2023-03-01 08:06:07 +00:00
* - [TabPanel](https://www.primefaces.org/primevue/tabview)
2022-09-06 12:03:37 +00:00
*
*/
export default TabPanel;