arthur/ui
1
0
Fork 0
mirror of https://github.com/ArthurDanjou/ui.git synced 2026-01-14 20:19:34 +01:00
Code Issues Packages Projects Releases Wiki Activity

chore(Switch): improve props JSDoc

Browse Source
This commit is contained in:
Benjamin Canac
2024-06-10 11:17:42 +02:00
parent d8189052be
commit 0f2da5bb15
1 changed files with 7 additions and 0 deletions
Download Patch File Download Diff File Expand all files Collapse all files

7
src/runtime/components/Switch.vue
View File

@@ -14,9 +14,16 @@ type SwitchVariants = VariantProps<typeof switchTv>
export interface SwitchProps extends Omit<SwitchRootProps, 'asChild' | 'checked' | 'defaultChecked'> {
color?: SwitchVariants['color']
size?: SwitchVariants['size']
/** When `true`, the loading icon will be displayed. */
loading?: boolean
/**
* The icon when the `loading` prop is `true`.
* @defaultValue `appConfig.ui.icons.loading`
*/
loadingIcon?: string
/** Display an icon when the switch is checked. */
checkedIcon?: string
/** Display an icon when the switch is unchecked. */
uncheckedIcon?: string
label?: string
description?: string