Skip to content

Commit 164aa97

Browse files
committed
docs: enhance param documentation for boolean and select types
1 parent 2207f5c commit 164aa97

File tree

1 file changed

+9
-11
lines changed
  • src/routes/(documentation)/docs/get-started/params

1 file changed

+9
-11
lines changed

src/routes/(documentation)/docs/get-started/params/params.md

Lines changed: 9 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -61,13 +61,14 @@ Creates a number input field.
6161

6262
### Boolean
6363

64-
Creates a checkbox input.
64+
Creates a checkbox or toggle switch input.
6565

6666
```javascript
6767
{
6868
name: 'isActive',
6969
type: 'boolean',
70-
label: 'Active'
70+
label: 'Active',
71+
variant: 'checkbox' // 'checkbox' (default) or 'toggle' for switch display
7172
}
7273
```
7374

@@ -89,22 +90,18 @@ Creates a color picker.
8990

9091
### Select
9192

92-
Creates a dropdown menu with predefined options.
93-
94-
**Simple Array:**
93+
Creates a dropdown menu or radio button group with predefined options.
9594

9695
```javascript
9796
{
9897
name: 'size',
9998
type: 'select',
10099
label: 'Size',
101-
options: ['small', 'medium', 'large']
100+
variant: 'dropdown', // 'dropdown' (default) or 'radio' for radio buttons
101+
options: ['small', 'medium', 'large'] // Simple string array
102102
}
103-
```
104103

105-
**With Labels and Values:**
106-
107-
```javascript
104+
// With labels and values:
108105
{
109106
name: 'variant',
110107
type: 'select',
@@ -188,10 +185,11 @@ Creates a complex form for arrays of objects with defined schemas. Perfect for m
188185
## Properties Reference
189186

190187
| Property | Required | Used In | Description |
191-
| --- | --- | --- |
188+
| --- | --- | --- | --- |
192189
| `name` | Yes | All types | The property name to bind to. |
193190
| `type` | Yes | All types | The param type (text, number, boolean, etc.). |
194191
| `label` | No | All types | Display name in the UI (defaults to name). |
192+
| `variant` | No | boolean, select | Display variant: `checkbox`/`toggle` for boolean, `dropdown`/`radio` for select. |
195193
| `options` | Yes | select | Array of options (strings or `{label, value}` objects). |
196194
| `schema` | Yes | object, objectrenderer | Defines the structure of nested fields. |
197195
| `placeholder` | No | In schema | Placeholder text for input fields. |

0 commit comments

Comments
 (0)