chore(components): improve JSDoc

This commit is contained in:
Benjamin Canac
2024-06-11 18:23:56 +02:00
parent 655d9b2c97
commit ee3d2aa30f
27 changed files with 232 additions and 10 deletions

View File

@@ -17,12 +17,17 @@ export interface RadioGroupItem extends Pick<RadioGroupItemProps, 'disabled' | '
description?: string
}
export interface RadioGroupProps<T> extends Omit<RadioGroupRootProps, 'asChild' | 'dir'> {
export interface RadioGroupProps<T> extends Omit<RadioGroupRootProps, 'asChild' | 'dir' | 'orientation'> {
legend?: string
items?: T[]
class?: any
size?: RadioGroupVariants['size']
color?: RadioGroupVariants['color']
/**
* The orientation the radio buttons are laid out.
* @defaultValue `'vertical'`
*/
orientation?: RadioGroupRootProps['orientation']
class?: any
ui?: Partial<typeof radioGroup.slots>
}
@@ -43,7 +48,9 @@ import { RadioGroupRoot, RadioGroupItem, RadioGroupIndicator, Label, useForwardP
import { reactivePick } from '@vueuse/core'
import { useId, useFormField } from '#imports'
const props = withDefaults(defineProps<RadioGroupProps<T>>(), { orientation: 'vertical' })
const props = withDefaults(defineProps<RadioGroupProps<T>>(), {
orientation: 'vertical'
})
const emits = defineEmits<RadioGroupEmits>()
const slots = defineSlots<RadioGroupSlots<T>>()