primevue-mirror/components/lib/portal/Portal.d.ts

40 lines
1.1 KiB
TypeScript

import { VNode } from 'vue';
import { DefineComponent, EmitFn, GlobalComponentConstructor, HintedString } from '../ts-helpers';
type PortalAppendToType = HintedString<'body' | 'self'> | undefined | HTMLElement;
export interface PortalProps {
/**
* A valid query selector or an HTMLElement to specify where the dialog gets attached. Special keywords are 'body' for document body and 'self' for the element itself.
* @see PortalAppendToType
* Default value is 'body'.
*/
appendTo?: PortalAppendToType;
/**
* If disabled, the Portal feature is eliminated and the content is displayed directly.
* @defaultValue false
*/
disabled?: boolean | undefined;
}
export interface PortalSlots {
/**
* Default content slot.
*/
default: () => VNode[];
}
declare type PortalEmitsOptions = {};
export declare type PortalEmits = EmitFn<PortalEmitsOptions>;
declare const Portal: DefineComponent<PortalProps, PortalSlots, PortalEmits>;
declare module 'vue' {
export interface GlobalComponents {
Portal: GlobalComponentConstructor<PortalProps, PortalSlots, PortalEmits>;
}
}
export default Portal;