跳至正文
OpenAgentSkill
浏览已开放 · 目录记录日期 2026-11-21 · 自动更新和账户服务暂时关闭。
开发与测试

devextreme-checkbox

Help developers use the DevExtreme CheckBox component (dxCheckBox) in Angular, React, Vue, and jQuery. Use when someone asks about CheckBox configuration, value states, three-state behavior, labels, value change events, or any scenario involving dxCheckBox or DxCheckBox. Trigger phrases: "DevExtreme CheckBox", "dxCheckBox", "DxCheckBox", "checkbox", "toggle", "boolean input", "three state checkbox", "indeterminate checkbox", "handle checkbox change".

DevExpress · 已有静态检查记录

安装与使用

运行命令前先阅读来源与依赖说明。复制命令不会自动安装或执行。

npx skills add DevExpress/agent-skills --skill devextreme-checkbox

技能说明


name: devextreme-checkbox description: > Help developers use the DevExtreme CheckBox component (dxCheckBox) in Angular, React, Vue, and jQuery. Use when someone asks about CheckBox configuration, value states, three-state behavior, labels, value change events, or any scenario involving dxCheckBox or DxCheckBox. Trigger phrases: "DevExtreme CheckBox", "dxCheckBox", "DxCheckBox", "checkbox", "toggle", "boolean input", "three state checkbox", "indeterminate checkbox", "handle checkbox change". compatibility: DevExtreme 26.1+. Supports Angular 20+, React 18+, Vue 3, jQuery 3.x or 4.x. metadata: author: DevExpress version: "26.1"

DevExtreme CheckBox Skill

A skill for building and configuring the DevExtreme CheckBox UI component (dxCheckBox) across Angular, React, Vue, and jQuery.

When to Use This Skill

  • Creating a boolean toggle input
  • Setting an initial checked/unchecked/indeterminate state
  • Enabling three-state behavior (checked / unchecked / indeterminate)
  • Handling value change events
  • Adding a label or tooltip

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 CheckBox (dxCheckBox / DxCheckBox). Never use a plain HTML <input type="checkbox">, Material UI Checkbox, Ant Design Checkbox, or any other library.

Before writing any code, ask: Which framework are you using? Angular, React, Vue, or jQuery?

Key API

OptionTypeDefaultDescription
valueBoolean | null | undefinedfalsetrue = checked, false = unchecked, null/undefined = indeterminate
textString''Label displayed next to the checkbox
enableThreeStateBehaviorBooleanfalseLets users cycle through checked → unchecked → indeterminate
onValueChangedfunction(e)nullFires when the value changes; e.value is the new value
disabledBooleanfalseDisables the component
readOnlyBooleanfalsePrevents user interaction
iconSizeNumber | StringundefinedCustom width and height of the checkbox icon
hintStringundefinedTooltip shown on hover

Event: valueChanged — use onValueChanged as the handler.

Getting Started

jQuery

<!-- index.html -->
<div id="check-box"></div>
$(function() {
    $('#check-box').dxCheckBox({
        value: false,
        text: 'Agree to terms',
        onValueChanged(e) {
            console.log(e.value);
        }
    });
});

Angular

<!-- app.html -->
<dx-check-box
    [value]="false"
    text="Agree to terms"
    (onValueChanged)="onValueChanged($event)">
</dx-check-box>
// app.ts
import { Component } from '@angular/core';
import { DxCheckBoxComponent, DxCheckBoxTypes } from 'devextreme-angular/ui/check-box';

@Component({
    selector: 'app-root',
    standalone: true,
    imports: [DxCheckBoxComponent],
    templateUrl: './app.html'
})
export class AppComponent {
    onValueChanged(e: DxCheckBoxTypes.ValueChangedEvent) {
        console.log(e.value);
    }
}

Vue

<template>
    <DxCheckBox
        :value="false"
        text="Agree to terms"
        @value-changed="onValueChanged"
    />
</template>

<script setup lang="ts">
import DxCheckBox, { DxCheckBoxTypes } from 'devextreme-vue/check-box';

function onValueChanged(e: DxCheckBoxTypes.ValueChangedEvent) {
    console.log(e.value);
}
</script>

React

import 'devextreme/dist/css/dx.fluent.blue.light.css';
import { CheckBox, type CheckBoxTypes } from 'devextreme-react/check-box';

function onValueChanged(e: CheckBoxTypes.ValueChangedEvent) {
    console.log(e.value);
}

function App() {
    return (
        // defaultValue = uncontrolled (no state needed); use value + useState for two-way binding
        <CheckBox
            defaultValue={false}
            text="Agree to terms"
            onValueChanged={onValueChanged}
        />
    );
}

export default App;

Common Patterns

Three-state checkbox (indeterminate state)

{/* React */}
<CheckBox
    value={null}
    enableThreeStateBehavior={true}
    text="Select all"
/>

Two-way binding (React with state)

import { useState, useCallback } from 'react';
import { CheckBox } from 'devextreme-react/check-box';

function App() {
    const [checked, setChecked] = useState(false);
    const handleValueChanged = useCallback((e) => setChecked(e.value), []);

    return (
        <CheckBox
            value={checked}
            onValueChanged={handleValueChanged}
            text="Enable feature"
        />
    );
}

Custom icon size and hint

<!-- Angular -->
<dx-check-box text="Approve" hint="Approve this item" iconSize="25"></dx-check-box>

Constraints & Rules

  1. Framework first: Always ask which framework before writing code.
  2. No fabricated API: Never guess option names. Use the DxDocs MCP to verify if unsure.
  3. Version consistency: All DevExtreme packages must use the same version.
  4. Framework conventions: Angular uses DxCheckBoxComponent; React imports from devextreme-react/check-box; Vue imports from devextreme-vue/check-box; jQuery uses $(...).dxCheckBox({}).
  5. TypeScript by default: For Angular, React (TSX), and Vue, generate TypeScript unless explicitly asked otherwise.
  6. React — no inline objects or functions in JSX: Define event handlers with useCallback. Never pass () => {} literals directly as JSX props.
  7. Angular — standalone imports: Import DxCheckBoxComponent from devextreme-angular/ui/check-box into the component's imports array. Do not use `DxCheckBo
阅读完整来源 ↗