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

/**
 *
 * CarouselIndicators is a helper component for Carousel component.
 *
 * [Live Demo](https://www.primevue.dev/carousel/)
 *
 * @module carouselindicators
 *
 */
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 CarouselIndicatorsPassThroughOptionType = CarouselIndicatorsPassThroughAttributes | ((options: CarouselIndicatorsPassThroughMethodOptions) => CarouselIndicatorsPassThroughAttributes | string) | string | null | undefined;

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

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

/**
 * Defines valid properties in CarouselIndicators component.
 */
export interface CarouselIndicatorsProps {
    /**
     * 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 {CarouselIndicatorsPassThroughOptions}
     */
    pt?: PassThrough<CarouselIndicatorsPassThroughOptions>;
    /**
     * 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 CarouselIndicatorsA11yAttrs extends HTMLAttributes {
    /**
     * PrimeVue component identifier.
     */
    'data-pc-name': 'carouselindicators';
    /**
     * PrimeVue section identifier within the component.
     */
    'data-pc-section': 'root';
    /**
     * Current orientation of the parent carousel.
     */
    'data-orientation'?: 'horizontal' | 'vertical';
    /**
     * Current alignment of the parent carousel.
     */
    'data-align'?: 'start' | 'center' | 'end';
    /**
     * Current page of the parent carousel.
     */
    'data-page'?: number;
    /**
     * Indicates whether a swipe gesture is in progress.
     */
    'data-swiping'?: '' | undefined;
    /**
     * Keyboard handler delegated to the parent carousel for roving focus.
     */
    onKeydown?: (event: KeyboardEvent) => void;
}

/**
 * Defines valid slots in CarouselIndicators component.
 */
export interface CarouselIndicatorsSlots {
    /**
     * Custom content template. Receives `pageCount` for custom indicator rendering,
     * and `class` + `a11yAttrs` when `asChild` is enabled.
     * @param {Object} scope - default slot's params.
     */
    default(scope: {
        /**
         * Computed class name for the indicators root.
         */
        class: string | object | Array<string | object>;
        /**
         * Attributes to spread on the consumer's root element. Available when `asChild` is enabled.
         */
        a11yAttrs: CarouselIndicatorsA11yAttrs;
        /**
         * Total number of pages derived from the parent carousel's snap points.
         */
        pageCount: number;
    }): VNode[];
}

/**
 * Defines valid emits in CarouselIndicators component.
 */
export interface CarouselIndicatorsEmitsOptions {}

export declare type CarouselIndicatorsEmits = EmitFn<CarouselIndicatorsEmitsOptions>;

/**
 * **PrimeVue - CarouselIndicators**
 *
 * _CarouselIndicators is a helper component for Carousel component._
 *
 * [Live Demo](https://www.primevue.dev/carousel/)
 * --- ---
 * ![PrimeVue](https://primefaces.org/cdn/primevue/images/logo-100.png)
 *
 * @group Component
 *
 */
declare const CarouselIndicators: DefineComponent<CarouselIndicatorsProps, CarouselIndicatorsSlots, CarouselIndicatorsEmits>;

declare module 'vue' {
    export interface GlobalComponents {
        CarouselIndicators: DefineComponent<CarouselIndicatorsProps, CarouselIndicatorsSlots, CarouselIndicatorsEmits>;
    }
}

export default CarouselIndicators;