diff --git a/docs/components/checkbox.md b/docs/components/checkbox.md index 1e639c15..457f801e 100644 --- a/docs/components/checkbox.md +++ b/docs/components/checkbox.md @@ -1,17 +1,20 @@ + # Vue Checkbox - Flowbite -## Default checkbox +## Checkbox example ```vue ``` -## Disabled checkbox +## Disabled state ```vue @@ -38,38 +42,114 @@ const check = ref(false) ``` -## Checked checkbox +## Checkbox with link - + ```vue ``` -## Link with checkbox +## Checkbox with helper text - + ```vue ``` + + +## Checkbox group + +When using the checkbox with `arrays` or `objects`, the selected values will be stored in the array referenced by v-model + + + +```vue + + + + +``` + +## Checkbox component API + +### FwbCheckbox Props +| Name | Type | Default | Description | +| ------------ | ---------------- | ------- | ------------------------------- | +| wrapperClass | String \| Object | `''` | Added to main component wrapper | +| labelClass | String \| Object | `''` | Added to `