From d2be8fdf7daef254649078f74ed6ccdcf1ad0ceb Mon Sep 17 00:00:00 2001
From: Benjamin Canac <canacb1@gmail.com>
Date: Mon, 1 Jul 2024 16:22:08 +0200
Subject: [PATCH] chore(components): improve jsdoc

---
 src/runtime/components/Alert.vue          | 2 +-
 src/runtime/components/CommandPalette.vue | 9 +++++++--
 src/runtime/components/Modal.vue          | 2 +-
 src/runtime/components/Slideover.vue      | 2 +-
 src/runtime/components/Toast.vue          | 2 +-
 5 files changed, 11 insertions(+), 6 deletions(-)

diff --git a/src/runtime/components/Alert.vue b/src/runtime/components/Alert.vue
index 3bfb2960..14e5c29b 100644
--- a/src/runtime/components/Alert.vue
+++ b/src/runtime/components/Alert.vue
@@ -31,7 +31,7 @@ export interface AlertProps {
   actions?: ButtonProps[]
   /**
    * Display a close button to dismiss the alert.
-   * Will render with `{ size: 'md', color: 'gray', variant: 'link' }`.
+   * `{ size: 'md', color: 'gray', variant: 'link' }`
    * @emits `close`
    * @defaultValue false
    */
diff --git a/src/runtime/components/CommandPalette.vue b/src/runtime/components/CommandPalette.vue
index 501ad246..334206f0 100644
--- a/src/runtime/components/CommandPalette.vue
+++ b/src/runtime/components/CommandPalette.vue
@@ -36,7 +36,12 @@ export interface CommandPaletteGroup<T> {
   highlightedIcon?: string
 }
 
-export interface CommandPaletteProps<G, T> extends Pick<ComboboxRootProps, 'as' | 'multiple' | 'disabled' | 'modelValue' | 'defaultValue'>, Pick<UseComponentIconsProps, 'loading' | 'loadingIcon'> {
+export interface CommandPaletteProps<G, T> extends Pick<ComboboxRootProps, 'multiple' | 'disabled' | 'modelValue' | 'defaultValue'>, Pick<UseComponentIconsProps, 'loading' | 'loadingIcon'> {
+  /**
+   * The element or component this component should render as.
+   * @defaultValue 'div'
+   */
+  as?: any
   /**
    * The icon displayed in the input.
    * @defaultValue appConfig.ui.icons.search
@@ -54,7 +59,7 @@ export interface CommandPaletteProps<G, T> extends Pick<ComboboxRootProps, 'as'
   placeholder?: InputProps['placeholder']
   /**
    * Display a close button in the input (useful when inside a `UModal`).
-   * Will render with `{ size: 'md', color: 'gray', variant: 'ghost' }`.
+   * `{ size: 'md', color: 'gray', variant: 'ghost' }`
    * @defaultValue false
    */
   close?: ButtonProps | boolean
diff --git a/src/runtime/components/Modal.vue b/src/runtime/components/Modal.vue
index 33668e5a..c5b614fd 100644
--- a/src/runtime/components/Modal.vue
+++ b/src/runtime/components/Modal.vue
@@ -25,7 +25,7 @@ export interface ModalProps extends DialogRootProps {
   portal?: boolean
   /**
    * Display a close button to dismiss the modal.
-   * Will render with `{ size: 'md', color: 'gray', variant: 'ghost' }`.
+   * `{ size: 'md', color: 'gray', variant: 'ghost' }`
    * @defaultValue true
    */
   close?: ButtonProps | boolean
diff --git a/src/runtime/components/Slideover.vue b/src/runtime/components/Slideover.vue
index c776a390..26147090 100644
--- a/src/runtime/components/Slideover.vue
+++ b/src/runtime/components/Slideover.vue
@@ -35,7 +35,7 @@ export interface SlideoverProps extends DialogRootProps {
   portal?: boolean
   /**
    * Display a close button to dismiss the slideover.
-   * Will render with `{ size: 'md', color: 'gray', variant: 'ghost' }`.
+   * `{ size: 'md', color: 'gray', variant: 'ghost' }`
    * @defaultValue true
    */
   close?: ButtonProps | boolean
diff --git a/src/runtime/components/Toast.vue b/src/runtime/components/Toast.vue
index 6d3c18b0..f49c66ee 100644
--- a/src/runtime/components/Toast.vue
+++ b/src/runtime/components/Toast.vue
@@ -31,7 +31,7 @@ export interface ToastProps extends Pick<ToastRootProps, 'defaultOpen' | 'open'
   actions?: ButtonProps[]
   /**
    * Display a close button to dismiss the toast.
-   * Will render with `{ size: 'md', color: 'gray', variant: 'link' }`.
+   * `{ size: 'md', color: 'gray', variant: 'link' }`
    * @defaultValue true
    */
   close?: ButtonProps | boolean