Copy page

@wocart/theme v4.1.0

---

@wocart/theme / index / NumberFieldDefinition

Interface: NumberFieldDefinition

number: a finite number, optionally bounded. With step, a value must lie on the grid that starts at min (or 0) — Shopify's range; an editor may show a slider.

Extends

• FieldDefinitionBase

Properties

default?

optional default?: number

---

description?

optional description?: LocalizedText

Editor-facing help text.

Inherited from

FieldDefinitionBase.description

---

display?

optional display?: "input" | "slider"

How an editor shows it: a box to type in (default) or a slider, which needs min, max and step.

---

key

key: string

The exact prop name the component expects.

Inherited from

FieldDefinitionBase.key

---

kind

kind: "number"

---

label

label: LocalizedText

Editor-facing name, the same in every language or translated.

Inherited from

FieldDefinitionBase.label

---

max?

optional max?: number

---

min?

optional min?: number

---

required?

optional required?: boolean

Inherited from

FieldDefinitionBase.required

---

step?

optional step?: number

---

visibleIf?

optional visibleIf?: FieldCondition

When an editor shows the field; absent: always. The renderer ignores it.

Inherited from

FieldDefinitionBase.visibleIf