Skip to content
Open
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
58 changes: 50 additions & 8 deletions content/collections/fieldtypes/range.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,25 +2,25 @@
title: Range
description: 'Choose a number between a min and max value.'
intro: |
Range fields let the user choose a numeric value which must be _no less_ than a given value, and _no more_ than another.
Range fields let the user choose a numeric value which must be _no less_ than a given value, and _no more_ than another. Supports both integer and decimal values.

screenshot: fieldtypes/screenshots/range.png
options:
-
name: min
type: integer
type: number
description: |
The minimum, left-most value. Default `0`.
The minimum, left-most value. Supports decimals. Default `0`.
-
name: max
type: integer
type: number
description: |
The maximum, left-most value. Default `1000`.
The maximum, right-most value. Supports decimals. Default `100`.
-
name: step
type: integer
type: number
description: |
The minimum size between values. Default `1`.
The minimum size between values. Supports decimals (e.g., `0.1` for tenths, `0.01` for hundredths). Default `1`.
-
name: append
type: string
Expand All @@ -36,12 +36,54 @@ id: 5ede219c-607e-4ad2-8498-6ca55a063e73
---
## Data Structure

The value is stored as an integer.
The value is stored as an integer or float, depending on your field configuration.

If your `min`, `max`, and `step` are all integers, the value will be stored as an integer:

``` yaml
number: 42
```

If any of `min`, `max`, or `step` contain decimal values, the value will be stored as a float:

``` yaml
opacity: 0.75
temperature: 21.5
```

## Example Configurations

### Integer Range (Default)

``` yaml
fields:
age:
type: range
min: 0
max: 100
step: 1
```

### Decimal Range

For values like percentages, opacity, or other decimal values:

``` yaml
fields:
opacity:
type: range
min: 0
max: 1
step: 0.1
append: '%'
temperature:
type: range
min: -10.5
max: 42.5
step: 0.5
append: '°C'
```

## Templating

Use the variable in your templates to display the value. That's pretty much it.
Expand Down