diff --git a/src/components/blockui/BlockUI.d.ts b/src/components/blockui/BlockUI.d.ts index eb2652069..2e5654ca7 100755 --- a/src/components/blockui/BlockUI.d.ts +++ b/src/components/blockui/BlockUI.d.ts @@ -1,19 +1,60 @@ import { VNode } from 'vue'; +import { ClassComponent, GlobalComponentConstructor } from '../ts-helpers'; -interface BlockUIProps { - blocked?: boolean; - fullScreen?: boolean; - baseZIndex?: number; - autoZIndex?: boolean; +export interface BlockUIProps { + /** + * Controls the blocked state. + */ + blocked?: boolean | undefined; + /** + * When enabled, the whole document gets blocked. + */ + fullScreen?: boolean | undefined; + /** + * Base zIndex value to use in layering. + * Default value is 0. + */ + baseZIndex?: number | undefined; + /** + * Whether to automatically manage layering. + * Default value is true. + */ + autoZIndex?: boolean | undefined; } -declare class BlockUI { - $props: BlockUIProps; - $emit(eventName: 'block'): this; - $emit(eventName: 'unblock'): this; - $slots: { - '': VNode[]; +export interface BlockUISlots { + /** + * Custom content's slot. + */ + default: () => VNode[]; +} + +export declare type BlockUIEmits = { + /** + * Fired when the element gets blocked. + */ + 'block': () => void; + /** + * Fired when the element gets unblocked. + */ + 'unblock': () => void; +} + +declare class BlockUI extends ClassComponent { } + +declare module '@vue/runtime-core' { + interface GlobalComponents { + BlockUI: GlobalComponentConstructor } } +/** + * + * BlockUI can either block other components or the whole page. + * + * Demos: + * + * - [BlockUI](https://www.primefaces.org/primevue/showcase/#/blockui) + * + */ export default BlockUI;