Parameter¶
An input control, or a read-only display, bound to one of the page's parameters.
Display widgets · widget type parameter · reads and writes $params
Related: Button · Data Table · Nav Link
Options¶
| Option | Values | Default | Description |
|---|---|---|---|
| Parameter | A page parameter | — | Which parameter this widget is bound to. The parameter itself is added to the page first |
| Mode | Input · Display | Input | An editable control, or a read-only value |
| Label / Description / Placeholder | Any text | Parameter name | What is shown around the control |
| Display Format | A format string | By type | Used in Display mode for numbers, dates and month ranges |
| Render as | Dropdown · Tabs | Dropdown | How a lookup parameter is presented |
| Tabs Orientation | Horizontal · Vertical | Horizontal | For lookup parameters rendered as tabs |
| Switch/Checkbox style | Switch · Checkbox | Switch | The control used for a switch parameter |
| Text | Any text | Empty | Trailing text beside a switch |
| Rows / Resizable | Number · On · Off | — | For multi-line text parameters |
| Disabled Expression | An expression | Empty | Disables the control when it resolves true |
| Variant and the per-part styles | Theme and CSS | From theme | Styling for the field, label, description, tabs, tags and validation message |
| Box Style | Sizing and spacing | — | The box around the control |
Notes¶
- The control shown follows the parameter's type — a date picker, a lookup, a switch, a text field — so change the parameter's type rather than looking for a control setting here
- The value lands in
$params.<name>, which any other widget on the page can read. See Page and Portal State - Required parameters show the marker and validation message automatically in Input mode