NumberBox

The NumberBox is a widget that displays a numeric value and allows a user to modify it by typing in a value, and incrementing or decrementing it using the keyboard or mouse.

Included in: dx.mobile.js, dx.web.js, dx.viz-web.js, dx.all.js

Module: ui/number_box

$("#numberbox").dxNumberBox({

});

You can create the widget using one of the following approaches.

jQuery
Use the dxNumberBox jQuery plug-in.

HTML

<div id="numberBox"></div>

JavaScript

$("#numberBox").dxNumberBox({
    min: 0,
    max: 100,
    showSpinButtons: true,
    step: 5
});

Knockout
Add a div element and apply the dxNumberBox binding to this element.

HTML

<div data-bind="dxNumberBox: {
    min: 0,
    max: 100,
    showSpinButtons: true,
    step: 5
}"></div>

AngularJS
Add a div element and apply the dx-number-box directive to this element.

HTML

<div dx-number-box="{
    min: 0,
    max: 100,
    showSpinButtons: true,
    step: 5
}"></div>

Note that DevExtreme widgets require you to link the jQuery library to your application. If you use the Knockout or AngularJS approach, the Knockout or AngularJS library is also required. For detailed information on linking these libraries to your project, refer to the Installation article.

You can find detailed information on the principles of working with the widget in the dxNumberBox section of the Editor Widgets article.

View Demo

Configuration

An object defining configuration options for the NumberBox widget.

Name	Description
accessKey	Specifies a shortcut key that sets focus on the widget element.
activeStateEnabled	A Boolean value specifying whether or not the widget changes its state when interacting with a user.
attr	Specifies HTML attributes applied to the inner input element of the widget.
disabled	A Boolean value specifying whether or not the widget can respond to user interaction.
focusStateEnabled	Specifies whether or not the widget can be focused.
height	Specifies the height of the widget.
hint	Specifies the text of the hint displayed for the widget.
hoverStateEnabled	A Boolean value specifying whether or not the widget changes its state when being hovered by an end user.
invalidValueMessage	Specifies the text of the message displayed if the specified value is not a number.
isValid	Specifies whether the editor's value is valid.
max	The maximum value accepted by the number box.
min	The minimum value accepted by the number box.
mode	Specifies the value to be passed to the type attribute of the underlying `<input>` element.
onChange	A handler for the change event.
onCopy	A handler for the copy event.
onCut	A handler for the cut event.
onDisposing	A handler for the disposing event.
onEnterKey	A handler for the enterKey event.
onFocusIn	A handler for the focusIn event.
onFocusOut	A handler for the focusOut event.
onInitialized	A handler for the initialized event.
onInput	A handler for the input event.
onKeyDown	A handler for the keyDown event.
onKeyPress	A handler for the keyPress event.
onKeyUp	A handler for the keyUp event.
onOptionChanged	A handler for the optionChanged event.
onPaste	A handler for the paste event.
onValueChanged	A handler for the valueChanged event.
placeholder	The text displayed by the widget when the widget value is empty.
readOnly	A Boolean value specifying whether or not the widget is read-only.
rtlEnabled	Specifies whether or not the current component supports a right-to-left representation.
showClearButton	Specifies whether to display the Clear button in the widget.
showSpinButtons	Specifies whether or not to show spin buttons.
step	Specifies by which value the widget value changes when a spin button is clicked.
tabIndex	Specifies the widget tab index.
text	The read-only option that holds the text displayed by the widget input element.
validationError	Holds the object that defines the error that occurred during validation.
validationMessageMode	Specifies how the message about the validation rules that are not satisfied by this editor's value is displayed.
value	The current number box value.
valueChangeEvent	Specifies DOM event names that update a widget's value.
visible	A Boolean value specifying whether or not the widget is visible.
width	Specifies the width of the widget.

Methods

This section describes members used to manipulate the widget.

Name	Description
beginUpdate()	Prevents the component from refreshing until the endUpdate() method is called.
blur()	Removes focus from the input element.
defaultOptions(rule)	Specifies the device-dependent default configuration options for this component.
element()	Returns the root HTML element of the widget.
endUpdate()	Enables the component to refresh after the beginUpdate() method call.
focus()	Sets focus to the input element representing the widget.
instance()	Returns an instance of this component class.
off(eventName)	Detaches all event handlers from the specified event.
off(eventName, eventHandler)	Detaches a particular event handler from the specified event.
on(eventName, eventHandler)	Subscribes to a specified event.
on(events)	Subscribes to the specified events.
option()	Returns the configuration options of this component.
option(optionName)	Gets the value of the specified configuration option of this component.
option(optionName, optionValue)	Sets a value to the specified configuration option of this component.
option(options)	Sets one or more options of this component.
registerKeyHandler(key, handler)	Registers a handler when a specified key is pressed.
repaint()	Redraws the widget.
reset()	Resets the editor's value to undefined.

Events

This section describes events fired by this widget.

Name	Description
change	Fires when a change within the widget's input element is committed by an end user.
copy	Fires after the widget's input has been copied.
cut	Fires after the Cut DOM event has fired.
disposing	Fires when the widget is being removed.
enterKey	Fires after the Enter key has been pressed within the widget's input element.
focusIn	Fires after the widget's input has been focused.
focusOut	Fires after the widget's input element has lost focus.
initialized	Fires when the widget is initialized.
input	Fires when a value within the widget's input element is changed by an end user.
keyDown	Fires when a key is pressed down within the widget's input element.
keyPress	Fires when the keypress DOM event has been raised for the current input element.
keyUp	Fires when a key is released within the widget's input element.
optionChanged	Fires after an option of the component is changed.
paste	Fires after the widget's input has been pasted.
valueChanged	Fires when the editor value changes.

NumberBox

Configuration

Methods

Events

See Also