@yamada-ui/carousel 1.0.28 → 2.0.0-next-20240513035416

package/dist/carousel-slide.mjs.map

@@ -0,0 +1 @@
+{"version":3,"sources":[],"sourcesContent":[],"mappings":"","names":[]}

package/dist/carousel.d.mts

@@ -0,0 +1,144 @@
+import * as _yamada_ui_core from '@yamada-ui/core';
+import { ThemeProps, HTMLUIProps, Token, CSSUIProps } from '@yamada-ui/core';
+import { UseCarouselProps } from './use-carousel.mjs';
+import { CarouselControlProps } from './carousel-control.mjs';
+import { CarouselIndicatorsProps } from './carousel-indicators.mjs';
+import 'react';
+import '@yamada-ui/button';
+import 'embla-carousel-react';
+
+type CarouselOptions = {
+    /**
+     * The orientation of the carousel.
+     *
+     * @default 'horizontal'
+     */
+    orientation?: Token<"vertical" | "horizontal">;
+    /**
+     * The alignment of the carousel.
+     *
+     * @default 'center'
+     */
+    align?: Token<"start" | "center" | "end" | number>;
+    /**
+     * Clear leading and trailing empty space that causes excessive scrolling.
+     * Use trimSnaps to only use snap points that trigger scrolling or keepSnaps to keep them.
+     *
+     * @default ''
+     */
+    containScroll?: Token<"trimSnaps" | "keepSnaps" | "">;
+    /**
+     * The number of slides that should be scrolled with next or previous buttons.
+     *
+     * @default 1
+     */
+    slidesToScroll?: Token<number>;
+    /**
+     * If `true`, momentum scrolling will be enabled.
+     *
+     * @default false
+     */
+    dragFree?: Token<boolean>;
+    /**
+     * If `true`, carousel can be scrolled with mouse and touch interactions.
+     *
+     * @default true
+     */
+    draggable?: Token<boolean>;
+    /**
+     * Choose a fraction representing the percentage portion of a slide that needs to be visible in order to be considered in view.
+     *
+     * @default 0
+     */
+    inViewThreshold?: Token<number>;
+    /**
+     * If `true`, infinite looping.
+     * Automatically falls back to false if slide content isn't enough to loop.
+     *
+     * @default true
+     */
+    loop?: Token<boolean>;
+    /**
+     * If `true`, allow the carousel to skip scroll snaps if it's dragged vigorously.
+     * Note that this option will be ignored if the dragFree option is set to true.
+     *
+     * @default false
+     */
+    skipSnaps?: Token<boolean>;
+    /**
+     * Adjusts scroll speed when triggered by any of the methods.
+     * Higher numbers enables faster scrolling.
+     *
+     * @default 10
+     */
+    speed?: Token<number>;
+    /**
+     * The number for the autoplay interval of the carousel.
+     *
+     * @default 4000
+     */
+    delay?: Token<number>;
+    /**
+     * If `true`, the carousel will be autoplay.
+     *
+     * @default false
+     */
+    autoplay?: Token<boolean>;
+    /**
+     * If `true`, autoplay will pause when the mouse entries over.
+     *
+     * @default true
+     */
+    stopMouseEnterAutoplay?: Token<boolean>;
+    /**
+     * If `true`, gap will be treated as part of the carousel slide size.
+     *
+     * @default true
+     */
+    includeGapInSize?: Token<boolean>;
+    /**
+     * The CSS `width` property.
+     */
+    slideSize?: CSSUIProps["width"];
+    /**
+     * Props for carousel inner element.
+     */
+    innerProps?: HTMLUIProps<"div">;
+    /**
+     * If `true`, display the carousel control buttons.
+     *
+     * @default true
+     */
+    withControls?: Token<boolean>;
+    /**
+     * Props for carousel control element.
+     */
+    controlProps?: CarouselControlProps;
+    /**
+     * Props for previous of the carousel control element.
+     */
+    controlPrevProps?: CarouselControlProps;
+    /**
+     * Props for next of the carousel control element.
+     */
+    controlNextProps?: CarouselControlProps;
+    /**
+     * If `true`, display the carousel indicator buttons.
+     *
+     * @default true
+     */
+    withIndicators?: Token<boolean>;
+    /**
+     * Props for carousel indicators element.
+     */
+    indicatorsProps?: CarouselIndicatorsProps;
+};
+type CarouselProps = ThemeProps<"Carousel"> & Omit<HTMLUIProps<"div">, "onChange" | "draggable"> & Pick<UseCarouselProps, "index" | "defaultIndex" | "onChange" | "onScrollProgress"> & CarouselOptions;
+/**
+ * `Carousel` is a component that displays multiple elements like a slideshow.
+ *
+ * @see Docs https://yamada-ui.com/components/data-display/carousel
+ */
+declare const Carousel: _yamada_ui_core.Component<"div", CarouselProps>;
+
+export { Carousel, type CarouselProps };

package/dist/carousel.d.ts

@@ -0,0 +1,144 @@
+import * as _yamada_ui_core from '@yamada-ui/core';
+import { ThemeProps, HTMLUIProps, Token, CSSUIProps } from '@yamada-ui/core';
+import { UseCarouselProps } from './use-carousel.js';
+import { CarouselControlProps } from './carousel-control.js';
+import { CarouselIndicatorsProps } from './carousel-indicators.js';
+import 'react';
+import '@yamada-ui/button';
+import 'embla-carousel-react';
+
+type CarouselOptions = {
+    /**
+     * The orientation of the carousel.
+     *
+     * @default 'horizontal'
+     */
+    orientation?: Token<"vertical" | "horizontal">;
+    /**
+     * The alignment of the carousel.
+     *
+     * @default 'center'
+     */
+    align?: Token<"start" | "center" | "end" | number>;
+    /**
+     * Clear leading and trailing empty space that causes excessive scrolling.
+     * Use trimSnaps to only use snap points that trigger scrolling or keepSnaps to keep them.
+     *
+     * @default ''
+     */
+    containScroll?: Token<"trimSnaps" | "keepSnaps" | "">;
+    /**
+     * The number of slides that should be scrolled with next or previous buttons.
+     *
+     * @default 1
+     */
+    slidesToScroll?: Token<number>;
+    /**
+     * If `true`, momentum scrolling will be enabled.
+     *
+     * @default false
+     */
+    dragFree?: Token<boolean>;
+    /**
+     * If `true`, carousel can be scrolled with mouse and touch interactions.
+     *
+     * @default true
+     */
+    draggable?: Token<boolean>;
+    /**
+     * Choose a fraction representing the percentage portion of a slide that needs to be visible in order to be considered in view.
+     *
+     * @default 0
+     */
+    inViewThreshold?: Token<number>;
+    /**
+     * If `true`, infinite looping.
+     * Automatically falls back to false if slide content isn't enough to loop.
+     *
+     * @default true
+     */
+    loop?: Token<boolean>;
+    /**
+     * If `true`, allow the carousel to skip scroll snaps if it's dragged vigorously.
+     * Note that this option will be ignored if the dragFree option is set to true.
+     *
+     * @default false
+     */
+    skipSnaps?: Token<boolean>;
+    /**
+     * Adjusts scroll speed when triggered by any of the methods.
+     * Higher numbers enables faster scrolling.
+     *
+     * @default 10
+     */
+    speed?: Token<number>;
+    /**
+     * The number for the autoplay interval of the carousel.
+     *
+     * @default 4000
+     */
+    delay?: Token<number>;
+    /**
+     * If `true`, the carousel will be autoplay.
+     *
+     * @default false
+     */
+    autoplay?: Token<boolean>;
+    /**
+     * If `true`, autoplay will pause when the mouse entries over.
+     *
+     * @default true
+     */
+    stopMouseEnterAutoplay?: Token<boolean>;
+    /**
+     * If `true`, gap will be treated as part of the carousel slide size.
+     *
+     * @default true
+     */
+    includeGapInSize?: Token<boolean>;
+    /**
+     * The CSS `width` property.
+     */
+    slideSize?: CSSUIProps["width"];
+    /**
+     * Props for carousel inner element.
+     */
+    innerProps?: HTMLUIProps<"div">;
+    /**
+     * If `true`, display the carousel control buttons.
+     *
+     * @default true
+     */
+    withControls?: Token<boolean>;
+    /**
+     * Props for carousel control element.
+     */
+    controlProps?: CarouselControlProps;
+    /**
+     * Props for previous of the carousel control element.
+     */
+    controlPrevProps?: CarouselControlProps;
+    /**
+     * Props for next of the carousel control element.
+     */
+    controlNextProps?: CarouselControlProps;
+    /**
+     * If `true`, display the carousel indicator buttons.
+     *
+     * @default true
+     */
+    withIndicators?: Token<boolean>;
+    /**
+     * Props for carousel indicators element.
+     */
+    indicatorsProps?: CarouselIndicatorsProps;
+};
+type CarouselProps = ThemeProps<"Carousel"> & Omit<HTMLUIProps<"div">, "onChange" | "draggable"> & Pick<UseCarouselProps, "index" | "defaultIndex" | "onChange" | "onScrollProgress"> & CarouselOptions;
+/**
+ * `Carousel` is a component that displays multiple elements like a slideshow.
+ *
+ * @see Docs https://yamada-ui.com/components/data-display/carousel
+ */
+declare const Carousel: _yamada_ui_core.Component<"div", CarouselProps>;
+
+export { Carousel, type CarouselProps };