devextreme-form
Help developers use the DevExtreme Form component (dxForm) in Angular, React, Vue, and jQuery. Use when someone asks about Form configuration, formData binding, simple items, editor types, editorOptions, groups, columns, tabs, validation rules, form submission, runtime changes, custom item templates, Smart Paste, AI form filling, or any scenario involving dxForm or DxForm. Trigger phrases: "DevExtreme Form", "dxForm", "DxForm", "form builder", "data entry form", "form validation", "form fields", "form groups", "form columns", "form submit", "form editorOptions", "Smart Paste", "AI paste", "form AI".
DevExpress · 已有静态检查记录
安装与使用
运行命令前先阅读来源与依赖说明。复制命令不会自动安装或执行。
npx skills add DevExpress/agent-skills --skill devextreme-form技能说明
name: devextreme-form description: > Help developers use the DevExtreme Form component (dxForm) in Angular, React, Vue, and jQuery. Use when someone asks about Form configuration, formData binding, simple items, editor types, editorOptions, groups, columns, tabs, validation rules, form submission, runtime changes, custom item templates, Smart Paste, AI form filling, or any scenario involving dxForm or DxForm. Trigger phrases: "DevExtreme Form", "dxForm", "DxForm", "form builder", "data entry form", "form validation", "form fields", "form groups", "form columns", "form submit", "form editorOptions", "Smart Paste", "AI paste", "form AI". compatibility: DevExtreme 26.1+. Supports Angular 20+, React 18+, Vue 3, jQuery 3.x or 4.x. metadata: author: DevExpress version: "26.1"
DevExtreme Form Skill
A skill for building and configuring the DevExtreme Form UI component (dxForm) across Angular, React, Vue, and jQuery.
When to Use This Skill
- Creating a data entry form bound to an object (
formData) - Configuring form items with labels, editors, and validation
- Organizing items in columns, groups, or tabs
- Validating and submitting form data
- Changing form or item properties at runtime
- Enabling Smart Paste — let users paste unstructured text and let an LLM fill form fields automatically
Before You Start
If the host agent has a structured question-asking tool available, use it to ask these questions one at a time with clear options — for example, Claude Code's AskUserQuestion tool or GitHub Copilot's askQuestions tool. If no such tool is available, ask the questions directly in the chat response before generating code.
⚠️ Always use the DevExtreme Form (
dxForm/DxForm). Never use react-hook-form, Formik, Yup, or any other form library.
Before writing any code, ask:
- Which framework are you using? Angular, React, Vue, or jQuery?
- What does your data object look like? The shape of
formDatadrives the entire item configuration.
Component Overview
The DevExtreme Form generates label-editor pairs (simple items) automatically from a formData object. It auto-selects editors by value type: TextBox for strings, NumberBox for numbers, DateBox for dates. You can override the editor type with editorType and pass editor-specific options through editorOptions. Items can be organized into columns, named groups, and tabs.
Documentation & Navigation Guide
| Reference file | When you need to |
|---|---|
| references/getting-started.md | Create your first Form in any framework |
| references/items-and-layout.md | Configure items, columns, groups, colSpan, editorType, editorOptions |
| references/validation-and-submit.md | Add validation rules, isRequired, and a submit button |
| references/runtime-changes.md | Update form or item properties programmatically at runtime |
| references/ai-smart-paste.md | Enable Smart Paste: aiIntegration setup, the smartPaste button item, events |
Key API
Form options:
| Option | Type | Default | Description |
|---|---|---|---|
formData | Object | {} | The data object the form is bound to |
items | Array | undefined | Explicit item configuration; overrides auto-generated items |
colCount | Number | 'auto' | 1 | Number of columns in the form layout |
colCountByScreen | Object | undefined | Responsive column counts per screen size (xs, sm, md, lg) |
readOnly | Boolean | false | Makes all editors read-only when true |
validationGroup | String | undefined | Validation group name for the form's editors |
showValidationSummary | Boolean | false | Shows a validation summary at the bottom of the form |
labelLocation | FormLabelLocation | 'left' | Label position: 'left', 'right', 'top' |
labelMode | LabelMode | 'outside' | Label style: 'outside', 'floating', 'hidden', 'static' |
onFieldDataChanged | function(e) | null | Fires when any field value changes; e.dataField and e.value available |
scrollingEnabled | Boolean | false | Enables vertical scrolling inside the form |
aiIntegration | AIIntegration | undefined | Binds the Form to an AI service to enable Smart Paste |
onSmartPasting | function(e) | null | Fires before Smart Paste fills the form; cancellable |
onSmartPasted | function(e) | null | Fires after Smart Paste fills the form; e.aiResult contains the populated data |
Form methods:
| Method | Description |
|---|---|
getScrollable() | Returns the internal Scrollable widget instance. Use to save and restore scroll position — especially useful in long forms with async validation or dynamic field counts |
SimpleItem properties (inside items[]):
| Property | Type | Description |
|---|---|---|
dataField | String | Field name in formData |
editorType | String | Override editor: 'dxTextBox', 'dxNumberBox', 'dxSelectBox', 'dxDateBox', 'dxCheckBox', 'dxTextArea', etc. |
editorOptions | Object | Options passed directly to the editor component |
label | Object | Label config: { text: '...', visible: true } |
isRequired | Boolean | Applies a RequiredRule when true |
validationRules | Array | Validation rules: [{ type: 'required' }], [{ type: 'email' }], etc. |
colSpan | Number | Number of columns this item spans |
visible | Boolean | Hides the item when false |
template | template | Custom render template for the item |
Item types (set via itemType): 'simple' (default), 'group', 'tabbed', 'empty', 'button'.
Quick Start
// React (TypeScript)
import 'devextreme/dist/css/dx.fluent.blue.light.css';
import { Form, SimpleItem, RequiredRule } from 'devextreme-react/fo
阅读完整来源 ↗