/**
 *
 * CompareHandle displays the draggable divider of a Compare component.
 *
 * [Live Demo](https://www.primevue.dev/compare/)
 *
 * @module comparehandle
 *
 */
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 CompareHandlePassThroughOptionType = CompareHandlePassThroughAttributes | ((options: CompareHandlePassThroughMethodOptions) => CompareHandlePassThroughAttributes | string) | string | null | undefined;

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

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

/**
 * Defines valid properties in CompareHandle component.
 */
export interface CompareHandleProps {
    /**
     * Use to change the HTML tag of root element.
     * @defaultValue SPAN
     */
    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 {CompareHandlePassThroughOptions}
     */
    pt?: PassThrough<CompareHandlePassThroughOptions>;
    /**
     * 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 CompareHandleA11yAttrs extends HTMLAttributes {
    /**
     * The handle is removed from the focus order; focus is delegated to the hidden input inside CompareIndicator.
     */
    tabindex: -1;
}

/**
 * Defines valid slots in CompareHandle component.
 */
export interface CompareHandleSlots {
    /**
     * Default slot, place the handle's visual content (typically a CompareIndicator) 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: CompareHandleA11yAttrs;
    }): VNode[];
}

/**
 * Defines valid emits in CompareHandle component.
 */
export interface CompareHandleEmitsOptions {}

export declare type CompareHandleEmits = EmitFn<CompareHandleEmitsOptions>;

/**
 * **PrimeVue - CompareHandle**
 *
 * _CompareHandle displays the draggable divider 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 CompareHandle: DefineComponent<CompareHandleProps, CompareHandleSlots, CompareHandleEmits>;

declare module 'vue' {
    export interface GlobalComponents {
        CompareHandle: DefineComponent<CompareHandleProps, CompareHandleSlots, CompareHandleEmits>;
    }
}

export default CompareHandle;