BlockUI .d.ts. updated

pull/3689/head
Tuğçe Küçükoğlu 2023-03-01 16:00:49 +03:00
parent 0219a4e714
commit df5a35a277
1 changed files with 36 additions and 7 deletions

View File

@ -1,6 +1,18 @@
/**
*
* BlockUI represents people using icons, labels and images.
*
* [Live Demo](https://www.primevue.org/blockui)
*
* @module blockui
*
*/
import { VNode } from 'vue'; import { VNode } from 'vue';
import { ClassComponent, GlobalComponentConstructor } from '../ts-helpers'; import { ClassComponent, GlobalComponentConstructor } from '../ts-helpers';
/**
* Defines valid properties in BlockUI component
*/
export interface BlockUIProps { export interface BlockUIProps {
/** /**
* Controls the blocked state. * Controls the blocked state.
@ -12,34 +24,51 @@ export interface BlockUIProps {
fullScreen?: boolean | undefined; fullScreen?: boolean | undefined;
/** /**
* Base zIndex value to use in layering. * Base zIndex value to use in layering.
* Default value is 0. * @defaultValue 0
*/ */
baseZIndex?: number | undefined; baseZIndex?: number | undefined;
/** /**
* Whether to automatically manage layering. * Whether to automatically manage layering.
* Default value is true. * @defaultValue true
*/ */
autoZIndex?: boolean | undefined; autoZIndex?: boolean | undefined;
} }
/**
* Defines valid slots in BlockUI component
*/
export interface BlockUISlots { export interface BlockUISlots {
/** /**
* Custom content's slot. * Custom content's slot.
*/ */
default: () => VNode[]; default(): VNode[];
} }
export declare type BlockUIEmits = { /**
* Defines valid emits in BlockUI component
*/
export interface BlockUIEmits {
/** /**
* Fired when the element gets blocked. * Fired when the element gets blocked.
*/ */
block: () => void; block(): void;
/** /**
* Fired when the element gets unblocked. * Fired when the element gets unblocked.
*/ */
unblock: () => void; unblock(): void;
}; }
/**
* **PrimeVue - BlockUI**
*
* _BlockUI represents people using icons, labels and images._
*
* [Live Demo](https://www.primevue.org/blockui/)
* --- ---
* ![PrimeVue](https://primefaces.org/cdn/primevue/images/logo-100.png)
*
* @group Component
*/
declare class BlockUI extends ClassComponent<BlockUIProps, BlockUISlots, BlockUIEmits> {} declare class BlockUI extends ClassComponent<BlockUIProps, BlockUISlots, BlockUIEmits> {}
declare module '@vue/runtime-core' { declare module '@vue/runtime-core' {