primevue/gallerybackdrop/index.d.ts

PrimeVue is a premium UI library for Vue featuring a rich set of 90+ components, a theme designer, various theme alternatives such as Material, Bootstrap, Tailwind, premium templates and professional support. In addition, it integrates with PrimeBlock, wh

/**
 *
 * GalleryBackdrop renders the dimmed layer behind the active item, typically used to focus attention on the gallery content.
 *
 * [Live Demo](https://www.primevue.dev/gallery/)
 *
 * @module gallerybackdrop
 *
 */
import type { DefineComponent, DesignToken, EmitFn, PassThrough } from '@primevue/core';
import type { ComponentHooks } from '@primevue/core/basecomponent';
import type { PassThroughOptions } from 'primevue/passthrough';
import type { Component, VNode } from 'vue';

export declare type GalleryBackdropPassThroughOptionType = GalleryBackdropPassThroughAttributes | ((options: GalleryBackdropPassThroughMethodOptions) => GalleryBackdropPassThroughAttributes | string) | string | null | undefined;

/**
 * Custom passthrough(pt) option method.
 */
export interface GalleryBackdropPassThroughMethodOptions {
    /**
     * Defines instance.
     */
    instance: any;
    /**
     * Defines valid properties.
     */
    props: GalleryBackdropProps;
    /**
     * Defines valid attributes.
     */
    attrs: any;
    /**
     * Defines parent options.
     */
    parent: any;
    /**
     * Defines passthrough(pt) options in global config.
     */
    global: object | undefined;
}

/**
 * Custom passthrough(pt) options.
 * @see {@link GalleryBackdropProps.pt}
 */
export interface GalleryBackdropPassThroughOptions {
    /**
     * Used to pass attributes to the root's DOM element.
     */
    root?: GalleryBackdropPassThroughOptionType;
    /**
     * Used to manage all lifecycle hooks.
     * @see {@link BaseComponent.ComponentHooks}
     */
    hooks?: ComponentHooks;
}

/**
 * Custom passthrough attributes for each DOM elements.
 */
export interface GalleryBackdropPassThroughAttributes {
    [key: string]: any;
}

/**
 * Defines valid properties in GalleryBackdrop component.
 */
export interface GalleryBackdropProps {
    /**
     * Use to change the HTML tag of root element.
     * @defaultValue DIV
     */
    as?: string | Component | undefined;
    /**
     * When enabled, it changes the default rendered element for the one passed as a child element.
     * @defaultValue false
     */
    asChild?: boolean | undefined;
    /**
     * It generates scoped CSS variables using design tokens for the component.
     */
    dt?: DesignToken<any>;
    /**
     * Used to pass attributes to DOM elements inside the component.
     */
    pt?: PassThrough<GalleryBackdropPassThroughOptions>;
    /**
     * Used to configure passthrough(pt) options of the component.
     */
    ptOptions?: PassThroughOptions;
    /**
     * When enabled, it removes component related styles in the core.
     * @defaultValue false
     */
    unstyled?: boolean;
}

/**
 * Defines valid slots in GalleryBackdrop component.
 */
export interface GalleryBackdropSlots {
    /**
     * Default content slot.
     */
    default(): VNode[];
}

/**
 * Defines valid emits in GalleryBackdrop component.
 */
export interface GalleryBackdropEmitsOptions {}

export declare type GalleryBackdropEmits = EmitFn<GalleryBackdropEmitsOptions>;

/**
 * **PrimeVue - GalleryBackdrop**
 *
 * _GalleryBackdrop is a helper component for Gallery component._
 *
 * [Live Demo](https://www.primevue.dev/gallery/)
 * --- ---
 * ![PrimeVue](https://primefaces.org/cdn/primevue/images/logo-100.png)
 *
 * @group Component
 *
 */
declare const GalleryBackdrop: DefineComponent<GalleryBackdropProps, GalleryBackdropSlots, GalleryBackdropEmits>;

declare module 'vue' {
    export interface GlobalComponents {
        GalleryBackdrop: DefineComponent<GalleryBackdropProps, GalleryBackdropSlots, GalleryBackdropEmits>;
    }
}

export default GalleryBackdrop;