React Form - Customize Item

You can use the items[] array to configure all form items. This array can contain strings (formData field names) and objects (item configurations).

Use a string to create a simple item with default configuration as shown for the Email item.

Was this demo helpful?

Thank you!

Feel free to share demo-related thoughts here.
If you have technical questions, please create a support ticket in the DevExpress Support Center.

Thank you for the feedback!

TS JS

Backend API

import React, { useCallback } from 'react'; import { ValidationRule } from 'devextreme-react/common'; import { Form, Item, GroupItem, Label, FormTypes, } from 'devextreme-react/form'; import 'devextreme-react/text-area'; import service from './data.ts'; import LabelTemplate from './LabelTemplate.tsx'; import LabelNotesTemplate from './LabelNotesTemplate.tsx'; const employee = service.getEmployee(); const validationRules: { position: ValidationRule[], hireDate: ValidationRule[] } = { position: [ { type: 'required', message: 'Position is required.' }, ], hireDate: [ { type: 'required', message: 'Hire Date is required.' }, ], }; const nameEditorOptions = { disabled: true }; const positionEditorOptions = { items: service.getPositions(), searchEnabled: true, value: '' }; const hireDateEditorOptions = { width: '100%', value: null }; const birthDateEditorOptions = { width: '100%', disabled: true }; const notesEditorOptions = { height: 90, maxLength: 200 }; const phoneEditorOptions = { mask: '+1 (X00) 000-0000', maskRules: { X: /[02-9]/ } }; const App = () => { const validateForm = useCallback((e: FormTypes.ContentReadyEvent) => { e.component.validate(); }, []); return ( <Form onContentReady={validateForm} formData={employee}> <GroupItem colCount={2} caption="Employee Details"> <Item dataField="FirstName" editorOptions={nameEditorOptions}> <Label render={LabelTemplate('user')} /> </Item> <Item dataField="Position" editorType="dxSelectBox" editorOptions={positionEditorOptions} validationRules={validationRules.position}> <Label render={LabelTemplate('info')} /> </Item> <Item dataField="LastName" editorOptions={nameEditorOptions}> <Label render={LabelTemplate('user')} /> </Item> <Item dataField="HireDate" editorType="dxDateBox" editorOptions={hireDateEditorOptions} validationRules={validationRules.hireDate}> <Label render={LabelTemplate('event')} /> </Item> <Item dataField="BirthDate" editorType="dxDateBox" editorOptions={birthDateEditorOptions}> <Label render={LabelTemplate('event')} /> </Item> <Item dataField="Address"> <Label render={LabelTemplate('home')} /> </Item> <Item dataField="Notes" colSpan={2} editorType="dxTextArea" editorOptions={notesEditorOptions}> <Label render={LabelNotesTemplate} /> </Item> <Item dataField="Phone" editorOptions={phoneEditorOptions}> <Label render={LabelTemplate('tel')} /> </Item> <Item dataField="Email"> <Label render={LabelTemplate('email')} /> </Item> </GroupItem> </Form> ); }; export default App;

import React, { useCallback } from 'react'; import { Form, Item, GroupItem, Label, } from 'devextreme-react/form'; import 'devextreme-react/text-area'; import service from './data.js'; import LabelTemplate from './LabelTemplate.js'; import LabelNotesTemplate from './LabelNotesTemplate.js'; const employee = service.getEmployee(); const validationRules = { position: [{ type: 'required', message: 'Position is required.' }], hireDate: [{ type: 'required', message: 'Hire Date is required.' }], }; const nameEditorOptions = { disabled: true }; const positionEditorOptions = { items: service.getPositions(), searchEnabled: true, value: '' }; const hireDateEditorOptions = { width: '100%', value: null }; const birthDateEditorOptions = { width: '100%', disabled: true }; const notesEditorOptions = { height: 90, maxLength: 200 }; const phoneEditorOptions = { mask: '+1 (X00) 000-0000', maskRules: { X: /[02-9]/ } }; const App = () => { const validateForm = useCallback((e) => { e.component.validate(); }, []); return ( <Form onContentReady={validateForm} formData={employee} > <GroupItem colCount={2} caption="Employee Details" > <Item dataField="FirstName" editorOptions={nameEditorOptions} > <Label render={LabelTemplate('user')} /> </Item> <Item dataField="Position" editorType="dxSelectBox" editorOptions={positionEditorOptions} validationRules={validationRules.position} > <Label render={LabelTemplate('info')} /> </Item> <Item dataField="LastName" editorOptions={nameEditorOptions} > <Label render={LabelTemplate('user')} /> </Item> <Item dataField="HireDate" editorType="dxDateBox" editorOptions={hireDateEditorOptions} validationRules={validationRules.hireDate} > <Label render={LabelTemplate('event')} /> </Item> <Item dataField="BirthDate" editorType="dxDateBox" editorOptions={birthDateEditorOptions} > <Label render={LabelTemplate('event')} /> </Item> <Item dataField="Address"> <Label render={LabelTemplate('home')} /> </Item> <Item dataField="Notes" colSpan={2} editorType="dxTextArea" editorOptions={notesEditorOptions} > <Label render={LabelNotesTemplate} /> </Item> <Item dataField="Phone" editorOptions={phoneEditorOptions} > <Label render={LabelTemplate('tel')} /> </Item> <Item dataField="Email"> <Label render={LabelTemplate('email')} /> </Item> </GroupItem> </Form> ); }; export default App;

import React from 'react'; import { Tooltip } from 'devextreme-react/tooltip'; function LabelNotesTemplate(data) { return ( <React.Fragment> <div id="template-content"> <i id="helpedInfo" className="dx-icon dx-icon-info"></i> Additional <br /> { data.text } </div> <Tooltip target="#helpedInfo" showEvent="mouseenter" hideEvent="mouseleave" > <div id="tooltip-content">This field must not exceed 200 characters</div> </Tooltip> </React.Fragment> ); } export default LabelNotesTemplate;

import React from 'react'; export default function LabelTemplate(iconName: string) { return function template(data) { return (<div><i className={`dx-icon dx-icon-${iconName}`}></i>{ data.text }</div>); }; }

import React from 'react'; import ReactDOM from 'react-dom'; import App from './App.tsx'; ReactDOM.render( <App />, document.getElementById('app'), );

import React from 'react'; import { Tooltip } from 'devextreme-react/tooltip'; function LabelNotesTemplate(data) { return ( <React.Fragment> <div id="template-content"> <i id="helpedInfo" className="dx-icon dx-icon-info" ></i> Additional <br /> {data.text} </div> <Tooltip target="#helpedInfo" showEvent="mouseenter" hideEvent="mouseleave" > <div id="tooltip-content">This field must not exceed 200 characters</div> </Tooltip> </React.Fragment> ); } export default LabelNotesTemplate;

import React from 'react'; export default function LabelTemplate(iconName) { return function template(data) { return ( <div> <i className={`dx-icon dx-icon-${iconName}`}></i> {data.text} </div> ); }; }

import React from 'react'; import ReactDOM from 'react-dom'; import App from './App.js'; ReactDOM.render(<App />, document.getElementById('app'));

<!DOCTYPE html> <html lang="en"> <head> <title>DevExtreme Demo</title> <meta http-equiv="X-UA-Compatible" content="IE=edge" /> <meta http-equiv="Content-Type" content="text/html; charset=utf-8" /> <meta name="viewport" content="width=device-width, initial-scale=1.0, maximum-scale=5.0" /> <link rel="stylesheet" type="text/css" href="https://cdn3.devexpress.com/jslib/24.2.3/css/dx.light.css" /> <link rel="stylesheet" type="text/css" href="https://maxcdn.bootstrapcdn.com/font-awesome/4.6.3/css/font-awesome.min.css" /> <link rel="stylesheet" type="text/css" href="styles.css" /> <script src="https://unpkg.com/core-js@2.6.12/client/shim.min.js"></script> <script src="https://unpkg.com/systemjs@0.21.3/dist/system.js"></script> <script type="text/javascript" src="config.js"></script> <script type="text/javascript"> System.import("./index.tsx"); </script> </head> <body class="dx-viewport"> <div class="demo-container"> <div id="app"></div> </div> </body> </html>

#helpedInfo { color: #42a5f5; } #tooltip-content { font-size: 14px; font-weight: bold; } #template-content { display: inline-flex; }

To change the default settings, declare an item configuration object. Use the dataField property to bind an item to a field in the formData object. Use the editorType property to specify an item's data editor or configure the editor in the editorOptions object. You can also specify any other properties described in the SimpleItem section.

To customize item labels, use the label.template property. The demo uses this property to add icons to the labels. Refer to the Additional Notes item's implementation for instructions on how to add an icon with a tooltip to the label.

This demo shows how to specify editorOptions, editorType, validationRules, and colSpan properties for simple items in a Form component.