JavaScript/jQuery TextBox 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

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.

$(function(){
    $("#textBoxContainer").dxTextBox({
        // ...
        inputAttr: {
            id: "inputId"
        }
    });
});

<dx-text-box ...
    [inputAttr]="{ id: 'inputId' }">
</dx-text-box>

import { DxTextBoxModule } from "devextreme-angular";
// ...
export class AppComponent {
    // ...
}
@NgModule({
    imports: [
        // ...
        DxTextBoxModule
    ],
    // ...
})

<template>
    <DxTextBox
        :input-attr="inputAttr"
    />
</template>

<script>
import 'devextreme/dist/css/dx.light.css';

import DxTextBox from 'devextreme-vue/text-box';

export default {
    components: {
        DxTextBox
    },
    data() {
        return {
            inputAttr: { id: 'inputId' }
        }
    }
}
</script>

import 'devextreme/dist/css/dx.light.css';

import TextBox from 'devextreme-react/text-box';

const inputAttr = { id: 'inputId' };

export default function App() {
    return (
        <TextBox
            inputAttr={inputAttr}
        />
    );
}

@(Html.DevExtreme().TextBox()
    .InputAttr("id", "inputId")
    // ===== or =====
    .InputAttr(new {
        @id = "inputId"
    })
    // ===== or =====
    .InputAttr(new Dictionary<string, object>() {
        { "id", "inputId" }
    })
)

@(Html.DevExtreme().TextBox() _
    .InputAttr("id", "inputId")
    ' ===== or =====
    .InputAttr(New With {
        .id = "inputId"
    })
    ' ===== or =====
    .InputAttr(New Dictionary(Of String, Object) From {
        { "id", "inputId" }
    })
)

To improve accessibility, use this property to specify aria-label for the component.

$(function(){
    $("#textBoxContainer").dxTextBox({
        // ...
        inputAttr: {
            'aria-label': 'your-label',
        },
    });
});

<dx-text-box ...
    [inputAttr]="{ 'aria-label': 'your-label' }">
</dx-text-box>

<template>
    <DxTextBox
        :input-attr="inputAttr"
    />
</template>

<script>
import DxTextBox from 'devextreme-vue/text-box';

export default {
    components: {
        DxTextBox
    },
    data() {
        return {
            inputAttr: { 'aria-label': 'your-label' }
        }
    }
}
</script>

import TextBox from 'devextreme-react/text-box';

const inputAttr = { 'aria-label': 'your-label' };

export default function App() {
    return (
        <TextBox
            inputAttr={inputAttr}
        />
    );
}

You do not need to specify aria-label if you use label.

This property is a read-only flag. You can use it to check if the editor value changed.

$(() => {
    const textBox = $('#textBox').dxTextBox({
        // ...
    }).dxTextBox('instance');

    $('#button').dxButton({
        // ...
        onClick () {
            if (textBox.option('isDirty')) {
                DevExpress.ui.notify("Do not forget to save changes", "warning", 500);
            }
        }
    });
});

import { Component, ViewChild } from '@angular/core';
import { DxTextBoxComponent, DxButtonModule } from 'devextreme-angular';
import notify from 'devextreme/ui/notify';

@Component({
    selector: 'app-root',
    templateUrl: './app.component.html',
    styleUrls: ['./app.component.css']
})
export class AppComponent {
    @ViewChild('textBoxRef', { static: false }) textBox: DxTextBoxComponent;

    onClick () {
        if (this.textBox.instance.option('isDirty')) {
            notify("Do not forget to save changes", "warning", 500);
        }
    }
}

<dx-text-box ... 
    #textBoxRef
>
</dx-text-box>
<dx-button ...
    (onClick)="onClick($event)"
>
</dx-button>

<template>
    <DxTextBox ...
        :ref="textBoxRef"
    >
    </DxTextBox>
    <DxButton ...
        @click="onClick"
    />
</template>

<script>
import 'devextreme/dist/css/dx.light.css';
import DxTextBox from 'devextreme-vue/text-box';
import DxButton from 'devextreme-vue/button';
import notify from 'devextreme/ui/notify';

export default {
    components: {
        DxTextBox,
        DxButton
    },

    data() {
        return {
            textBoxRef
        }
    },

    methods: {
        onClick () {
            if (this.textBox.option('isDirty')) {
                notify("Do not forget to save changes", "warning", 500);
            }
        }
    },

    computed: {
        textBox: function() {
            return this.$refs[textBoxRef].instance;
        }
    }
}
</script>

import React, { useRef } from 'react';
import TextBox from 'devextreme-react/text-box';
import Button from 'devextreme-react/button';
import 'devextreme/dist/css/dx.light.css';

const App = () => {
    const textBoxRef = useRef(null);

    const onClick = () => {
        if (this.textBoxRef.current.instance().option('isDirty')) {
            notify("Do not forget to save changes", "warning", 500);
        }
    };

    return (
        <TextBox ...
            ref={textBoxRef}
        >
        </TextBox>
        <Button ...
            onClick={onClick}
        />
    );
};

export default App;

See Also

• reset

See Also

• validationErrors

See Also

• labelMode
• placeholder

This property can have one of the following values:

A mask can contain the following elements.

Each field of an object passed to this property corresponds to a single rule. A field name is a character used in a mask enclosed in quotes. A field accepts the following values.

const CustomMaskRules = {
    //a single character
    's': '$',

    // a regular expression
    'h': /[0-9A-F]/,

    // an array of characters
    'n': ['$', '%', '&', '@'],

    // a function
    'f': function(char) {
        const allowedChars = ['a', 'b', 'c', '$', '_', '.'];
        return allowedChars.includes(char);
     }
}

A function that specifies a custom rule accepts the following arguments:

• Entered character
• Index of the character within the full string
• Full string

The function should return true if the character is allowed, otherwise it should return false.

The following code snippet demonstrates the use of the function to set a dynamic mask. In this example, the mask enforces the correct input of time values:

$(function () {
    $("#textBox").dxTextBox({
        mask: "Hh:Mm",
        maskRules: {
            H: char => char >= 0 && char <= 2,
            h: (char, index, fullStr) => {
                if (fullStr[0] == '2')
                    return [0,1,2,3].includes(parseInt(char));
                else
                    return [0,1,2,3,4,5,6,7,8,9].includes(parseInt(char));
            },
            M: char => char >= 0 && char <= 5,
            m: char => char >= 0 && char <= 9
        }
    });
});

<dx-text-box
    mask="Hh:Mm"
    [maskRules]="rules">
</dx-text-box>

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

@Component({
    selector: 'app-root',
    templateUrl: './app.component.html',
    styleUrls: ['./app.component.css']
})
export class AppComponent {
    rules = {
        H: char => char >= 0 && char <= 2,
        h: (char, index, fullStr) => {
            if (fullStr[0] == '2')
                return [0,1,2,3].includes(parseInt(char));
            else
                return [0,1,2,3,4,5,6,7,8,9].includes(parseInt(char));
        },
        M: char => char >= 0 && char <= 5,
        m: char => char >= 0 && char <= 9
    }
}

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

import { DxTextBoxModule } from 'devextreme-angular';

@NgModule({
    declarations: [
        AppComponent
    ],
    imports: [
        BrowserModule,
        DxTextBoxModule
    ],
    providers: [ ],
    bootstrap: [AppComponent]
})
export class AppModule { }

<template>
    <DxTextBox
        mask="Hh:Mm"
        :mask-rules="rules"
    />
</template>

<script>
import 'devextreme/dist/css/dx.light.css';

import DxTextBox from 'devextreme-vue/text-box';

export default {
    components: {
        DxTextBox
    },
    data() {
        return {
            rules: {
                H: char => char >= 0 && char <= 2,
                h: (char, index, fullStr) => {
                    if (fullStr[0] == '2')
                        return [0,1,2,3].includes(parseInt(char));
                    else
                        return [0,1,2,3,4,5,6,7,8,9].includes(parseInt(char));
                },
                M: char => char >= 0 && char <= 5,
                m: char => char >= 0 && char <= 9
            }
        }
    }
}
</script>

import React from 'react';

import 'devextreme/dist/css/dx.light.css';

import TextBox from 'devextreme-react/text-box';

const rules = {
    H: char => char >= 0 && char <= 2,
    h: (char, index, fullStr) => {
        if (fullStr[0] == '2')
            return [0,1,2,3].includes(parseInt(char));
        else
            return [0,1,2,3,4,5,6,7,8,9].includes(parseInt(char));
    },
    M: char => char >= 0 && char <= 5,
    m: char => char >= 0 && char <= 9
};

const App = () => (
    <TextBox
        mask="Hh:Mm"
        maskRules={rules}   
    />
);

export default App;

If the number of entered characters reaches the value assigned to this property, the UI component does not allow you to enter any more characters.

The value of this property affects the set of keyboard buttons shown on the mobile device when the UI component gets focus. In addition, the following mode values add visual features to the UI component:

• "search" - the text box contains the "X" button, which clears the text box contents
• "password" - the text box shows a password character instead of the actual characters typed

View Demo

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

<dx-text-box ...
    (onInitialized)="saveInstance($event)">
</dx-text-box>

import { Component } from "@angular/core";
import TextBox from "devextreme/ui/data_grid";
// ...
export class AppComponent {
    textBoxInstance: TextBox;
    saveInstance (e) {
        this.textBoxInstance = e.component;
    }
}

<template>
    <div>
        <DxTextBox ...
            @initialized="saveInstance">
        </DxTextBox>
    </div>
</template>

<script>
import DxTextBox from 'devextreme-vue/text-box';

export default {
    components: {
        DxTextBox
    },
    data: function() {
        return {
            textBoxInstance: null
        };
    },
    methods: {
        saveInstance: function(e) {
            this.textBoxInstance = e.component;
        }
    }
};
</script>

<template>
    <div>
        <DxTextBox ...
            @initialized="saveInstance">
        </DxTextBox>
    </div>
</template>

<script setup>
import DxTextBox from 'devextreme-vue/text-box';

let textBoxInstance = null;

const saveInstance = (e) => {
    textBoxInstance = e.component;
}
</script>

import TextBox from 'devextreme-react/text-box';

class App extends React.Component {
    constructor(props) {
        super(props);

        this.saveInstance = this.saveInstance.bind(this);
    }

    saveInstance(e) {
        this.textBoxInstance = e.component;
    }

    render() {
        return (
            <div>
                <TextBox onInitialized={this.saveInstance} />
            </div>
        );
    }
}

See Also

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

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

<dx-text-box ...
    (onOptionChanged)="handlePropertyChange($event)"> 
</dx-text-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 { DxTextBoxModule } from 'devextreme-angular'; 

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

export class AppModule { }  

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

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

export default { 
    components: { 
        DxTextBox
    }, 
    // ...
    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 TextBox from 'devextreme-react/text-box'; 

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

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

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() {
      $("#textBoxContainer").dxTextBox({
          // ...
          buttons: [{
              name: "myCustomButton",
              location: "after",
              options: {
                  onClick: function(e) {
                      // ...
                  },
                  disabled: false
              }
          }]
      });
  });

  Angular

  app.component.html

  app.component.ts

  app.module.ts

  <dx-text-box ... >
      <dxi-button
          name="myCustomButton"
          location="after"
          [options]="myCustomButtonConfig">
      </dxi-button>
  </dx-text-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 { DxTextBoxModule } from 'devextreme-angular';
  
  @NgModule({
      declarations: [
          AppComponent
      ],
      imports: [
          BrowserModule,
          DxTextBoxModule
      ],
      providers: [ ],
      bootstrap: [AppComponent]
  })
  export class AppModule { }

  Vue

  App.vue

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

  React

  App.js

  import React from 'react';
  
  import 'devextreme/dist/css/dx.light.css';
  
  import TextBox, {
      Button as TextBoxButton
  } from 'devextreme-react/text-box';
  
  class App extends React.Component {
      myCustomButtonConfig = {
          onClick: (e) => {
              // ...
          },
          disabled: false
      };
      render() {
          return (
              <TextBox>
                  <TextBoxButton
                      name="myCustomButton"
                      location="after"
                      options={this.myCustomButtonConfig}
                  />
              </TextBox>
          );
      }
  }
  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() {
      $("#textBoxContainer").dxTextBox({
          // ...
          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-text-box ...
      (onOptionChanged)="changeButtonState">
      <dxi-button
          name="myCustomButton"
          ...
      ></dxi-button>
  </dx-text-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 { DxTextBoxModule } from 'devextreme-angular';
  
  @NgModule({
      declarations: [
          AppComponent
      ],
      imports: [
          BrowserModule,
          DxTextBoxModule
      ],
      providers: [ ],
      bootstrap: [AppComponent]
  })
  export class AppModule { }

  Vue

  App.vue

  <template>
      <DxTextBox ...
          @option-changed="changeButtonState">
          <DxTextBoxButton
              name="myCustomButton"
              ...
          />
      </DxTextBox>
  </template>
  
  <script>
  import 'devextreme/dist/css/dx.light.css';
  
  import DxTextBox, {
      DxButton as DxTextBoxButton
  } from 'devextreme-vue/text-box';
  
  export default {
      components: {
          DxTextBox,
          DxTextBoxButton
      },
      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 TextBox, {
      Button as TextBoxButton
  } from 'devextreme-react/text-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 (
              <TextBox ...
                  onOptionChanged={this.changeButtonState}>
                  <TextBoxButton
                      name="myCustomButton"
                      ...
                  />
              </TextBox>
          );
      }
  }
  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.

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.

If false, the value contains raw user input; if true, the value contains mask characters as well. This property applies only if a mask is specified.

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 example positions a validation message at the component's right:

$(function() {
    $("#textBoxContainer").dxTextBox({
        // ...
        validationMessagePosition: 'right'
    }).dxValidator({
        validationRules: [{
            type: 'required',
            message: 'Required',
        }],
    });
});

<dx-text-box ...
    validationMessagePosition="right">
    <dx-validator>
        <dxi-validation-rule
            type="required"
            message="Required"
        >
        </dxi-validation-rule>
    </dx-validator>
</dx-text-box>

<template>
    <DxTextBox ...
        validation-message-position="right"
    >
        <DxValidator>
            <DxRequiredRule message="Required" />
        </DxValidator>
    </DxTextBox>
</template>

<script>
    // ...
</script>

import React from 'react';
// ...

function App() {
    return (
        <TextBox ...
            validationMessagePosition="right"
        >
            <Validator>
                <RequiredRule message="Required" />
            </Validator>
        </TextBox>
    ); 

};
export default App;

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 textBox = $("#textBoxContainer").dxTextBox({
        // ...
    }).dxTextBox("instance");

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

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

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

<template>
    <DxTextBox ...
        :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 (
        <TextBox
            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.