Skip to content

Commit 2ec8f77

Browse files
committed
docs(FieldChecklist): add documentation
1 parent 8fca680 commit 2ec8f77

File tree

3 files changed

+64
-0
lines changed

3 files changed

+64
-0
lines changed

apps/docs/.vitepress/config.js

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -54,6 +54,7 @@ export default defineConfig({
5454
items: [
5555
{ text: 'FieldButton', link: '/guide/fields/FieldButton' },
5656
{ text: 'FieldCheckbox', link: '/guide/fields/FieldCheckbox' },
57+
{ text: 'FieldChecklist', link: '/guide/fields/FieldChecklist' },
5758
{ text: 'FieldColor', link: '/guide/fields/FieldColor' },
5859
{ text: 'FieldMask', link: '/guide/fields/FieldMask' },
5960
{ text: 'FieldNumber', link: '/guide/fields/FieldNumber' },
Lines changed: 29 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,29 @@
1+
<template>
2+
permissions: <code>{{ form.model.permissions }}</code>
3+
<vue-form-generator :schema="form.schema" :model="form.model" />
4+
</template>
5+
6+
<script setup>
7+
import { ref } from 'vue'
8+
9+
const form = ref({
10+
model: {
11+
permissions: []
12+
},
13+
schema: {
14+
fields: [
15+
{
16+
name: 'activePermissions',
17+
label: 'Active permissions',
18+
model: 'permissions',
19+
type: 'checklist',
20+
options: [
21+
{ name: 'Manage warehouse', value: 'manageWarehouse' },
22+
{ name: 'Create orders', value: 'createOrders' },
23+
{ name: 'Manage orders', value: 'manageOrders' }
24+
]
25+
}
26+
]
27+
}
28+
})
29+
</script>
Lines changed: 34 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,34 @@
1+
# FieldChecklist
2+
> `FieldChecklist` is a field composed of multiple checkboxes where each checkbox has their own label and value
3+
4+
### type `checklist`
5+
6+
<script setup>
7+
import FieldChecklistExample from '/components/examples/fields/FieldChecklistExample.vue'
8+
</script>
9+
10+
## Basic example
11+
::: details Code
12+
```js
13+
{
14+
name: 'activePermissions',
15+
label: 'Active permissions',
16+
model: 'permissions',
17+
type: 'checklist',
18+
options: [
19+
{ name: 'Manage warehouse', value: 'manageWarehouse' },
20+
{ name: 'Create orders', value: 'createOrders' },
21+
{ name: 'Manage orders', value: 'manageOrders' }
22+
]
23+
}
24+
```
25+
:::
26+
<FieldChecklistExample />
27+
28+
## Properties
29+
::: details Shared properties
30+
<!--@include: @/parts/shared-field-properties.md-->
31+
:::
32+
| Property | Default | Type | Description |
33+
|----------|---------|------------|--------------------|
34+
| options | `[]` | `Option[]` | Selectable options |

0 commit comments

Comments
 (0)