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

/**
 *
 * CompareItem displays one layer of a Compare component.
 *
 * [Live Demo](https://www.primevue.dev/compare/)
 *
 * @module compareitem
 *
 */
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, HTMLAttributes, VNode } from 'vue';

export declare type CompareItemPassThroughOptionType = CompareItemPassThroughAttributes | ((options: CompareItemPassThroughMethodOptions) => CompareItemPassThroughAttributes | string) | string | null | undefined;

/**
 * Custom passthrough(pt) option method.
 */
export interface CompareItemPassThroughMethodOptions {
    /**
     * Defines instance.
     */
    instance: any;
    /**
     * Defines valid properties.
     */
    props: CompareItemProps;
    /**
     * 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 CompareItemProps.pt}
 */
export interface CompareItemPassThroughOptions {
    /**
     * Used to pass attributes to the root's DOM element.
     */
    root?: CompareItemPassThroughOptionType;
    /**
     * Used to manage all lifecycle hooks.
     * @see {@link BaseComponent.ComponentHooks}
     */
    hooks?: ComponentHooks;
}

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

/**
 * Defines valid properties in CompareItem component.
 */
export interface CompareItemProps {
    /**
     * Whether the item is before or after the handle.
     * @defaultValue before
     */
    position?: 'before' | 'after' | undefined;
    /**
     * 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.
     * @type {CompareItemPassThroughOptions}
     */
    pt?: PassThrough<CompareItemPassThroughOptions>;
    /**
     * Used to configure passthrough(pt) options of the component.
     * @type {PassThroughOptions}
     */
    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 CompareItemA11yAttrs extends HTMLAttributes {
    /**
     * Whether the item is the before or after layer relative to the handle.
     */
    'data-position': 'before' | 'after';
}

/**
 * Defines valid slots in CompareItem component.
 */
export interface CompareItemSlots {
    /**
     * Default slot, place the item's visual content (typically an image or SVG layer) here.
     * Receives scope props when `asChild` is enabled.
     * @param {Object} scope - default slot's params.
     */
    default(scope: {
        /**
         * Computed class name for the root.
         */
        class: string | object | Array<string | object>;
        /**
         * Attributes to spread on the consumer's root element.
         */
        a11yAttrs: CompareItemA11yAttrs;
    }): VNode[];
}

/**
 * Defines valid emits in CompareItem component.
 */
export interface CompareItemEmitsOptions {}

export declare type CompareItemEmits = EmitFn<CompareItemEmitsOptions>;

/**
 * **PrimeVue - CompareItem**
 *
 * _CompareItem displays one layer of a Compare component._
 *
 * [Live Demo](https://www.primevue.dev/compare/)
 * --- ---
 * ![PrimeVue](https://primefaces.org/cdn/primevue/images/logo-100.png)
 *
 * @group Component
 *
 */
declare const CompareItem: DefineComponent<CompareItemProps, CompareItemSlots, CompareItemEmits>;

declare module 'vue' {
    export interface GlobalComponents {
        CompareItem: DefineComponent<CompareItemProps, CompareItemSlots, CompareItemEmits>;
    }
}

export default CompareItem;