primevue-mirror/packages/primevue/src/overlaypanel/OverlayPanel.d.ts

111 lines
3.0 KiB
TypeScript
Raw Normal View History

2023-03-01 10:19:01 +00:00
/**
*
* OverlayPanel is a container component positioned as connected to its target.
*
* [Live Demo](https://primevue.org/popover)
2023-03-01 10:19:01 +00:00
*
* @module overlaypanel
*
*/
import type { DefineComponent, EmitFn } from '@primevue/core';
2024-06-11 23:08:08 +00:00
import * as Popover from 'primevue/popover';
import 'vue';
2023-08-02 14:07:22 +00:00
2023-04-24 11:44:13 +00:00
/**
* Custom passthrough(pt) option method.
*/
export interface OverlayPanelPassThroughMethodOptions extends Popover.PopoverPassThroughMethodOptions {}
2023-04-24 11:44:13 +00:00
/**
* Custom passthrough(pt) options.
* @see {@link OverlayPanelProps.pt}
*/
export interface OverlayPanelPassThroughOptions extends Popover.PopoverPassThroughOptions {}
2023-04-24 11:44:13 +00:00
/**
* Custom passthrough attributes for each DOM elements
*/
export interface OverlayPanelPassThroughAttributes extends Popover.PopoverPassThroughAttributes {
2023-04-24 11:44:13 +00:00
[key: string]: any;
}
/**
* Defines current inline state in OverlayPanel component.
*/
export interface OverlayPanelState extends Popover.PopoverState {}
2023-04-24 11:44:13 +00:00
2023-03-01 10:19:01 +00:00
/**
* OverlayPanel breakpoint metadata.
*/
export interface OverlayPanelBreakpoints extends Popover.PopoverBreakpoints {}
2022-09-06 12:03:37 +00:00
2023-03-01 10:19:01 +00:00
/**
* Defines valid properties in OverlayPanel component.
*/
export interface OverlayPanelProps extends Popover.PopoverProps {}
2022-09-06 12:03:37 +00:00
2023-03-01 10:19:01 +00:00
/**
* Defines valid slots in OverlayPanel component.
*/
export interface OverlayPanelSlots extends Popover.PopoverSlots {}
2022-09-06 12:03:37 +00:00
/**
* Defines valid emits in OverlayPanel component.
*/
2024-05-16 14:05:43 +00:00
export interface OverlayPanelEmitsOptions {}
export declare type OverlayPanelEmits = EmitFn<OverlayPanelEmitsOptions> & Popover.PopoverEmits;
export interface OverlayPanelMethods {
/**
* Aligns overlay panel based on the current position of the container.
*/
alignOverlay(): void;
2022-09-06 12:03:37 +00:00
/**
* Toggles the visibility of the overlay.
* @param {Event} event - Browser event.
2022-12-08 11:04:25 +00:00
* @param {*} [target] - Optional target if event.currentTarget should not be used.
2022-09-06 12:03:37 +00:00
*
* @memberof OverlayPanel
*/
2023-03-01 10:19:01 +00:00
toggle(event: Event, target?: any): void;
2022-09-06 12:03:37 +00:00
/**
* Shows the overlay.
* @param {Event} event - Browser event.
* @param {*} [target] - Optional target if event.currentTarget should not be used.
*
* @memberof OverlayPanel
*/
2023-03-01 10:19:01 +00:00
show(event: Event, target?: any): void;
2022-09-06 12:03:37 +00:00
/**
* Hides the overlay.
*
* @memberof OverlayPanel
*/
2023-03-01 10:19:01 +00:00
hide(): void;
2022-09-06 12:03:37 +00:00
}
/**
* @deprecated since v4. Use Popover component instead.
*
* **PrimeVue - OverlayPanel**
*
* _OverlayPanel, also known as Popover, is a container component that can overlay other components on page._
*
* [Live Demo](https://www.primevue.org/popover/)
* --- ---
* ![PrimeVue](https://primefaces.org/cdn/primevue/images/logo-100.png)
*
* @group Component
*
*/
declare const OverlayPanel: DefineComponent<OverlayPanelProps, OverlayPanelSlots, OverlayPanelEmits, OverlayPanelMethods>;
declare module 'vue' {
export interface GlobalComponents {
OverlayPanel: DefineComponent<OverlayPanelProps, OverlayPanelSlots, OverlayPanelEmits, OverlayPanelMethods>;
2022-09-06 12:03:37 +00:00
}
}
export default OverlayPanel;