JavaScript/jQuery NumberBox Options

See Also

The value of this property will be passed to the accesskey attribute of the HTML element that underlies the UI component.

The UI component switches to the active state when users press down the primary mouse button. When this property is set to true, the CSS rules for the active state apply. You can change these rules to customize the component.

Use this property when you display the component on a platform whose guidelines include the active state change for UI components.

Built-in buttons should also be declared in this array. You can find an example in the following demo:

View Demo

View Demo

The format property can accept the following value types:

• Predefined format

  JavaScript

  const number = 1.2345;
  
  type: "fixedPoint" // 1
  type: "decimal" // 1.2345
  type: "percent" // 123%
  type: "currency" // $1

  You can specify the precision property for fractional numbers.

  If you want to apply a different format, you can implement the formatter and parser functions or specify a custom format string as described below. For example, you can use this functionality to enable large number formats.

• Custom format string

  Use Unicode Locale Data Markup Language (LDML) patterns to specify a custom format string. An LDML pattern consists of wildcard characters and characters displayed as is. The format property supports the following wildcard characters:

  Format character	Description
  0	A digit. Displays '0' if the formatted number does not have a digit in that position.
  #	Up to 15 of leading digits, a single digit, or nothing. If this character goes first in the format string, it can match multiple leading digits (before the decimal point). Subsequent characters match a single digit. If the formatted number does not have a digit in the corresponding position, it displays nothing. For example, if you apply format "#0.#" to "123.45", the result is "123.4".
  .	A decimal separator. Actual character depends on locale.
  ,	A group separator. Actual character depends on locale.
  %	The percent sign. Multiplies the input value by 100.
  ;	Separates positive and negative format patterns. For example, the "#0.##;(#0.##)" format displays a positive number according to the pattern before the semicolon (";"), and a negative number according to the pattern after the semicolon (";"). If you do not use this character and the additional pattern, negative numbers display a minus ("-") prefix.
  Escape characters	You can display the special characters above as literals if you enclose them in single quotation marks. For example, '%'.
  Other characters	You can add any literal characters to the beginning or end of the format string.

  The examples below demonstrate the behavior of "#" and "0" in fractional numbers:

  JavaScript

  const number = 1234.567;
  
  // Leave the first digit before the decimal point and round up the decimal
  format: "0.0" // 4.6
  
  const smallNumber = 0.1234;
  
  // Display nothing in place of a digit
  format: "#.#" // .1
  
  const largeNumber = 123456.789;
  
  // Add a group separator
  format: ",##0.###" // 123,456.789

  The examples below show different ways to apply percentage formatting to decimals. Use caution if your format string starts with a zero ('0'), because the formatted number may lose leading digits.

  JavaScript

  const smallNumber = 0.01234;
  
  // Represent as a percentage and limit to two decimal digits
  format: "#0.##%" // 1.23%
  
  // Add a percent sign and limit to two decimal digits
  format: "#0.##'%'" // 0.01%

• Function
  A function should apply a custom format to a value and return the formatted value as a string. Functions are useful for advanced formatting. Refer to the following article for more information: Custom Function.

• Object
  Full format configuration. The object structure is shown in the format API section.

See Also

• format

This property accepts a value of one of the following types:

• Number
  The height in pixels.

• String
  A CSS-accepted measurement of height. For example, "55px", "20vh", "80%", "inherit".

• Function (deprecated since v21.2)
  Refer to the W0017 warning description for information on how you can migrate to viewport units.

See Also

• Knockout Only - Validate a View Model
• validationErrors

See Also

• labelMode
• placeholder

This property can have one of the following values:

labelMode	Description	Illustration
"static"	The label is displayed above the input field.
"floating"	The label is used as a placeholder, but when the editor gets focus, the label moves to the position above the input field.
"hidden"	The label is hidden.

Specify this property if the UI component lies within an HTML form that will be submitted.

See Also

The following example shows how to subscribe to component property changes:

$(function() {
    $("#numberBoxContainer").dxNumberBox({
        // ...
        onOptionChanged: function(e) {
            if(e.name === "changedProperty") {
                // handle the property change here
            }
        }
    });
});

<dx-number-box ...
    (onOptionChanged)="handlePropertyChange($event)"> 
</dx-number-box>

import { Component } from '@angular/core'; 

@Component({ 
    selector: 'app-root', 
    templateUrl: './app.component.html', 
    styleUrls: ['./app.component.css'] 
}) 

export class AppComponent { 
    // ...
    handlePropertyChange(e) {
        if(e.name === "changedProperty") { 
            // handle the property change here
        }
    }
}

import { BrowserModule } from '@angular/platform-browser'; 
import { NgModule } from '@angular/core'; 
import { AppComponent } from './app.component'; 
import { DxNumberBoxModule } from 'devextreme-angular'; 

@NgModule({ 
    declarations: [ 
        AppComponent 
    ], 
    imports: [ 
        BrowserModule, 
        DxNumberBoxModule 
    ], 
    providers: [ ], 
    bootstrap: [AppComponent] 
}) 

export class AppModule { }  

<template> 
    <DxNumberBox ...
        @option-changed="handlePropertyChange"
    />            
</template> 

<script>  
import 'devextreme/dist/css/dx.light.css'; 
import DxNumberBox from 'devextreme-vue/number-box'; 

export default { 
    components: { 
        DxNumberBox
    }, 
    // ...
    methods: { 
        handlePropertyChange: function(e) {
            if(e.name === "changedProperty") {
                // handle the property change here
            }
        }
    } 
} 
</script> 

import React from 'react';  
import 'devextreme/dist/css/dx.light.css'; 

import NumberBox from 'devextreme-react/number-box'; 

const handlePropertyChange = (e) => {
    if(e.name === "changedProperty") {
        // handle the property change here
    }
}

export default function App() { 
    return ( 
        <NumberBox ...
            onOptionChanged={handlePropertyChange}
        />        
    ); 
} 

See Also

• valueChangeEvent

See Also

• label

When this property is set to true, the following applies:

• The editor's value cannot be changed using the UI.
• Built-in action buttons are invisible.

• Custom action buttons are visible but disabled. If a button should not be disabled, set its disabled property to false:

  jQuery

  index.js

  $(function() {
      $("#numberBoxContainer").dxNumberBox({
          // ...
          buttons: [{
              name: "myCustomButton",
              location: "after",
              options: {
                  onClick: function(e) {
                      // ...
                  },
                  disabled: false
              }
          }]
      });
  });

  Angular

  app.component.html

  app.component.ts

  app.module.ts

  <dx-number-box ... >
      <dxi-button
          name="myCustomButton"
          location="after"
          [options]="myCustomButtonConfig">
      </dxi-button>
  </dx-number-box>

  import { Component } from '@angular/core';
  
  @Component({
      selector: 'app-root',
      templateUrl: './app.component.html',
      styleUrls: ['./app.component.css']
  })
  export class AppComponent {
      myCustomButtonConfig = {
          onClick: (e) => {
              // ...
          },
          disabled: false
      };
  }

  import { BrowserModule } from '@angular/platform-browser';
  import { NgModule } from '@angular/core';
  import { AppComponent } from './app.component';
  
  import { DxNumberBoxModule } from 'devextreme-angular';
  
  @NgModule({
      declarations: [
          AppComponent
      ],
      imports: [
          BrowserModule,
          DxNumberBoxModule
      ],
      providers: [ ],
      bootstrap: [AppComponent]
  })
  export class AppModule { }

  Vue

  App.vue

  <template>
      <DxNumberBox ... >
          <DxNumberBoxButton
              name="myCustomButton"
              location="after"
              :options="myCustomButtonConfig"
          />
      </DxNumberBox>
  </template>
  
  <script>
  import 'devextreme/dist/css/dx.light.css';
  
  import DxNumberBox, {
      DxButton as DxNumberBoxButton
  } from 'devextreme-vue/number-box';
  
  export default {
      components: {
          DxNumberBox,
          DxNumberBoxButton
      },
      data() {
          return {
              myCustomButtonConfig: {
                  onClick: (e) => {
                      // ...
                  },
                  disabled: false
              }
          }
      }
  }
  </script>

  React

  App.js

  import React from 'react';
  
  import 'devextreme/dist/css/dx.light.css';
  
  import NumberBox, {
      Button as NumberBoxButton
  } from 'devextreme-react/number-box';
  
  class App extends React.Component {
      myCustomButtonConfig = {
          onClick: (e) => {
              // ...
          },
          disabled: false
      };
      render() {
          return (
              <NumberBox>
                  <NumberBoxButton
                      name="myCustomButton"
                      location="after"
                      options={this.myCustomButtonConfig}
                  />
              </NumberBox>
          );
      }
  }
  export default App;

  You can also hide a custom action button when the UI component becomes read-only. Set the button's visible property to false in the onOptionChanged function. To get the button, use the getButton(name) method:

  jQuery

  index.js

  $(function() {
      $("#numberBoxContainer").dxNumberBox({
          // ...
          buttons: [{
              name: "myCustomButton",
              // ...
          }],
          onOptionChanged: function(e) {
              if(e.name == "readOnly") {
                  const myButton = e.component.getButton("myCustomButton");
                  myButton.option("visible", !e.value); // Hide the button when readOnly: true
              }
          }
      });
  });

  Angular

  app.component.html

  app.component.ts

  app.module.ts

  <dx-number-box ...
      (onOptionChanged)="changeButtonState">
      <dxi-button
          name="myCustomButton"
          ...
      ></dxi-button>
  </dx-number-box>

  import { Component } from '@angular/core';
  
  @Component({
      selector: 'app-root',
      templateUrl: './app.component.html',
      styleUrls: ['./app.component.css']
  })
  export class AppComponent {
      changeButtonState(e) {
          if(e.name == 'readOnly') {
              let myButton = e.component.getButton('myCustomButton');
              myButton.option('visible', !e.value); // Hide the button when readOnly: true
          }
      }
  }

  import { BrowserModule } from '@angular/platform-browser';
  import { NgModule } from '@angular/core';
  import { AppComponent } from './app.component';
  
  import { DxNumberBoxModule } from 'devextreme-angular';
  
  @NgModule({
      declarations: [
          AppComponent
      ],
      imports: [
          BrowserModule,
          DxNumberBoxModule
      ],
      providers: [ ],
      bootstrap: [AppComponent]
  })
  export class AppModule { }

  Vue

  App.vue

  <template>
      <DxNumberBox ...
          @option-changed="changeButtonState">
          <DxNumberBoxButton
              name="myCustomButton"
              ...
          />
      </DxNumberBox>
  </template>
  
  <script>
  import 'devextreme/dist/css/dx.light.css';
  
  import DxNumberBox, {
      DxButton as DxNumberBoxButton
  } from 'devextreme-vue/number-box';
  
  export default {
      components: {
          DxNumberBox,
          DxNumberBoxButton
      },
      data() {
          return {
              // ...
          }
      },
      methods: {
          changeButtonState(e) {
              if(e.name == 'readOnly') {
                  let myButton = e.component.getButton('myCustomButton');
                  myButton.option('visible', !e.value); // Hide the button when readOnly: true
              }
          }
      }
  }
  </script>

  React

  App.js

  import React from 'react';
  
  import 'devextreme/dist/css/dx.light.css';
  
  import NumberBox, {
      Button as NumberBoxButton
  } from 'devextreme-react/number-box';
  
  class App extends React.Component {
      changeButtonState(e) {
          if(e.name == 'readOnly') {
              let myButton = e.component.getButton('myCustomButton');
              myButton.option('visible', !e.value); // Hide the button when readOnly: true
          }
      }
      render() {
          return (
              <NumberBox ...
                  onOptionChanged={this.changeButtonState}>
                  <NumberBoxButton
                      name="myCustomButton"
                      ...
                  />
              </NumberBox>
          );
      }
  }
  export default App;

When this property is set to true, the UI component text flows from right to left, and the layout of elements is reversed. To switch the entire application/site to the right-to-left representation, assign true to the rtlEnabled field of the object passed to the DevExpress.config(config) method.

DevExpress.config({
    rtlEnabled: true
});

DataGrid Demo Navigation UI Demo Editors Demo

The Clear button calls the reset method.

See Also

• useLargeSpinButtons

The following styles are available:

You can also use the global editorStylingMode setting to specify how the text fields of all editors in your application are styled.

The value of this property will be passed to the tabindex attribute of the HTML element that underlies the UI component.

See Also

• isValid

The following property values are possible:

• auto
  The tooltip with the message is displayed when the editor is in focus.
• always
  The tooltip with the message is not hidden when the editor loses focus.

The following table illustrates the validation status indicators:

validationStatus	Indicator
"pending"
"valid"
"invalid"

When you assign "invalid" to validationStatus, you can also use the validationErrors array to set an error message as shown below:

$(function() {
    const numberBox = $("#numberBoxContainer").dxNumberBox({
        // ...
    }).dxNumberBox("instance");

    function setInvalidStatus(message) {
        numberBox.option({
            validationStatus: "invalid",
            validationErrors: [{ message: message }]
        });
    }
});

<dx-number-box
    [validationStatus]="validationStatus"
    [validationErrors]="validationErrors">
</dx-number-box>

// ...
export class AppComponent {
    validationStatus: string = "valid";
    validationErrors: any;
    // ...
    setInvalidStatus(message) {
        this.validationStatus = "invalid";
        this.validationErrors = [{ message: message }];
    }
}

<template>
    <DxNumberBox ...
        :validation-status="validationStatus"
        :validation-errors="validationErrors"
    />
</template>

<script>
    // ...
    export default {
        // ...
        data() {
            return {
                validationStatus: "valid",
                validationErrors: []
            }
        },
        methods: {
            setInvalidStatus(message) {
                this.validationStatus = "invalid";
                this.validationErrors = [{ message: message }];
            }
        }
    }
</script>

import React, { useState } from 'react';
// ...

function App() {
    const [validationStatus, setValidationStatus] = useState("valid");
    const [validationErrors, setValidationErrors] = useState([]);

    const setInvalidStatus = message => {
        setValidationStatus("invalid");
        setValidationErrors([{ message: message }]);
    }

    return (
        <NumberBox
            validationStatus={validationStatus}
            validationErrors={validationErrors}
        />
    ); 

};
export default App;

See Also

• label

This property accepts a single event name or several names separated by spaces.

The recommended events are "keyup", "blur", "change", "input", and "focusout", but you can use other events as well.

See Also

• onValueChanged

This property accepts a value of one of the following types:

• Number
  The width in pixels.

• String
  A CSS-accepted measurement of width. For example, "55px", "20vw", "80%", "auto", "inherit".

• Function (deprecated since v21.2)
  Refer to the W0017 warning description for information on how you can migrate to viewport units.