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

/**
 *
 * ScrollAreaHandle is the draggable handle element inside a scrollbar.
 *
 * @module scrollareahandle
 *
 */
import type { DefineComponent, DesignToken, EmitFn, PassThrough } from '@primevue/core';
import type { ComponentHooks } from '@primevue/core/basecomponent';
import type { PassThroughOptions } from 'primevue/passthrough';
import { Component, VNode } from 'vue';

/**
 * Custom passthrough(pt) option value type used across ScrollAreaHandle passthrough slots.
 */
export declare type ScrollAreaHandlePassThroughOptionType = ScrollAreaHandlePassThroughAttributes | ((options: ScrollAreaHandlePassThroughMethodOptions) => ScrollAreaHandlePassThroughAttributes | string) | string | null | undefined;

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

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

/**
 * Defines valid properties in ScrollAreaHandle component.
 */
export interface ScrollAreaHandleProps {
    /**
     * The element or component used to render the root.
     * @defaultValue 'DIV'
     */
    as?: string | Component | undefined;
    /**
     * When enabled, root element renders without its own DOM; consumer renders via slot using `a11yAttrs`.
     * @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 {ScrollAreaHandlePassThroughOptions}
     */
    pt?: PassThrough<ScrollAreaHandlePassThroughOptions>;
    /**
     * 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;
}

/**
 * Defines valid slots in ScrollAreaHandle component.
 */
export interface ScrollAreaHandleSlots {
    /**
     * Custom content slot.
     * @param {Object} scope - default slot props.
     */
    default: (scope: {
        /**
         * Accessibility attributes that should be spread onto the consumer-rendered root when `asChild` is enabled.
         */
        a11yAttrs: Record<string, unknown>;
        /**
         * Root element class produced by the component's `cx('root')` helper.
         */
        class: any;
    }) => VNode[];
}

/**
 * Defines valid emits in ScrollAreaHandle component.
 */
export interface ScrollAreaHandleEmitsOptions {}

/**
 * Defines the emit function type for ScrollAreaHandle.
 */
export declare type ScrollAreaHandleEmits = EmitFn<ScrollAreaHandleEmitsOptions>;

declare const ScrollAreaHandle: DefineComponent<ScrollAreaHandleProps, ScrollAreaHandleSlots, ScrollAreaHandleEmits>;

declare module 'vue' {
    export interface GlobalComponents {
        ScrollAreaHandle: DefineComponent<ScrollAreaHandleProps, ScrollAreaHandleSlots, ScrollAreaHandleEmits>;
    }
}

export default ScrollAreaHandle;