Form

Numeric Input

A numeric input allows users to enter and edit numerical values, either manually or using an input stepper.
1
import {NumericInputConnected} from '@coveord/plasma-react';
2
3
export default () => (
4
<NumericInputConnected
5
id="numeric-1"
6
initialValue={500}
7
step={50}
8
min={25}
9
max={950}
10
maxLength={3}
11
invalidMessage="The value must be between 25 and 950."
12
/>
13
);

Props

NameTypeDefaultDescription
idrequiredstring
A unique identifier that identifies the NumericInput in the PlasmaState
"aria-activedescendant"string
Identifies the currently active element when DOM focus is on a composite widget, textbox, group, or application.
"aria-atomic"Booleanish
Indicates whether assistive technologies will present all, or only parts of, the changed region based on the change notifications defined by the aria-relevant attribute.
"aria-autocomplete""list" | "none" | "inline" | "both"
Indicates whether inputting text could trigger display of one or more predictions of the user's intended value for an input and specifies how predictions would be presented if they are made.
"aria-busy"Booleanish
Indicates an element is being modified and that assistive technologies MAY want to wait until the modifications are complete before exposing them to the user.
"aria-checked"boolean | "true" | "false" | "mixed"
Indicates the current "checked" state of checkboxes, radio buttons, and other widgets.
"aria-colcount"number
Defines the total number of columns in a table, grid, or treegrid.
"aria-colindex"number
Defines an element's column index or position with respect to the total number of columns within a table, grid, or treegrid.
"aria-colspan"number
Defines the number of columns spanned by a cell or gridcell within a table, grid, or treegrid.
"aria-controls"string
Identifies the element (or elements) whose contents or presence are controlled by the current element.
"aria-current"boolean | "step" | "true" | "false" | "page" | "location" | "date" | "time"
Indicates the element that represents the current item within a container or set of related elements.
"aria-describedby"string
Identifies the element (or elements) that describes the object.
"aria-details"string
Identifies the element that provides a detailed, extended description for the object.
"aria-disabled"Booleanish
Indicates that the element is perceivable but disabled, so it is not editable or otherwise operable.
"aria-errormessage"string
Identifies the element that provides an error message for the object.
"aria-expanded"Booleanish
Indicates whether the element, or another grouping element it controls, is currently expanded or collapsed.
"aria-flowto"string
Identifies the next element (or elements) in an alternate reading order of content which, at the user's discretion, allows assistive technology to override the general default of reading in document source order.
"aria-haspopup"boolean | "true" | "false" | "dialog" | "grid" | "listbox" | "menu" | "tree"
Indicates the availability and type of interactive popup element, such as menu or dialog, that can be triggered by an element.
"aria-hidden"Booleanish
Indicates whether the element is exposed to an accessibility API.
"aria-invalid"boolean | "true" | "false" | "grammar" | "spelling"
Indicates the entered value does not conform to the format expected by the application.
"aria-keyshortcuts"string
Indicates keyboard shortcuts that an author has implemented to activate or give focus to an element.
"aria-label"string
Defines a string value that labels the current element.
"aria-labelledby"string
Identifies the element (or elements) that labels the current element.
"aria-level"number
Defines the hierarchical level of an element within a structure.
"aria-live""off" | "assertive" | "polite"
Indicates that an element will be updated, and describes the types of updates the user agents, assistive technologies, and user can expect from the live region.
"aria-modal"Booleanish
Indicates whether an element is modal when displayed.
"aria-multiline"Booleanish
Indicates whether a text box accepts multiple lines of input or only a single line.
"aria-multiselectable"Booleanish
Indicates that the user may select more than one item from the current selectable descendants.
"aria-orientation""horizontal" | "vertical"
Indicates whether the element's orientation is horizontal, vertical, or unknown/ambiguous.
"aria-owns"string
Identifies an element (or elements) in order to define a visual, functional, or contextual parent/child relationship between DOM elements where the DOM hierarchy cannot be used to represent the relationship.
"aria-placeholder"string
Defines a short hint (a word or short phrase) intended to aid the user with data entry when the control has no value. A hint could be a sample value or a brief description of the expected format.
"aria-posinset"number
Defines an element's number or position in the current set of listitems or treeitems. Not required if all elements in the set are present in the DOM.
"aria-pressed"boolean | "true" | "false" | "mixed"
Indicates the current "pressed" state of toggle buttons.
"aria-readonly"Booleanish
Indicates that the element is not editable, but is otherwise operable.
"aria-relevant""text" | "additions" | "additions removals" | "additions text" | "all" | "removals" | "removals additions" | "removals text" | "text additions" | "text removals"
Indicates what notifications the user agent will trigger when the accessibility tree within a live region is modified.
"aria-required"Booleanish
Indicates that user input is required on the element before a form may be submitted.
"aria-roledescription"string
Defines a human-readable, author-localized description for the role of an element.
"aria-rowcount"number
Defines the total number of rows in a table, grid, or treegrid.
"aria-rowindex"number
Defines an element's row index or position with respect to the total number of rows within a table, grid, or treegrid.
"aria-rowspan"number
Defines the number of rows spanned by a cell or gridcell within a table, grid, or treegrid.
"aria-selected"Booleanish
Indicates the current "selected" state of various widgets.
"aria-setsize"number
Defines the number of items in the current set of listitems or treeitems. Not required if all elements in the set are present in the DOM.
"aria-sort""none" | "ascending" | "descending" | "other"
Indicates if items in a table or grid are sorted in ascending or descending order.
"aria-valuemax"number
Defines the maximum allowed value for a range widget.
"aria-valuemin"number
Defines the minimum allowed value for a range widget.
"aria-valuenow"number
Defines the current value for a range widget.
"aria-valuetext"string
Defines the human readable text alternative of aria-valuenow for a range widget.
aboutstring
acceptstring
acceptCharsetstring
accessKeystring
actionstring
allowFullScreenboolean
allowTransparencyboolean
altstring
asstring
asyncboolean
autoCapitalizestring
autoCompletestring
autoCorrectstring
autoFocusboolean
autoPlayboolean
autoSavestring
captureboolean | "user" | "environment"
cellPaddingstring | number
cellSpacingstring | number
challengestring
charSetstring
checkedboolean
childrenReactNode
citestring
classIDstring
classNamestring
colorstring
colsnumber
colSpannumber
contentstring
contentEditableBooleanish | "inherit"
contextMenustring
controlsboolean
coordsstring
crossOriginstring
dangerouslySetInnerHTML{ __html: string; }
datastring
datatypestring
dateTimestring
defaultboolean
defaultCheckedboolean
defaultValuestring | number | readonly string[]
deferboolean
dirstring
disabledboolean
downloadany
draggableBooleanish
encTypestring
formstring
formActionstring
formEncTypestring
formMethodstring
formNoValidateboolean
formTargetstring
frameBorderstring | number
hasErrorboolean
headersstring
heightstring | number
hiddenboolean
highnumber
hrefstring
hrefLangstring
htmlForstring
httpEquivstring
initialValuenumber
The initial value
inlistany
inputMode"none" | "search" | "text" | "tel" | "url" | "email" | "numeric" | "decimal"
Hints at the type of data that might be entered by the user while editing the element or its contents
integritystring
invalidMessagestring'Value is not valid'
The error message displayed when the value manually inputed is outside the specified limits
isstring
Specify that a standard HTML element should behave like a defined custom built-in element
itemIDstring
itemPropstring
itemRefstring
itemScopeboolean
itemTypestring
keyKey
keyParamsstring
keyTypestring
kindstring
labelstring
langstring
liststring
loopboolean
lownumber
manifeststring
marginHeightnumber
marginWidthnumber
maxnumber
The upper limit (inclusive)
maxLengthnumber12
The width of the input box in number of digits [1..20]
mediastring
mediaGroupstring
methodstring
minnumber
The lower limit (inclusive)
minLengthnumber
mount(value: number) => void
multipleboolean
mutedboolean
namestring
noncestring
noValidateboolean
onAbortReactEventHandler<HTMLInputElement>
onAbortCaptureReactEventHandler<HTMLInputElement>
onAnimationEndAnimationEventHandler<HTMLInputElement>
onAnimationEndCaptureAnimationEventHandler<HTMLInputElement>
onAnimationIterationAnimationEventHandler<HTMLInputElement>
onAnimationIterationCaptureAnimationEventHandler<HTMLInputElement>
onAnimationStartAnimationEventHandler<HTMLInputElement>
onAnimationStartCaptureAnimationEventHandler<HTMLInputElement>
onAuxClickMouseEventHandler<HTMLInputElement>
onAuxClickCaptureMouseEventHandler<HTMLInputElement>
onBeforeInputFormEventHandler<HTMLInputElement>
onBeforeInputCaptureFormEventHandler<HTMLInputElement>
onBlurFocusEventHandler<HTMLInputElement>
onBlurCaptureFocusEventHandler<HTMLInputElement>
onCanPlayReactEventHandler<HTMLInputElement>
onCanPlayCaptureReactEventHandler<HTMLInputElement>
onCanPlayThroughReactEventHandler<HTMLInputElement>
onCanPlayThroughCaptureReactEventHandler<HTMLInputElement>
onChangeFormEventHandler<HTMLInputElement>
onChangeCaptureFormEventHandler<HTMLInputElement>
onClickMouseEventHandler<HTMLInputElement>
onClickCaptureMouseEventHandler<HTMLInputElement>
onCompositionEndCompositionEventHandler<HTMLInputElement>
onCompositionEndCaptureCompositionEventHandler<HTMLInputElement>
onCompositionStartCompositionEventHandler<HTMLInputElement>
onCompositionStartCaptureCompositionEventHandler<HTMLInputElement>
onCompositionUpdateCompositionEventHandler<HTMLInputElement>
onCompositionUpdateCaptureCompositionEventHandler<HTMLInputElement>
onContextMenuMouseEventHandler<HTMLInputElement>
onContextMenuCaptureMouseEventHandler<HTMLInputElement>
onCopyClipboardEventHandler<HTMLInputElement>
onCopyCaptureClipboardEventHandler<HTMLInputElement>
onCutClipboardEventHandler<HTMLInputElement>
onCutCaptureClipboardEventHandler<HTMLInputElement>
onDoubleClickMouseEventHandler<HTMLInputElement>
onDoubleClickCaptureMouseEventHandler<HTMLInputElement>
onDragDragEventHandler<HTMLInputElement>
onDragCaptureDragEventHandler<HTMLInputElement>
onDragEndDragEventHandler<HTMLInputElement>
onDragEndCaptureDragEventHandler<HTMLInputElement>
onDragEnterDragEventHandler<HTMLInputElement>
onDragEnterCaptureDragEventHandler<HTMLInputElement>
onDragExitDragEventHandler<HTMLInputElement>
onDragExitCaptureDragEventHandler<HTMLInputElement>
onDragLeaveDragEventHandler<HTMLInputElement>
onDragLeaveCaptureDragEventHandler<HTMLInputElement>
onDragOverDragEventHandler<HTMLInputElement>
onDragOverCaptureDragEventHandler<HTMLInputElement>
onDragStartDragEventHandler<HTMLInputElement>
onDragStartCaptureDragEventHandler<HTMLInputElement>
onDropDragEventHandler<HTMLInputElement>
onDropCaptureDragEventHandler<HTMLInputElement>
onDurationChangeReactEventHandler<HTMLInputElement>
onDurationChangeCaptureReactEventHandler<HTMLInputElement>
onEmptiedReactEventHandler<HTMLInputElement>
onEmptiedCaptureReactEventHandler<HTMLInputElement>
onEncryptedReactEventHandler<HTMLInputElement>
onEncryptedCaptureReactEventHandler<HTMLInputElement>
onEndedReactEventHandler<HTMLInputElement>
onEndedCaptureReactEventHandler<HTMLInputElement>
onErrorReactEventHandler<HTMLInputElement>
onErrorCaptureReactEventHandler<HTMLInputElement>
onFocusFocusEventHandler<HTMLInputElement>
onFocusCaptureFocusEventHandler<HTMLInputElement>
onGotPointerCapturePointerEventHandler<HTMLInputElement>
onGotPointerCaptureCapturePointerEventHandler<HTMLInputElement>
onInputFormEventHandler<HTMLInputElement>
onInputCaptureFormEventHandler<HTMLInputElement>
onInvalidFormEventHandler<HTMLInputElement>
onInvalidCaptureFormEventHandler<HTMLInputElement>
onKeyDownKeyboardEventHandler<HTMLInputElement>
onKeyDownCaptureKeyboardEventHandler<HTMLInputElement>
onKeyUpKeyboardEventHandler<HTMLInputElement>
onKeyUpCaptureKeyboardEventHandler<HTMLInputElement>
onLoadReactEventHandler<HTMLInputElement>
onLoadCaptureReactEventHandler<HTMLInputElement>
onLoadedDataReactEventHandler<HTMLInputElement>
onLoadedDataCaptureReactEventHandler<HTMLInputElement>
onLoadedMetadataReactEventHandler<HTMLInputElement>
onLoadedMetadataCaptureReactEventHandler<HTMLInputElement>
onLoadStartReactEventHandler<HTMLInputElement>
onLoadStartCaptureReactEventHandler<HTMLInputElement>
onLostPointerCapturePointerEventHandler<HTMLInputElement>
onLostPointerCaptureCapturePointerEventHandler<HTMLInputElement>
onMouseDownMouseEventHandler<HTMLInputElement>
onMouseDownCaptureMouseEventHandler<HTMLInputElement>
onMouseEnterMouseEventHandler<HTMLInputElement>
onMouseLeaveMouseEventHandler<HTMLInputElement>
onMouseMoveMouseEventHandler<HTMLInputElement>
onMouseMoveCaptureMouseEventHandler<HTMLInputElement>
onMouseOutMouseEventHandler<HTMLInputElement>
onMouseOutCaptureMouseEventHandler<HTMLInputElement>
onMouseOverMouseEventHandler<HTMLInputElement>
onMouseOverCaptureMouseEventHandler<HTMLInputElement>
onMouseUpMouseEventHandler<HTMLInputElement>
onMouseUpCaptureMouseEventHandler<HTMLInputElement>
onPasteClipboardEventHandler<HTMLInputElement>
onPasteCaptureClipboardEventHandler<HTMLInputElement>
onPauseReactEventHandler<HTMLInputElement>
onPauseCaptureReactEventHandler<HTMLInputElement>
onPlayReactEventHandler<HTMLInputElement>
onPlayCaptureReactEventHandler<HTMLInputElement>
onPlayingReactEventHandler<HTMLInputElement>
onPlayingCaptureReactEventHandler<HTMLInputElement>
onPointerCancelPointerEventHandler<HTMLInputElement>
onPointerCancelCapturePointerEventHandler<HTMLInputElement>
onPointerDownPointerEventHandler<HTMLInputElement>
onPointerDownCapturePointerEventHandler<HTMLInputElement>
onPointerEnterPointerEventHandler<HTMLInputElement>
onPointerEnterCapturePointerEventHandler<HTMLInputElement>
onPointerLeavePointerEventHandler<HTMLInputElement>
onPointerLeaveCapturePointerEventHandler<HTMLInputElement>
onPointerMovePointerEventHandler<HTMLInputElement>
onPointerMoveCapturePointerEventHandler<HTMLInputElement>
onPointerOutPointerEventHandler<HTMLInputElement>
onPointerOutCapturePointerEventHandler<HTMLInputElement>
onPointerOverPointerEventHandler<HTMLInputElement>
onPointerOverCapturePointerEventHandler<HTMLInputElement>
onPointerUpPointerEventHandler<HTMLInputElement>
onPointerUpCapturePointerEventHandler<HTMLInputElement>
onProgressReactEventHandler<HTMLInputElement>
onProgressCaptureReactEventHandler<HTMLInputElement>
onRateChangeReactEventHandler<HTMLInputElement>
onRateChangeCaptureReactEventHandler<HTMLInputElement>
onResetFormEventHandler<HTMLInputElement>
onResetCaptureFormEventHandler<HTMLInputElement>
onResizeReactEventHandler<HTMLInputElement>
onResizeCaptureReactEventHandler<HTMLInputElement>
onScrollUIEventHandler<HTMLInputElement>
onScrollCaptureUIEventHandler<HTMLInputElement>
onSeekedReactEventHandler<HTMLInputElement>
onSeekedCaptureReactEventHandler<HTMLInputElement>
onSeekingReactEventHandler<HTMLInputElement>
onSeekingCaptureReactEventHandler<HTMLInputElement>
onSelectReactEventHandler<HTMLInputElement>
onSelectCaptureReactEventHandler<HTMLInputElement>
onStalledReactEventHandler<HTMLInputElement>
onStalledCaptureReactEventHandler<HTMLInputElement>
onSubmitFormEventHandler<HTMLInputElement>
onSubmitCaptureFormEventHandler<HTMLInputElement>
onSuspendReactEventHandler<HTMLInputElement>
onSuspendCaptureReactEventHandler<HTMLInputElement>
onTimeUpdateReactEventHandler<HTMLInputElement>
onTimeUpdateCaptureReactEventHandler<HTMLInputElement>
onTouchCancelTouchEventHandler<HTMLInputElement>
onTouchCancelCaptureTouchEventHandler<HTMLInputElement>
onTouchEndTouchEventHandler<HTMLInputElement>
onTouchEndCaptureTouchEventHandler<HTMLInputElement>
onTouchMoveTouchEventHandler<HTMLInputElement>
onTouchMoveCaptureTouchEventHandler<HTMLInputElement>
onTouchStartTouchEventHandler<HTMLInputElement>
onTouchStartCaptureTouchEventHandler<HTMLInputElement>
onTransitionEndTransitionEventHandler<HTMLInputElement>
onTransitionEndCaptureTransitionEventHandler<HTMLInputElement>
onVolumeChangeReactEventHandler<HTMLInputElement>
onVolumeChangeCaptureReactEventHandler<HTMLInputElement>
onWaitingReactEventHandler<HTMLInputElement>
onWaitingCaptureReactEventHandler<HTMLInputElement>
onWheelWheelEventHandler<HTMLInputElement>
onWheelCaptureWheelEventHandler<HTMLInputElement>
openboolean
optimumnumber
patternstring
placeholderstring
playsInlineboolean
posterstring
prefixstring
preloadstring
propertystring
radioGroupstring
readOnlyboolean
refLegacyRef<HTMLInputElement>
relstring
requiredboolean
resourcestring
resultsnumber
reversedboolean
roleAriaRole
rowsnumber
rowSpannumber
sandboxstring
scopestring
scopedboolean
scrollingstring
seamlessboolean
securitystring
selectedboolean
setValue(value: string | number) => void
shapestring
sizenumber
sizesstring
slotstring
spannumber
spellCheckBooleanish
srcstring
srcDocstring
srcLangstring
srcSetstring
startnumber
stepnumber
The amount by which the buttons will add or substract
styleCSSProperties
summarystring
suppressContentEditableWarningboolean
suppressHydrationWarningboolean
tabIndexnumber
targetstring
titlestring
translate"yes" | "no"
typestring
typeofstring
unmount() => void
unselectable"on" | "off"
useMapstring
valueReactText & (string | number | readonly string[])
vocabstring
widthstring | number
wmodestring
wrapstring
"aria-dropeffect"deprecated"link" | "none" | "copy" | "execute" | "move" | "popup"
in ARIA 1.1
Indicates what functions can be performed when a dragged object is released on the drop target.
"aria-grabbed"deprecatedBooleanish
in ARIA 1.1
Indicates an element's "grabbed" state in a drag-and-drop operation.
onKeyPressdeprecatedKeyboardEventHandler<HTMLInputElement>
onKeyPressCapturedeprecatedKeyboardEventHandler<HTMLInputElement>

Examples

Disabled
1
import {NumericInputConnected} from '@coveord/plasma-react';
2
3
export default () => <NumericInputConnected id="numeric-2" initialValue={100} disabled />;

No guidelines exist for NumericInputConnected yet.

Create guidelines