arthur/ui
1
0
Fork 0
mirror of https://github.com/ArthurDanjou/ui.git synced 2026-01-25 17:30:37 +01:00
Code Issues Packages Projects Releases Wiki Activity

chore(components): improve jsdoc

Browse Source
This commit is contained in:
Benjamin Canac
2024-07-01 16:22:08 +02:00
parent ccbaf6ea15
commit d2be8fdf7d
5 changed files with 11 additions and 6 deletions
Download Patch File Download Diff File Expand all files Collapse all files

9
src/runtime/components/CommandPalette.vue
View File

@@ -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