@nuxt/ui 3.0.2 → 3.1.0

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

@@ -0,0 +1,141 @@
+import type { DropdownMenuRootProps, DropdownMenuRootEmits, DropdownMenuContentProps, DropdownMenuContentEmits, DropdownMenuArrowProps } from 'reka-ui';
+import type { AppConfig } from '@nuxt/schema';
+import theme from '#build/ui/dropdown-menu';
+import type { AvatarProps, KbdProps, LinkProps } from '../types';
+import type { ArrayOrNested, DynamicSlots, MergeTypes, NestedItem, EmitsToProps, ComponentConfig } from '../types/utils';
+type DropdownMenu = ComponentConfig<typeof theme, AppConfig, 'dropdownMenu'>;
+export interface DropdownMenuItem extends Omit<LinkProps, 'type' | 'raw' | 'custom'> {
+    label?: string;
+    /**
+     * @IconifyIcon
+     */
+    icon?: string;
+    color?: DropdownMenu['variants']['color'];
+    avatar?: AvatarProps;
+    content?: Omit<DropdownMenuContentProps, 'as' | 'asChild' | 'forceMount'> & Partial<EmitsToProps<DropdownMenuContentEmits>>;
+    kbds?: KbdProps['value'][] | KbdProps[];
+    /**
+     * The item type.
+     * @defaultValue 'link'
+     */
+    type?: 'label' | 'separator' | 'link' | 'checkbox';
+    slot?: string;
+    loading?: boolean;
+    disabled?: boolean;
+    checked?: boolean;
+    open?: boolean;
+    defaultOpen?: boolean;
+    children?: ArrayOrNested<DropdownMenuItem>;
+    onSelect?(e: Event): void;
+    onUpdateChecked?(checked: boolean): void;
+    [key: string]: any;
+}
+export interface DropdownMenuProps<T extends ArrayOrNested<DropdownMenuItem> = ArrayOrNested<DropdownMenuItem>> extends Omit<DropdownMenuRootProps, 'dir'> {
+    /**
+     * @defaultValue 'md'
+     */
+    size?: DropdownMenu['variants']['size'];
+    items?: T;
+    /**
+     * The icon displayed when an item is checked.
+     * @defaultValue appConfig.ui.icons.check
+     * @IconifyIcon
+     */
+    checkedIcon?: string;
+    /**
+     * The icon displayed when an item is loading.
+     * @defaultValue appConfig.ui.icons.loading
+     * @IconifyIcon
+     */
+    loadingIcon?: string;
+    /**
+     * The icon displayed when the item is an external link.
+     * Set to `false` to hide the external icon.
+     * @defaultValue appConfig.ui.icons.external
+     * @IconifyIcon
+     */
+    externalIcon?: boolean | string;
+    /**
+     * The content of the menu.
+     * @defaultValue { side: 'bottom', sideOffset: 8, collisionPadding: 8 }
+     */
+    content?: Omit<DropdownMenuContentProps, 'as' | 'asChild' | 'forceMount'> & Partial<EmitsToProps<DropdownMenuContentEmits>>;
+    /**
+     * Display an arrow alongside the menu.
+     * @defaultValue false
+     */
+    arrow?: boolean | Omit<DropdownMenuArrowProps, 'as' | 'asChild'>;
+    /**
+     * Render the menu in a portal.
+     * @defaultValue true
+     */
+    portal?: boolean | string | HTMLElement;
+    /**
+     * The key used to get the label from the item.
+     * @defaultValue 'label'
+     */
+    labelKey?: keyof NestedItem<T>;
+    disabled?: boolean;
+    class?: any;
+    ui?: DropdownMenu['slots'];
+}
+export interface DropdownMenuEmits extends DropdownMenuRootEmits {
+}
+type SlotProps<T extends DropdownMenuItem> = (props: {
+    item: T;
+    active?: boolean;
+    index: number;
+}) => any;
+export type DropdownMenuSlots<A extends ArrayOrNested<DropdownMenuItem> = ArrayOrNested<DropdownMenuItem>, T extends NestedItem<A> = NestedItem<A>> = {
+    'default'(props: {
+        open: boolean;
+    }): any;
+    'item': SlotProps<T>;
+    'item-leading': SlotProps<T>;
+    'item-label': SlotProps<T>;
+    'item-trailing': SlotProps<T>;
+    'content-top': (props?: {}) => any;
+    'content-bottom': (props?: {}) => any;
+} & DynamicSlots<MergeTypes<T>, 'leading' | 'label' | 'trailing', {
+    active?: boolean;
+    index: number;
+}>;
+declare const _default: <T extends ArrayOrNested<DropdownMenuItem>>(__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 & DropdownMenuProps<T> & Partial<{}>> & (import("vue").VNodeProps & import("vue").AllowedComponentProps & import("vue").ComponentCustomProps);
+    expose(exposed: import("vue").ShallowUnwrapRef<{}>): void;
+    attrs: any;
+    slots: Readonly<{
+        default(props: {
+            open: boolean;
+        }): any;
+        item: SlotProps<NestedItem<T>>;
+        'item-leading': SlotProps<NestedItem<T>>;
+        'item-label': SlotProps<NestedItem<T>>;
+        'item-trailing': SlotProps<NestedItem<T>>;
+        'content-top': (props?: {}) => any;
+        'content-bottom': (props?: {}) => any;
+    } & DynamicSlots<MergeTypes<NestedItem<T>>, "trailing" | "leading" | "label", {
+        active?: boolean;
+        index: number;
+    }>> & {
+        default(props: {
+            open: boolean;
+        }): any;
+        item: SlotProps<NestedItem<T>>;
+        'item-leading': SlotProps<NestedItem<T>>;
+        'item-label': SlotProps<NestedItem<T>>;
+        'item-trailing': SlotProps<NestedItem<T>>;
+        'content-top': (props?: {}) => any;
+        'content-bottom': (props?: {}) => any;
+    } & DynamicSlots<MergeTypes<NestedItem<T>>, "trailing" | "leading" | "label", {
+        active?: boolean;
+        index: number;
+    }>;
+    emit: (evt: "update:open", payload: boolean) => void;
+}>) => import("vue").VNode & {
+    __ctx?: Awaited<typeof __VLS_setup>;
+};
+export default _default;
+type __VLS_PrettifyLocal<T> = {
+    [K in keyof T]: T[K];
+} & {};

package/dist/runtime/components/DropdownMenuContent.vue

@@ -1,100 +1,87 @@
-<!-- eslint-disable vue/block-tag-newline -->
-<script lang="ts">
-import type { DropdownMenuContentProps as RekaDropdownMenuContentProps, DropdownMenuContentEmits as RekaDropdownMenuContentEmits } from 'reka-ui'
-import theme from '#build/ui/dropdown-menu'
-import { tv } from '../utils/tv'
-import type { KbdProps, AvatarProps, DropdownMenuItem, DropdownMenuSlots } from '../types'
-import type { ArrayOrNested, NestedItem } from '../types/utils'
-
-const _dropdownMenu = tv(theme)()
-
-interface DropdownMenuContentProps<T extends ArrayOrNested<DropdownMenuItem>> extends Omit<RekaDropdownMenuContentProps, 'as' | 'asChild' | 'forceMount'> {
-  items?: T
-  portal?: boolean
-  sub?: boolean
-  labelKey: keyof NestedItem<T>
-  /**
-   * @IconifyIcon
-   */
-  checkedIcon?: string
-  /**
-   * @IconifyIcon
-   */
-  loadingIcon?: string
-  /**
-   * @IconifyIcon
-   */
-  externalIcon?: boolean | string
-  class?: any
-  ui: typeof _dropdownMenu
-  uiOverride?: any
-}
-
-interface DropdownMenuContentEmits extends RekaDropdownMenuContentEmits {}
-
-type DropdownMenuContentSlots<T extends ArrayOrNested<DropdownMenuItem>> = Omit<DropdownMenuSlots<T>, 'default'> & {
-  default(props?: {}): any
-}
+<script>
 
 </script>
 
-<script setup lang="ts" generic="T extends ArrayOrNested<DropdownMenuItem>">
-import { computed } from 'vue'
-import { DropdownMenu } from 'reka-ui/namespaced'
-import { useForwardPropsEmits } from 'reka-ui'
-import { reactiveOmit, createReusableTemplate } from '@vueuse/core'
-import { useAppConfig } from '#imports'
-import { omit, get, isArrayOfArray } from '../utils'
-import { pickLinkProps } from '../utils/link'
-import ULinkBase from './LinkBase.vue'
-import ULink from './Link.vue'
-import UAvatar from './Avatar.vue'
-import UIcon from './Icon.vue'
-import UKbd from './Kbd.vue'
-// eslint-disable-next-line import/no-self-import
-import UDropdownMenuContent from './DropdownMenuContent.vue'
-
-const props = defineProps<DropdownMenuContentProps<T>>()
-const emits = defineEmits<DropdownMenuContentEmits>()
-const slots = defineSlots<DropdownMenuContentSlots<T>>()
-
-const appConfig = useAppConfig()
-const contentProps = useForwardPropsEmits(reactiveOmit(props, 'sub', 'items', 'portal', 'labelKey', 'checkedIcon', 'loadingIcon', 'externalIcon', 'class', 'ui', 'uiOverride'), emits)
-const proxySlots = omit(slots, ['default'])
-
-const [DefineItemTemplate, ReuseItemTemplate] = createReusableTemplate<{ item: DropdownMenuItem, active?: boolean, index: number }>()
-
-const groups = computed<DropdownMenuItem[][]>(() =>
-  props.items?.length
-    ? isArrayOfArray(props.items)
-      ? props.items
-      : [props.items]
-    : []
-)
+<script setup>
+import { computed, toRef } from "vue";
+import { DropdownMenu } from "reka-ui/namespaced";
+import { useForwardPropsEmits } from "reka-ui";
+import { reactiveOmit, createReusableTemplate } from "@vueuse/core";
+import { useAppConfig } from "#imports";
+import { useLocale } from "../composables/useLocale";
+import { usePortal } from "../composables/usePortal";
+import { omit, get, isArrayOfArray } from "../utils";
+import { pickLinkProps } from "../utils/link";
+import ULinkBase from "./LinkBase.vue";
+import ULink from "./Link.vue";
+import UAvatar from "./Avatar.vue";
+import UIcon from "./Icon.vue";
+import UKbd from "./Kbd.vue";
+import UDropdownMenuContent from "./DropdownMenuContent.vue";
+const props = defineProps({
+  items: { type: null, required: false },
+  portal: { type: [Boolean, String], required: false, skipCheck: true },
+  sub: { type: Boolean, required: false },
+  labelKey: { type: null, required: true },
+  checkedIcon: { type: String, required: false },
+  loadingIcon: { type: String, required: false },
+  externalIcon: { type: [Boolean, String], required: false },
+  class: { type: null, required: false },
+  ui: { type: null, required: true },
+  uiOverride: { type: null, required: false },
+  loop: { type: Boolean, required: false },
+  side: { type: null, required: false },
+  sideOffset: { type: Number, required: false },
+  align: { type: null, required: false },
+  alignOffset: { type: Number, required: false },
+  avoidCollisions: { type: Boolean, required: false },
+  collisionBoundary: { type: null, required: false },
+  collisionPadding: { type: [Number, Object], required: false },
+  arrowPadding: { type: Number, required: false },
+  sticky: { type: String, required: false },
+  hideWhenDetached: { type: Boolean, required: false },
+  positionStrategy: { type: String, required: false },
+  updatePositionStrategy: { type: String, required: false },
+  disableUpdateOnLayoutShift: { type: Boolean, required: false },
+  prioritizePosition: { type: Boolean, required: false },
+  reference: { type: null, required: false }
+});
+const emits = defineEmits(["escapeKeyDown", "pointerDownOutside", "focusOutside", "interactOutside", "closeAutoFocus"]);
+const slots = defineSlots();
+const { dir } = useLocale();
+const appConfig = useAppConfig();
+const portalProps = usePortal(toRef(() => props.portal));
+const contentProps = useForwardPropsEmits(reactiveOmit(props, "sub", "items", "portal", "labelKey", "checkedIcon", "loadingIcon", "externalIcon", "class", "ui", "uiOverride"), emits);
+const proxySlots = omit(slots, ["default"]);
+const [DefineItemTemplate, ReuseItemTemplate] = createReusableTemplate();
+const childrenIcon = computed(() => dir.value === "rtl" ? appConfig.ui.icons.chevronLeft : appConfig.ui.icons.chevronRight);
+const groups = computed(
+  () => props.items?.length ? isArrayOfArray(props.items) ? props.items : [props.items] : []
+);
 </script>
 
 <template>
   <DefineItemTemplate v-slot="{ item, active, index }">
-    <slot :name="((item.slot || 'item') as keyof DropdownMenuContentSlots<T>)" :item="(item as Extract<NestedItem<T>, { slot: string; }>)" :index="index">
-      <slot :name="((item.slot ? `${item.slot}-leading`: 'item-leading') as keyof DropdownMenuContentSlots<T>)" :item="(item as Extract<NestedItem<T>, { slot: string; }>)" :active="active" :index="index">
+    <slot :name="item.slot || 'item'" :item="item" :index="index">
+      <slot :name="item.slot ? `${item.slot}-leading` : 'item-leading'" :item="item" :active="active" :index="index">
         <UIcon v-if="item.loading" :name="loadingIcon || appConfig.ui.icons.loading" :class="ui.itemLeadingIcon({ class: uiOverride?.itemLeadingIcon, color: item?.color, loading: true })" />
         <UIcon v-else-if="item.icon" :name="item.icon" :class="ui.itemLeadingIcon({ class: uiOverride?.itemLeadingIcon, color: item?.color, active })" />
-        <UAvatar v-else-if="item.avatar" :size="((props.uiOverride?.itemLeadingAvatarSize || ui.itemLeadingAvatarSize()) as AvatarProps['size'])" v-bind="item.avatar" :class="ui.itemLeadingAvatar({ class: uiOverride?.itemLeadingAvatar, active })" />
+        <UAvatar v-else-if="item.avatar" :size="props.uiOverride?.itemLeadingAvatarSize || ui.itemLeadingAvatarSize()" v-bind="item.avatar" :class="ui.itemLeadingAvatar({ class: uiOverride?.itemLeadingAvatar, active })" />
       </slot>
 
-      <span v-if="get(item, props.labelKey as string) || !!slots[(item.slot ? `${item.slot}-label`: 'item-label') as keyof DropdownMenuContentSlots<T>]" :class="ui.itemLabel({ class: uiOverride?.itemLabel, active })">
-        <slot :name="((item.slot ? `${item.slot}-label`: 'item-label') as keyof DropdownMenuContentSlots<T>)" :item="(item as Extract<NestedItem<T>, { slot: string; }>)" :active="active" :index="index">
-          {{ get(item, props.labelKey as string) }}
+      <span v-if="get(item, props.labelKey) || !!slots[item.slot ? `${item.slot}-label` : 'item-label']" :class="ui.itemLabel({ class: uiOverride?.itemLabel, active })">
+        <slot :name="item.slot ? `${item.slot}-label` : 'item-label'" :item="item" :active="active" :index="index">
+          {{ get(item, props.labelKey) }}
         </slot>
 
         <UIcon v-if="item.target === '_blank' && externalIcon !== false" :name="typeof externalIcon === 'string' ? externalIcon : appConfig.ui.icons.external" :class="ui.itemLabelExternalIcon({ class: uiOverride?.itemLabelExternalIcon, color: item?.color, active })" />
       </span>
 
       <span :class="ui.itemTrailing({ class: uiOverride?.itemTrailing })">
-        <slot :name="((item.slot ? `${item.slot}-trailing`: 'item-trailing') as keyof DropdownMenuContentSlots<T>)" :item="(item as Extract<NestedItem<T>, { slot: string; }>)" :active="active" :index="index">
-          <UIcon v-if="item.children?.length" :name="appConfig.ui.icons.chevronRight" :class="ui.itemTrailingIcon({ class: uiOverride?.itemTrailingIcon, color: item?.color, active })" />
+        <slot :name="item.slot ? `${item.slot}-trailing` : 'item-trailing'" :item="item" :active="active" :index="index">
+          <UIcon v-if="item.children?.length" :name="childrenIcon" :class="ui.itemTrailingIcon({ class: uiOverride?.itemTrailingIcon, color: item?.color, active })" />
           <span v-else-if="item.kbds?.length" :class="ui.itemTrailingKbds({ class: uiOverride?.itemTrailingKbds })">
-            <UKbd v-for="(kbd, kbdIndex) in item.kbds" :key="kbdIndex" :size="((props.uiOverride?.itemTrailingKbdsSize || ui.itemTrailingKbdsSize()) as KbdProps['size'])" v-bind="typeof kbd === 'string' ? { value: kbd } : kbd" />
+            <UKbd v-for="(kbd, kbdIndex) in item.kbds" :key="kbdIndex" :size="props.uiOverride?.itemTrailingKbdsSize || ui.itemTrailingKbdsSize()" v-bind="typeof kbd === 'string' ? { value: kbd } : kbd" />
           </span>
         </slot>
 
@@ -105,8 +92,10 @@ const groups = computed<DropdownMenuItem[][]>(() =>
     </slot>
   </DefineItemTemplate>
 
-  <DropdownMenu.Portal :disabled="!portal">
+  <DropdownMenu.Portal v-bind="portalProps">
     <component :is="sub ? DropdownMenu.SubContent : DropdownMenu.Content" :class="props.class" v-bind="contentProps">
+      <slot name="content-top" />
+
       <DropdownMenu.Group v-for="(group, groupIndex) in groups" :key="`group-${groupIndex}`" :class="ui.group({ class: uiOverride?.group })">
         <template v-for="(item, index) in group" :key="`group-${groupIndex}-${index}`">
           <DropdownMenu.Label v-if="item.type === 'label'" :class="ui.label({ class: uiOverride?.label })">
@@ -118,7 +107,7 @@ const groups = computed<DropdownMenuItem[][]>(() =>
               as="button"
               type="button"
               :disabled="item.disabled"
-              :text-value="get(item, props.labelKey as string)"
+              :text-value="get(item, props.labelKey)"
               :class="ui.item({ class: uiOverride?.item, color: item?.color })"
             >
               <ReuseItemTemplate :item="item" :index="index" />
@@ -130,8 +119,7 @@ const groups = computed<DropdownMenuItem[][]>(() =>
               :ui="ui"
               :ui-override="uiOverride"
               :portal="portal"
-              :items="(item.children as T)"
-              side="right"
+              :items="item.children"
               align="start"
               :align-offset="-4"
               :side-offset="3"
@@ -141,8 +129,8 @@ const groups = computed<DropdownMenuItem[][]>(() =>
               :external-icon="externalIcon"
               v-bind="item.content"
             >
-              <template v-for="(_, name) in proxySlots" #[name]="slotData: any">
-                <slot :name="(name as keyof DropdownMenuContentSlots<T>)" v-bind="slotData" />
+              <template v-for="(_, name) in proxySlots" #[name]="slotData">
+                <slot :name="name" v-bind="slotData" />
               </template>
             </UDropdownMenuContent>
           </DropdownMenu.Sub>
@@ -150,7 +138,7 @@ const groups = computed<DropdownMenuItem[][]>(() =>
             v-else-if="item.type === 'checkbox'"
             :model-value="item.checked"
             :disabled="item.disabled"
-            :text-value="get(item, props.labelKey as string)"
+            :text-value="get(item, props.labelKey)"
             :class="ui.item({ class: [uiOverride?.item, item.class], color: item?.color })"
             @update:model-value="item.onUpdateChecked"
             @select="item.onSelect"
@@ -161,10 +149,10 @@ const groups = computed<DropdownMenuItem[][]>(() =>
             v-else
             as-child
             :disabled="item.disabled"
-            :text-value="get(item, props.labelKey as string)"
+            :text-value="get(item, props.labelKey)"
             @select="item.onSelect"
           >
-            <ULink v-slot="{ active, ...slotProps }" v-bind="pickLinkProps(item as Omit<DropdownMenuItem, 'type'>)" custom>
+            <ULink v-slot="{ active, ...slotProps }" v-bind="pickLinkProps(item)" custom>
               <ULinkBase v-bind="slotProps" :class="ui.item({ class: [uiOverride?.item, item.class], color: item?.color, active })">
                 <ReuseItemTemplate :item="item" :active="active" :index="index" />
               </ULinkBase>
@@ -174,6 +162,8 @@ const groups = computed<DropdownMenuItem[][]>(() =>
       </DropdownMenu.Group>
 
       <slot />
+
+      <slot name="content-bottom" />
     </component>
   </DropdownMenu.Portal>
 </template>

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

@@ -0,0 +1,55 @@
+import { DropdownMenu } from 'reka-ui/namespaced';
+import type { DropdownMenuContentProps as RekaDropdownMenuContentProps } from 'reka-ui';
+import type { AppConfig } from '@nuxt/schema';
+import type theme from '#build/ui/dropdown-menu';
+import type { DropdownMenuItem, DropdownMenuSlots } from '../types';
+import type { ArrayOrNested, NestedItem, ComponentConfig } from '../types/utils';
+type DropdownMenu = ComponentConfig<typeof theme, AppConfig, 'dropdownMenu'>;
+interface DropdownMenuContentProps<T extends ArrayOrNested<DropdownMenuItem>> extends Omit<RekaDropdownMenuContentProps, 'as' | 'asChild' | 'forceMount'> {
+    items?: T;
+    portal?: boolean | string | HTMLElement;
+    sub?: boolean;
+    labelKey: keyof NestedItem<T>;
+    /**
+     * @IconifyIcon
+     */
+    checkedIcon?: string;
+    /**
+     * @IconifyIcon
+     */
+    loadingIcon?: string;
+    /**
+     * @IconifyIcon
+     */
+    externalIcon?: boolean | string;
+    class?: any;
+    ui: {
+        [K in keyof Required<DropdownMenu['slots']>]: (props?: Record<string, any>) => string;
+    };
+    uiOverride?: DropdownMenu['slots'];
+}
+declare const _default: <T extends ArrayOrNested<DropdownMenuItem>>(__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 & DropdownMenuContentProps<T> & Partial<{}>> & (import("vue").VNodeProps & import("vue").AllowedComponentProps & import("vue").ComponentCustomProps);
+    expose(exposed: import("vue").ShallowUnwrapRef<{}>): void;
+    attrs: any;
+    slots: Readonly<Omit<DropdownMenuSlots<T>, "default"> & {
+        default(props?: {}): any;
+    }> & Omit<DropdownMenuSlots<T>, "default"> & {
+        default(props?: {}): any;
+    };
+    emit: ((evt: "escapeKeyDown", event: KeyboardEvent) => void) & ((evt: "pointerDownOutside", event: CustomEvent<{
+        originalEvent: PointerEvent;
+    }>) => void) & ((evt: "focusOutside", event: CustomEvent<{
+        originalEvent: FocusEvent;
+    }>) => void) & ((evt: "interactOutside", event: CustomEvent<{
+        originalEvent: PointerEvent;
+    }> | CustomEvent<{
+        originalEvent: FocusEvent;
+    }>) => void) & ((evt: "closeAutoFocus", event: Event) => void);
+}>) => import("vue").VNode & {
+    __ctx?: Awaited<typeof __VLS_setup>;
+};
+export default _default;
+type __VLS_PrettifyLocal<T> = {
+    [K in keyof T]: T[K];
+} & {};