Forms

ParameterField

Numeric parameter editor that distinguishes an inherited base value from a local override and makes reset state explicit.

import { ParameterField } from '@lostgradient/cinder/parameter-field';
formnumeric
01

Overview

Displays an inherited base parameter and an optional local override. Overrides can be reset to the base value and may carry Unsaved or Experimental badges.

Use the default output for a read-only summary, or provide a child snippet to render a NumberInput, Slider, or another numeric editor. The snippet receives the effective value, whether it is overridden, and a setOverride callback.

Live preview
Timeout
30 seconds
02

When to use

Use when
  • Editing a numeric setting that inherits a default but can be overridden locally.
Avoid when
  • Collecting an independent numeric value with no inheritance semantics — use number-input or slider.
03

Examples

Parameter override

Show an inherited value with a local override.

04

Props

Props for parameter-field
NameTypeDefaultDescription
id required text Stable id used for label and output association.
label required text Visible parameter label.
base required number Inherited or default numeric value.
override bindable number Optional local numeric override. Bindable.
unit text Optional unit appended to the value and reset tooltip.
onOverrideChange (value: number | undefined) => void Called when the override changes or is reset.
unsaved boolean false Marks the current override as not yet persisted.
experimental boolean false Marks the parameter as experimental.
children snippet Optional custom numeric editor. Receives the effective value and override setter.