primevue/galleryzoomin/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

/**
 *
 * GalleryZoomIn dispatches the `zoom-in` action to the active item. The button is automatically disabled
 * while the active item is already zoomed.
 *
 * [Live Demo](https://www.primevue.dev/gallery/)
 *
 * @module galleryzoomin
 *
 */
import type { DefineComponent, DesignToken, EmitFn, PassThrough } from '@primevue/core';
import type { ComponentHooks } from '@primevue/core/basecomponent';
import type { PassThroughOptions } from 'primevue/passthrough';
import type { ButtonHTMLAttributes, Component, VNode } from 'vue';

export declare type GalleryZoomInPassThroughOptionType = GalleryZoomInPassThroughAttributes | ((options: GalleryZoomInPassThroughMethodOptions) => GalleryZoomInPassThroughAttributes | string) | string | null | undefined;

/**
 * Custom passthrough(pt) option method.
 */
export interface GalleryZoomInPassThroughMethodOptions {
    /**
     * Defines instance.
     */
    instance: any;
    /**
     * Defines valid properties.
     */
    props: GalleryZoomInProps;
    /**
     * 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 GalleryZoomInProps.pt}
 */
export interface GalleryZoomInPassThroughOptions {
    /**
     * Used to pass attributes to the root's DOM element.
     */
    root?: GalleryZoomInPassThroughOptionType;
    /**
     * Used to manage all lifecycle hooks.
     */
    hooks?: ComponentHooks;
}

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

/**
 * Defines valid properties in GalleryZoomIn component.
 */
export interface GalleryZoomInProps {
    /**
     * Use to change the HTML tag of root element.
     * @defaultValue BUTTON
     */
    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<GalleryZoomInPassThroughOptions>;
    /**
     * 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;
}

/**
 * Root element attributes forwarded to the consumer when `asChild` is enabled.
 */
export interface GalleryZoomInA11yAttrs extends ButtonHTMLAttributes {
    /**
     * Marker attribute used by Gallery to identify the dispatched action.
     */
    'data-action': 'zoom-in';
    /**
     * Disabled when the active item is already zoomed.
     */
    disabled?: boolean;
    /**
     * Click handler that dispatches the `zoom-in` action to the active item.
     */
    onClick: (event: MouseEvent) => void;
}

/**
 * Defines valid slots in GalleryZoomIn component.
 */
export interface GalleryZoomInSlots {
    /**
     * Custom content template. Receives scope props when `asChild` is enabled.
     * @param {Object} scope - default slot's params.
     */
    default(scope: {
        /**
         * Computed class name for the button root.
         */
        class: string | object | Array<string | object>;
        /**
         * Click handler to spread on the consumer's root element.
         */
        onClick: (event: MouseEvent) => void;
        /**
         * Disabled state — true when the active item is already zoomed.
         */
        disabled: boolean;
    }): VNode[];
}

/**
 * Defines valid emits in GalleryZoomIn component.
 */
export interface GalleryZoomInEmitsOptions {}

export declare type GalleryZoomInEmits = EmitFn<GalleryZoomInEmitsOptions>;

/**
 * **PrimeVue - GalleryZoomIn**
 *
 * _GalleryZoomIn 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 GalleryZoomIn: DefineComponent<GalleryZoomInProps, GalleryZoomInSlots, GalleryZoomInEmits>;

declare module 'vue' {
    export interface GlobalComponents {
        GalleryZoomIn: DefineComponent<GalleryZoomInProps, GalleryZoomInSlots, GalleryZoomInEmits>;
    }
}

export default GalleryZoomIn;