accessibleprimevue/portal/Portal.d.ts

Note: This is the forked version of the Primefaces/PrimeVue repository. Since V3 has reached its EOL this is use to fix identified accessibility bugs in the v3 version of primevue. PrimeVue is an open source UI library for Vue featuring a rich set of 80+

import { VNode } from 'vue';
import { ClassComponent, 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[];
}

export declare type PortalEmits = {};

declare class Portal extends ClassComponent<PortalProps, PortalSlots, PortalEmits> {}

declare module 'vue' {
    export interface GlobalComponents {
        Portal: GlobalComponentConstructor<Portal>;
    }
}

export default Portal;