package.dist.components.carousel.use-carousel.d.cts Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of react Show documentation

A collection of unstyled, accessible UI components for React, utilizing state machines for seamless interaction.

The newest version!

import { PropTypes } from '@zag-js/react';
import { Optional } from '../../types';
import * as carousel from '@zag-js/carousel';
export interface UseCarouselProps extends Optional, 'id'> {
    /**
     * The initial index of the carousel when it is first rendered.
     * Use this when you do not need to control the state of the carousel.
     */
    defaultIndex?: carousel.Context['index'];
}
export interface UseCarouselReturn extends carousel.Api {
}
export declare const useCarousel: (props?: UseCarouselProps) => UseCarouselReturn;