FooterEditableValue

A reading that can be typed into: the value as it is set, and a number field in its place while the reader is changing it.

@internote/canvas-sdk/reactComponent
On this page
import { FooterEditableValue } from '@internote/canvas-sdk/react';

A value on a slider is read far more often than it is set, so it is written as maths until the moment it is not. Enter and blur commit, and Escape puts the old value back.

The number field is there all the time, transparent over the reading, so a tap focuses it directly and raises the keyboard, as FooterMath's does.

#Props

Takes no className, style or id.

ariaLabelRequired
The accessible name of both the reading and the field.
string
disabled
Whether the value is only read: it does not open for typing.
boolean
displayRequired
How the value reads at rest — usually the maths it stands for.
ReactNode
max
The highest value a commit can give.
number
min
The lowest value a commit can give.
number
onCommitRequired
Called on Enter or blur with the typed number, clamped to min/max; not called for empty or non-numeric input.
(value: number) => void
step
The number field's step.
number
Default1
valueRequired
The current value, which the number field starts from.
number

Declared in packages/canvas-sdk/src/react/footer-notation.tsx:241.

Last updated