Update widget documentation

This commit is contained in:
Daniel Lautzenheiser
2022-11-02 15:42:21 -04:00
parent fdd51aefa3
commit 6de5363f12
23 changed files with 618 additions and 332 deletions

View File

@ -4,25 +4,35 @@ title: Number
weight: 20
---
The number widget uses an HTML number input, saving the value as a string, integer, or floating point number.
## Overview
- **Name:** `number`
- **UI:** HTML [number input](https://developer.mozilla.org/en-US/docs/Web/HTML/Element/input/number)
- **Data type:** string by default; configured by `value_type` option
- **Options:**
- `default`: accepts string or number value; defaults to empty string
- `value_type`: accepts `int` or `float`; any other value results in saving as a string
- `min`: accepts a number for minimum value accepted; unset by default
- `max`: accepts a number for maximum value accepted; unset by default
- `step`: accepts a number for stepping up/down values in the input; 1 by default
- **Example:**
```yaml
- label: "Puppy Count"
title: "puppies"
widget: "number"
default: 2
value_type: "int"
min: 1
max: 101
step: 2
```
- **Data type:** `string` or `number`. Configured by `value_type` option
The number widget uses an HTML number input, saving the value as a string, integer, or floating point number.
## Widget options
For common options, see [Common widget options](/docs/widgets#common-widget-options).
| Name | Type | Default | Description |
| ---------- | ------------------------------------ | ---------- | ----------------------------------------------------------------------------------- |
| default | string<br />\| number | `''` | _Optional_. The default value for the field. Accepts a string or number |
| value_type | 'int'<br />\| 'float'<br />\| string | `'string'` | _Optional_. Accepts `int` or `float`; any other value results in saving as a string |
| min | number | | _Optional_. Minimum value accepted |
| max | number | | _Optional_. Maximum value accepted |
| step | number | `1` | _Optional_. Size of steps when stepping up or down in input |
## Example
```yaml
name: 'puppies'
label: 'Puppy Count'
widget: 'number'
default: 2
value_type: 'int'
min: 1
max: 101
step: 2
```