@nuxt/ui 3.0.2 → 3.1.0

package/dist/runtime/components/Carousel.vue

@@ -1,270 +1,148 @@
-<!-- eslint-disable vue/block-tag-newline -->
-<script lang="ts">
-import type { VariantProps } from 'tailwind-variants'
-import type { AppConfig } from '@nuxt/schema'
-import type { AcceptableValue } from 'reka-ui'
-import type { EmblaCarouselType, EmblaOptionsType, EmblaPluginType } from 'embla-carousel'
-import type { AutoplayOptionsType } from 'embla-carousel-autoplay'
-import type { AutoScrollOptionsType } from 'embla-carousel-auto-scroll'
-import type { AutoHeightOptionsType } from 'embla-carousel-auto-height'
-import type { ClassNamesOptionsType } from 'embla-carousel-class-names'
-import type { FadeOptionsType } from 'embla-carousel-fade'
-import type { WheelGesturesPluginOptions } from 'embla-carousel-wheel-gestures'
-import _appConfig from '#build/app.config'
-import theme from '#build/ui/carousel'
-import { tv } from '../utils/tv'
-import type { ButtonProps } from '../types'
-import type { PartialString } from '../types/utils'
-
-const appConfigCarousel = _appConfig as AppConfig & { ui: { carousel: Partial<typeof theme> } }
-
-const carousel = tv({ extend: tv(theme), ...(appConfigCarousel.ui?.carousel || {}) })
-
-type CarouselVariants = VariantProps<typeof carousel>
-
-export type CarouselItem = AcceptableValue
-
-export interface CarouselProps<T extends CarouselItem = CarouselItem> extends Omit<EmblaOptionsType, 'axis' | 'container' | 'slides' | 'direction'> {
-  /**
-   * The element or component this component should render as.
-   * @defaultValue 'div'
-   */
-  as?: any
-  /**
-   * Configure the prev button when arrows are enabled.
-   * @defaultValue { size: 'md', color: 'neutral', variant: 'link' }
-   */
-  prev?: ButtonProps
-  /**
-   * The icon displayed in the prev button.
-   * @defaultValue appConfig.ui.icons.arrowLeft
-   * @IconifyIcon
-   */
-  prevIcon?: string
-  /**
-   * Configure the next button when arrows are enabled.
-   * @defaultValue { size: 'md', color: 'neutral', variant: 'link' }
-   */
-  next?: ButtonProps
-  /**
-   * The icon displayed in the next button.
-   * @defaultValue appConfig.ui.icons.arrowRight
-   * @IconifyIcon
-   */
-  nextIcon?: string
-  /**
-   * Display prev and next buttons to scroll the carousel.
-   * @defaultValue false
-   */
-  arrows?: boolean
-  /**
-   * Display dots to scroll to a specific slide.
-   * @defaultValue false
-   */
-  dots?: boolean
-  /**
-   * The orientation of the carousel.
-   * @defaultValue 'horizontal'
-   */
-  orientation?: CarouselVariants['orientation']
-  items?: T[]
-  /**
-   * Enable Autoplay plugin
-   * @link https://www.embla-carousel.com/plugins/autoplay/
-   */
-  autoplay?: boolean | AutoplayOptionsType
-  /**
-   * Enable Auto Scroll plugin
-   * @link https://www.embla-carousel.com/plugins/auto-scroll/
-   */
-  autoScroll?: boolean | AutoScrollOptionsType
-  /**
-   * Enable Auto Height plugin
-   * @link https://www.embla-carousel.com/plugins/auto-height/
-   */
-  autoHeight?: boolean | AutoHeightOptionsType
-  /**
-   * Enable Class Names plugin
-   * @link https://www.embla-carousel.com/plugins/class-names/
-   */
-  classNames?: boolean | ClassNamesOptionsType
-  /**
-   * Enable Fade plugin
-   * @link https://www.embla-carousel.com/plugins/fade/
-   */
-  fade?: boolean | FadeOptionsType
-  /**
-   * Enable Wheel Gestures plugin
-   * @link https://www.embla-carousel.com/plugins/wheel-gestures/
-   */
-  wheelGestures?: boolean | WheelGesturesPluginOptions
-  class?: any
-  ui?: PartialString<typeof carousel.slots>
-}
-
-export type CarouselSlots<T extends CarouselItem = CarouselItem> = {
-  default(props: { item: T, index: number }): any
-}
-
+<script>
+import theme from "#build/ui/carousel";
 </script>
 
-<script setup lang="ts" generic="T extends CarouselItem">
-import { computed, ref, watch, onMounted } from 'vue'
-import useEmblaCarousel from 'embla-carousel-vue'
-import { Primitive, useForwardProps } from 'reka-ui'
-import { reactivePick, computedAsync } from '@vueuse/core'
-import { useAppConfig } from '#imports'
-import { useLocale } from '../composables/useLocale'
-import UButton from './Button.vue'
-
-const props = withDefaults(defineProps<CarouselProps<T>>(), {
-  orientation: 'horizontal',
-  arrows: false,
-  dots: false,
-  // Embla Options
-  active: true,
-  align: 'center',
-  breakpoints: () => ({}),
-  containScroll: 'trimSnaps',
-  dragFree: false,
-  dragThreshold: 10,
-  duration: 25,
-  inViewThreshold: 0,
-  loop: false,
-  skipSnaps: false,
-  slidesToScroll: 1,
-  startIndex: 0,
-  watchDrag: true,
-  watchResize: true,
-  watchSlides: true,
-  watchFocus: true,
-  // Embla Plugins
-  autoplay: false,
-  autoScroll: false,
-  autoHeight: false,
-  classNames: false,
-  fade: false,
-  wheelGestures: false
-})
-defineSlots<CarouselSlots<T>>()
-
-const appConfig = useAppConfig()
-const { dir, t } = useLocale()
-const rootProps = useForwardProps(reactivePick(props, 'active', 'align', 'breakpoints', 'containScroll', 'dragFree', 'dragThreshold', 'duration', 'inViewThreshold', 'loop', 'skipSnaps', 'slidesToScroll', 'startIndex', 'watchDrag', 'watchResize', 'watchSlides', 'watchFocus'))
-
-const prevIcon = computed(() => props.prevIcon || (dir.value === 'rtl' ? appConfig.ui.icons.arrowRight : appConfig.ui.icons.arrowLeft))
-const nextIcon = computed(() => props.nextIcon || (dir.value === 'rtl' ? appConfig.ui.icons.arrowLeft : appConfig.ui.icons.arrowRight))
-
-const ui = computed(() => carousel({
+<script setup>
+import { computed, ref, watch, onMounted } from "vue";
+import useEmblaCarousel from "embla-carousel-vue";
+import { Primitive, useForwardProps } from "reka-ui";
+import { reactivePick, computedAsync } from "@vueuse/core";
+import { useAppConfig } from "#imports";
+import { useLocale } from "../composables/useLocale";
+import { tv } from "../utils/tv";
+import UButton from "./Button.vue";
+const props = defineProps({
+  as: { type: null, required: false },
+  prev: { type: Object, required: false },
+  prevIcon: { type: String, required: false },
+  next: { type: Object, required: false },
+  nextIcon: { type: String, required: false },
+  arrows: { type: Boolean, required: false, default: false },
+  dots: { type: Boolean, required: false, default: false },
+  orientation: { type: null, required: false, default: "horizontal" },
+  items: { type: Array, required: false },
+  autoplay: { type: [Boolean, Object], required: false, default: false },
+  autoScroll: { type: [Boolean, Object], required: false, default: false },
+  autoHeight: { type: [Boolean, Object], required: false, default: false },
+  classNames: { type: [Boolean, Object], required: false, default: false },
+  fade: { type: [Boolean, Object], required: false, default: false },
+  wheelGestures: { type: Boolean, required: false, skipCheck: true, default: false },
+  class: { type: null, required: false },
+  ui: { type: null, required: false },
+  align: { type: [String, Function], required: false, default: "center" },
+  containScroll: { type: [Boolean, String], required: false, default: "trimSnaps" },
+  slidesToScroll: { type: [String, Number], required: false, default: 1 },
+  dragFree: { type: Boolean, required: false, default: false },
+  dragThreshold: { type: Number, required: false, default: 10 },
+  inViewThreshold: { type: null, required: false, default: 0 },
+  loop: { type: Boolean, required: false, default: false },
+  skipSnaps: { type: Boolean, required: false, default: false },
+  duration: { type: Number, required: false, default: 25 },
+  startIndex: { type: Number, required: false, default: 0 },
+  watchDrag: { type: [Boolean, Function], required: false, default: true },
+  watchResize: { type: [Boolean, Function], required: false, default: true },
+  watchSlides: { type: [Boolean, Function], required: false, default: true },
+  watchFocus: { type: [Boolean, Function], required: false, default: true },
+  active: { type: Boolean, required: false, default: true },
+  breakpoints: { type: Object, required: false, default: () => ({}) }
+});
+defineSlots();
+const emits = defineEmits(["select"]);
+const { dir, t } = useLocale();
+const appConfig = useAppConfig();
+const rootProps = useForwardProps(reactivePick(props, "active", "align", "breakpoints", "containScroll", "dragFree", "dragThreshold", "duration", "inViewThreshold", "loop", "skipSnaps", "slidesToScroll", "startIndex", "watchDrag", "watchResize", "watchSlides", "watchFocus"));
+const prevIcon = computed(() => props.prevIcon || (dir.value === "rtl" ? appConfig.ui.icons.arrowRight : appConfig.ui.icons.arrowLeft));
+const nextIcon = computed(() => props.nextIcon || (dir.value === "rtl" ? appConfig.ui.icons.arrowLeft : appConfig.ui.icons.arrowRight));
+const ui = computed(() => tv({ extend: tv(theme), ...appConfig.ui?.carousel || {} })({
   orientation: props.orientation
-}))
-
-const options = computed<EmblaOptionsType>(() => ({
-  ...(props.fade ? { align: 'center', containScroll: false } : {}),
+}));
+const options = computed(() => ({
+  ...props.fade ? { align: "center", containScroll: false } : {},
   ...rootProps.value,
-  axis: props.orientation === 'horizontal' ? 'x' : 'y',
-  direction: dir.value === 'rtl' ? 'rtl' : 'ltr'
-}))
-
-const plugins = computedAsync<EmblaPluginType[]>(async () => {
-  const plugins = []
-
+  axis: props.orientation === "horizontal" ? "x" : "y",
+  direction: dir.value === "rtl" ? "rtl" : "ltr"
+}));
+const plugins = computedAsync(async () => {
+  const plugins2 = [];
   if (props.autoplay) {
-    const AutoplayPlugin = await import('embla-carousel-autoplay').then(r => r.default)
-    plugins.push(AutoplayPlugin(typeof props.autoplay === 'boolean' ? {} : props.autoplay))
+    const AutoplayPlugin = await import("embla-carousel-autoplay").then((r) => r.default);
+    plugins2.push(AutoplayPlugin(typeof props.autoplay === "boolean" ? {} : props.autoplay));
   }
-
   if (props.autoScroll) {
-    const AutoScrollPlugin = await import('embla-carousel-auto-scroll').then(r => r.default)
-    plugins.push(AutoScrollPlugin(typeof props.autoScroll === 'boolean' ? {} : props.autoScroll))
+    const AutoScrollPlugin = await import("embla-carousel-auto-scroll").then((r) => r.default);
+    plugins2.push(AutoScrollPlugin(typeof props.autoScroll === "boolean" ? {} : props.autoScroll));
   }
-
   if (props.autoHeight) {
-    const AutoHeightPlugin = await import('embla-carousel-auto-height').then(r => r.default)
-    plugins.push(AutoHeightPlugin(typeof props.autoHeight === 'boolean' ? {} : props.autoHeight))
+    const AutoHeightPlugin = await import("embla-carousel-auto-height").then((r) => r.default);
+    plugins2.push(AutoHeightPlugin(typeof props.autoHeight === "boolean" ? {} : props.autoHeight));
   }
-
   if (props.classNames) {
-    const ClassNamesPlugin = await import('embla-carousel-class-names').then(r => r.default)
-    plugins.push(ClassNamesPlugin(typeof props.classNames === 'boolean' ? {} : props.classNames))
+    const ClassNamesPlugin = await import("embla-carousel-class-names").then((r) => r.default);
+    plugins2.push(ClassNamesPlugin(typeof props.classNames === "boolean" ? {} : props.classNames));
   }
-
   if (props.fade) {
-    const FadePlugin = await import('embla-carousel-fade').then(r => r.default)
-    plugins.push(FadePlugin(typeof props.fade === 'boolean' ? {} : props.fade))
+    const FadePlugin = await import("embla-carousel-fade").then((r) => r.default);
+    plugins2.push(FadePlugin(typeof props.fade === "boolean" ? {} : props.fade));
   }
-
   if (props.wheelGestures) {
-    const { WheelGesturesPlugin } = await import('embla-carousel-wheel-gestures')
-    plugins.push(WheelGesturesPlugin(typeof props.wheelGestures === 'boolean' ? {} : props.wheelGestures))
+    const { WheelGesturesPlugin } = await import("embla-carousel-wheel-gestures");
+    plugins2.push(WheelGesturesPlugin(typeof props.wheelGestures === "boolean" ? {} : props.wheelGestures));
   }
-
-  return plugins
-})
-
-const [emblaRef, emblaApi] = useEmblaCarousel(options.value, plugins.value)
-
+  return plugins2;
+});
+const [emblaRef, emblaApi] = useEmblaCarousel(options.value, plugins.value);
 watch([options, plugins], () => {
-  emblaApi.value?.reInit(options.value, plugins.value)
-})
-
+  emblaApi.value?.reInit(options.value, plugins.value);
+});
 function scrollPrev() {
-  emblaApi.value?.scrollPrev()
+  emblaApi.value?.scrollPrev();
 }
 function scrollNext() {
-  emblaApi.value?.scrollNext()
+  emblaApi.value?.scrollNext();
 }
-function scrollTo(index: number) {
-  emblaApi.value?.scrollTo(index)
+function scrollTo(index) {
+  emblaApi.value?.scrollTo(index);
 }
-
-function onKeyDown(event: KeyboardEvent) {
-  const prevKey = props.orientation === 'vertical' ? 'ArrowUp' : 'ArrowLeft'
-  const nextKey = props.orientation === 'vertical' ? 'ArrowDown' : 'ArrowRight'
-
+function onKeyDown(event) {
+  const prevKey = props.orientation === "vertical" ? "ArrowUp" : "ArrowLeft";
+  const nextKey = props.orientation === "vertical" ? "ArrowDown" : "ArrowRight";
   if (event.key === prevKey) {
-    event.preventDefault()
-    scrollPrev()
-
-    return
+    event.preventDefault();
+    scrollPrev();
+    return;
   }
-
   if (event.key === nextKey) {
-    event.preventDefault()
-    scrollNext()
+    event.preventDefault();
+    scrollNext();
   }
 }
-
-const canScrollNext = ref(false)
-const canScrollPrev = ref(false)
-const selectedIndex = ref<number>(0)
-const scrollSnaps = ref<number[]>([])
-
-function onInit(api: EmblaCarouselType) {
-  scrollSnaps.value = api?.scrollSnapList() || []
+const canScrollNext = ref(false);
+const canScrollPrev = ref(false);
+const selectedIndex = ref(0);
+const scrollSnaps = ref([]);
+function onInit(api) {
+  scrollSnaps.value = api?.scrollSnapList() || [];
 }
-function onSelect(api: EmblaCarouselType) {
-  canScrollNext.value = api?.canScrollNext() || false
-  canScrollPrev.value = api?.canScrollPrev() || false
-  selectedIndex.value = api?.selectedScrollSnap() || 0
+function onSelect(api) {
+  canScrollNext.value = api?.canScrollNext() || false;
+  canScrollPrev.value = api?.canScrollPrev() || false;
+  selectedIndex.value = api?.selectedScrollSnap() || 0;
+  emits("select", selectedIndex.value);
 }
-
 onMounted(() => {
   if (!emblaApi.value) {
-    return
+    return;
   }
-
-  emblaApi.value?.on('init', onInit)
-  emblaApi.value?.on('init', onSelect)
-  emblaApi.value?.on('reInit', onInit)
-  emblaApi.value?.on('reInit', onSelect)
-  emblaApi.value?.on('select', onSelect)
-})
-
+  emblaApi.value?.on("init", onInit);
+  emblaApi.value?.on("init", onSelect);
+  emblaApi.value?.on("reInit", onInit);
+  emblaApi.value?.on("reInit", onSelect);
+  emblaApi.value?.on("select", onSelect);
+});
 defineExpose({
   emblaRef,
   emblaApi
-})
+});
 </script>
 
 <template>
@@ -299,7 +177,7 @@ defineExpose({
           color="neutral"
           variant="outline"
           :aria-label="t('carousel.prev')"
-          v-bind="typeof prev === 'object' ? prev : undefined"
+          v-bind="typeof prev === 'object' ? prev : void 0"
           :class="ui.prev({ class: props.ui?.prev })"
           @click="scrollPrev"
         />
@@ -310,7 +188,7 @@ defineExpose({
           color="neutral"
           variant="outline"
           :aria-label="t('carousel.next')"
-          v-bind="typeof next === 'object' ? next : undefined"
+          v-bind="typeof next === 'object' ? next : void 0"
           :class="ui.next({ class: props.ui?.next })"
           @click="scrollNext"
         />

package/dist/runtime/components/Carousel.vue.d.ts

@@ -0,0 +1,120 @@
+import type { AppConfig } from '@nuxt/schema';
+import type { AcceptableValue } from 'reka-ui';
+import type { EmblaCarouselType, EmblaOptionsType } from 'embla-carousel';
+import type { AutoplayOptionsType } from 'embla-carousel-autoplay';
+import type { AutoScrollOptionsType } from 'embla-carousel-auto-scroll';
+import type { AutoHeightOptionsType } from 'embla-carousel-auto-height';
+import type { ClassNamesOptionsType } from 'embla-carousel-class-names';
+import type { FadeOptionsType } from 'embla-carousel-fade';
+import type { WheelGesturesPluginOptions } from 'embla-carousel-wheel-gestures';
+import theme from '#build/ui/carousel';
+import type { ButtonProps } from '../types';
+import type { ComponentConfig } from '../types/utils';
+type Carousel = ComponentConfig<typeof theme, AppConfig, 'carousel'>;
+export type CarouselItem = AcceptableValue;
+export interface CarouselProps<T extends CarouselItem = CarouselItem> extends Omit<EmblaOptionsType, 'axis' | 'container' | 'slides' | 'direction'> {
+    /**
+     * The element or component this component should render as.
+     * @defaultValue 'div'
+     */
+    as?: any;
+    /**
+     * Configure the prev button when arrows are enabled.
+     * @defaultValue { size: 'md', color: 'neutral', variant: 'link' }
+     */
+    prev?: ButtonProps;
+    /**
+     * The icon displayed in the prev button.
+     * @defaultValue appConfig.ui.icons.arrowLeft
+     * @IconifyIcon
+     */
+    prevIcon?: string;
+    /**
+     * Configure the next button when arrows are enabled.
+     * @defaultValue { size: 'md', color: 'neutral', variant: 'link' }
+     */
+    next?: ButtonProps;
+    /**
+     * The icon displayed in the next button.
+     * @defaultValue appConfig.ui.icons.arrowRight
+     * @IconifyIcon
+     */
+    nextIcon?: string;
+    /**
+     * Display prev and next buttons to scroll the carousel.
+     * @defaultValue false
+     */
+    arrows?: boolean;
+    /**
+     * Display dots to scroll to a specific slide.
+     * @defaultValue false
+     */
+    dots?: boolean;
+    /**
+     * The orientation of the carousel.
+     * @defaultValue 'horizontal'
+     */
+    orientation?: Carousel['variants']['orientation'];
+    items?: T[];
+    /**
+     * Enable Autoplay plugin
+     * @link https://www.embla-carousel.com/plugins/autoplay/
+     */
+    autoplay?: boolean | AutoplayOptionsType;
+    /**
+     * Enable Auto Scroll plugin
+     * @link https://www.embla-carousel.com/plugins/auto-scroll/
+     */
+    autoScroll?: boolean | AutoScrollOptionsType;
+    /**
+     * Enable Auto Height plugin
+     * @link https://www.embla-carousel.com/plugins/auto-height/
+     */
+    autoHeight?: boolean | AutoHeightOptionsType;
+    /**
+     * Enable Class Names plugin
+     * @link https://www.embla-carousel.com/plugins/class-names/
+     */
+    classNames?: boolean | ClassNamesOptionsType;
+    /**
+     * Enable Fade plugin
+     * @link https://www.embla-carousel.com/plugins/fade/
+     */
+    fade?: boolean | FadeOptionsType;
+    /**
+     * Enable Wheel Gestures plugin
+     * @link https://www.embla-carousel.com/plugins/wheel-gestures/
+     */
+    wheelGestures?: boolean | WheelGesturesPluginOptions;
+    class?: any;
+    ui?: Carousel['slots'];
+}
+export type CarouselSlots<T extends CarouselItem = CarouselItem> = {
+    default(props: {
+        item: T;
+        index: number;
+    }): any;
+};
+export interface CarouselEmits {
+    /**
+     * Emitted when the selected slide changes
+     * @param selectedIndex The index of the selected slide
+     */
+    select: [selectedIndex: number];
+}
+declare const _default: <T extends CarouselItem>(__VLS_props: NonNullable<Awaited<typeof __VLS_setup>>["props"], __VLS_ctx?: __VLS_PrettifyLocal<Pick<NonNullable<Awaited<typeof __VLS_setup>>, "attrs" | "emit" | "slots">>, __VLS_expose?: NonNullable<Awaited<typeof __VLS_setup>>["expose"], __VLS_setup?: Promise<{
+    props: __VLS_PrettifyLocal<any & CarouselProps<T> & Partial<{}>> & (import("vue").VNodeProps & import("vue").AllowedComponentProps & import("vue").ComponentCustomProps);
+    expose(exposed: import("vue").ShallowUnwrapRef<{
+        emblaRef: import("vue").Ref<HTMLElement | undefined, HTMLElement | undefined>;
+        emblaApi: import("vue").Ref<EmblaCarouselType | undefined, EmblaCarouselType | undefined>;
+    }>): void;
+    attrs: any;
+    slots: Readonly<CarouselSlots<T>> & CarouselSlots<T>;
+    emit: (evt: "select", selectedIndex: number) => void;
+}>) => import("vue").VNode & {
+    __ctx?: Awaited<typeof __VLS_setup>;
+};
+export default _default;
+type __VLS_PrettifyLocal<T> = {
+    [K in keyof T]: T[K];
+} & {};