Appearance
FormDispatcher
结合 el-form ${Config.namespace}State 状态分发
基本使用
ReadWrite
vue
<template>
<div>
<el-form-dispatcher
:model="form"
label-width="auto"
:rw-dispatcher-state="rwState"
style="max-width: 600px"
>
<el-form-item label="Activity name">
<el-input-dispatcher v-model="form.name" />
</el-form-item>
<el-form-item label="Activity zone">
<el-select-dispatcher
v-model="form.region"
placeholder="please select your zone"
>
<el-option label="Zone one" value="shanghai" />
<el-option label="Zone two" value="beijing" />
</el-select-dispatcher>
</el-form-item>
<el-form-item label="Activity time">
<el-col :span="11">
<el-date-picker-dispatcher
v-model="form.date1"
type="date"
placeholder="Pick a date"
style="width: 100%"
/>
</el-col>
<el-col :span="2" class="text-center">
<span class="text-gray-500">-</span>
</el-col>
<el-col :span="11">
<el-time-picker-dispatcher
v-model="form.date2"
placeholder="Pick a time"
style="width: 100%"
/>
</el-col>
</el-form-item>
<el-form-item label="Instant delivery">
<el-switch-dispatcher v-model="form.delivery" />
</el-form-item>
<el-form-item label="Activity type">
<el-checkbox-group-dispatcher v-model="form.type">
<el-checkbox value="Online activities" name="type">
Online activities
</el-checkbox>
<el-checkbox value="Promotion activities" name="type">
Promotion activities
</el-checkbox>
<el-checkbox value="Offline activities" name="type">
Offline activities
</el-checkbox>
<el-checkbox value="Simple brand exposure" name="type">
Simple brand exposure
</el-checkbox>
</el-checkbox-group-dispatcher>
</el-form-item>
<el-form-item label="Resources">
<el-radio-group-dispatcher v-model="form.resource">
<el-radio value="Sponsor">Sponsor</el-radio>
<el-radio value="Venue">Venue</el-radio>
</el-radio-group-dispatcher>
</el-form-item>
<el-form-item label="Activity form">
<el-input-dispatcher v-model="form.desc" type="textarea" />
</el-form-item>
<el-form-item>
<el-button type="primary" @click="onSubmit">Create</el-button>
<el-button>Cancel</el-button>
</el-form-item>
</el-form-dispatcher>
<el-switch
v-model="rwState"
active-value="write"
inactive-value="read"
active-text="Write"
inactive-text="Read"
@change="handleStateToggle"
>
Toggle State
</el-switch>
</div>
</template>
<script lang="ts" setup>
import { reactive, ref } from "vue";
import { type RWDispatcherState } from "element-plus-form-dispatcher/helper";
const rwState = ref<RWDispatcherState>("write");
// do not use same name with ref
const form = reactive({
name: "",
region: "",
date1: "",
date2: "",
delivery: false,
type: [],
resource: "",
desc: "",
});
const handleStateToggle = () => {
console.log(`Current stage: ${rwState.value}`);
};
const onSubmit = () => {
console.log("submit!", form);
};
</script>
隐藏源码
行内表单
当垂直方向空间受限且表单较简单时,可以在一行内放置表单。
通过设置 inline 属性为 true 可以让表单域变为行内的表单域。
ReadWrite
vue
<template>
<div>
<el-form-dispatcher
:inline="true"
:model="formInline"
:rw-dispatcher-state="rwState"
class="demo-form-inline"
>
<el-form-item label="Approved by">
<el-input-dispatcher
v-model="formInline.user"
placeholder="Approved by"
clearable
/>
</el-form-item>
<el-form-item label="Activity zone">
<el-select-dispatcher
v-model="formInline.region"
placeholder="Activity zone"
clearable
>
<el-option label="Zone one" value="shanghai" />
<el-option label="Zone two" value="beijing" />
</el-select-dispatcher>
</el-form-item>
<el-form-item label="Activity time">
<el-date-picker-dispatcher
v-model="formInline.date"
type="date"
placeholder="Pick a date"
clearable
/>
</el-form-item>
<el-form-item>
<el-button type="primary" @click="onSubmit">Query</el-button>
</el-form-item>
</el-form-dispatcher>
<el-switch
v-model="rwState"
active-value="write"
inactive-value="read"
active-text="Write"
inactive-text="Read"
@change="handleStateToggle"
>
Toggle State
</el-switch>
</div>
</template>
<script lang="ts" setup>
import { reactive, ref } from "vue";
import { type RWDispatcherState } from "element-plus-form-dispatcher/helper";
const rwState = ref<RWDispatcherState>("write");
const formInline = reactive({
user: "",
region: "",
date: "",
});
const handleStateToggle = () => {
console.log(`Current stage: ${rwState.value}`);
};
const onSubmit = () => {
console.log("submit!");
};
</script>
<style>
.demo-form-inline .el-input {
--el-input-width: 200px;
}
.demo-form-inline .el-select {
--el-select-width: 200px;
}
.demo-form-inline .rw-dispatcher-el-text {
width: 200px;
}
</style>
隐藏源码
对齐方式
ReadWrite
vue
<template>
<div>
<el-form-dispatcher
:label-position="labelPosition"
label-width="auto"
:model="formLabelAlign"
:rw-dispatcher-state="rwState"
style="max-width: 600px"
>
<el-form-item label="Form Align" label-position="right">
<el-radio-group v-model="labelPosition" aria-label="label position">
<el-radio-button value="left">Left</el-radio-button>
<el-radio-button value="right">Right</el-radio-button>
<el-radio-button value="top">Top</el-radio-button>
</el-radio-group>
</el-form-item>
<el-form-item label="Form Item Align" label-position="right">
<el-radio-group
v-model="itemLabelPosition"
aria-label="item label position"
>
<el-radio-button value="">Empty</el-radio-button>
<el-radio-button value="left">Left</el-radio-button>
<el-radio-button value="right">Right</el-radio-button>
<el-radio-button value="top">Top</el-radio-button>
</el-radio-group>
</el-form-item>
<el-form-item label="Name" :label-position="itemLabelPosition">
<el-input-dispatcher v-model="formLabelAlign.name" />
</el-form-item>
<el-form-item label="Activity zone" :label-position="itemLabelPosition">
<el-input-dispatcher v-model="formLabelAlign.region" />
</el-form-item>
<el-form-item label="Activity form" :label-position="itemLabelPosition">
<el-input-dispatcher v-model="formLabelAlign.type" />
</el-form-item>
</el-form-dispatcher>
<el-switch
v-model="rwState"
active-value="write"
inactive-value="read"
active-text="Write"
inactive-text="Read"
@change="handleStateToggle"
>
Toggle State
</el-switch>
</div>
</template>
<script lang="ts" setup>
import { reactive, ref } from "vue";
import type { FormItemProps, FormProps } from "element-plus";
import { type RWDispatcherState } from "element-plus-form-dispatcher/helper";
const rwState = ref<RWDispatcherState>("write");
const labelPosition = ref<FormProps["labelPosition"]>("right");
const itemLabelPosition = ref<FormItemProps["labelPosition"]>("");
const formLabelAlign = reactive({
name: "",
region: "",
type: "",
});
const handleStateToggle = () => {
console.log(`Current stage: ${rwState.value}`);
};
</script>
隐藏源码
表单校验
ReadWrite
vue
<template>
<div>
<el-form-dispatcher
ref="ruleFormRef"
style="max-width: 600px"
:model="ruleForm"
:rules="rules"
label-width="auto"
:rw-dispatcher-state="rwState"
>
<el-form-item label="Activity name" prop="name">
<el-input-dispatcher v-model="ruleForm.name" />
</el-form-item>
<el-form-item label="Activity zone" prop="region">
<el-select-dispatcher
v-model="ruleForm.region"
placeholder="Activity zone"
>
<el-option label="Zone one" value="shanghai" />
<el-option label="Zone two" value="beijing" />
</el-select-dispatcher>
</el-form-item>
<el-form-item label="Activity count" prop="count">
<el-select-v2-dispatcher
v-model="ruleForm.count"
placeholder="Activity count"
:options="options"
/>
</el-form-item>
<el-form-item label="Activity time" required>
<el-col :span="11">
<el-form-item prop="date1">
<el-date-picker-dispatcher
v-model="ruleForm.date1"
type="date"
aria-label="Pick a date"
placeholder="Pick a date"
style="width: 100%"
/>
</el-form-item>
</el-col>
<el-col class="text-center" :span="2">
<span class="text-gray-500">-</span>
</el-col>
<el-col :span="11">
<el-form-item prop="date2">
<el-time-picker-dispatcher
v-model="ruleForm.date2"
aria-label="Pick a time"
placeholder="Pick a time"
style="width: 100%"
/>
</el-form-item>
</el-col>
</el-form-item>
<el-form-item label="Instant delivery" prop="delivery">
<el-switch-dispatcher v-model="ruleForm.delivery" />
</el-form-item>
<el-form-item label="Activity location" prop="location">
<el-segmented v-model="ruleForm.location" :options="locationOptions" />
</el-form-item>
<el-form-item label="Activity type" prop="type">
<el-checkbox-group-dispatcher v-model="ruleForm.type">
<el-checkbox value="Online activities" name="type">
Online activities
</el-checkbox>
<el-checkbox value="Promotion activities" name="type">
Promotion activities
</el-checkbox>
<el-checkbox value="Offline activities" name="type">
Offline activities
</el-checkbox>
<el-checkbox value="Simple brand exposure" name="type">
Simple brand exposure
</el-checkbox>
</el-checkbox-group-dispatcher>
</el-form-item>
<el-form-item label="Resources" prop="resource">
<el-radio-group-dispatcher v-model="ruleForm.resource">
<el-radio value="Sponsorship">Sponsorship</el-radio>
<el-radio value="Venue">Venue</el-radio>
</el-radio-group-dispatcher>
</el-form-item>
<el-form-item label="Activity form" prop="desc">
<el-input-dispatcher v-model="ruleForm.desc" type="textarea" />
</el-form-item>
<el-form-item>
<el-button type="primary" @click="submitForm(ruleFormRef)">
Create
</el-button>
<el-button @click="resetForm(ruleFormRef)">Reset</el-button>
</el-form-item>
</el-form-dispatcher>
<el-switch
v-model="rwState"
active-value="write"
inactive-value="read"
active-text="Write"
inactive-text="Read"
@change="handleStateToggle"
>
Toggle State
</el-switch>
</div>
</template>
<script lang="ts" setup>
import { reactive, ref } from "vue";
import { ElFormDispatcher } from "element-plus-form-dispatcher";
import type { FormInstance, FormRules } from "element-plus";
import { type RWDispatcherState } from "element-plus-form-dispatcher/helper";
const rwState = ref<RWDispatcherState>("write");
interface RuleForm {
name: string;
region: string;
count: string;
date1: string;
date2: string;
delivery: boolean;
location: string;
type: string[];
resource: string;
desc: string;
}
const ruleFormRef = ref<InstanceType<typeof ElFormDispatcher>>();
const ruleForm = reactive<RuleForm>({
name: "Hello",
region: "",
count: "",
date1: "",
date2: "",
delivery: false,
location: "",
type: [],
resource: "",
desc: "",
});
const locationOptions = ["Home", "Company", "School"];
const rules = reactive<FormRules<RuleForm>>({
name: [
{ required: true, message: "Please input Activity name", trigger: "blur" },
{ min: 3, max: 5, message: "Length should be 3 to 5", trigger: "blur" },
],
region: [
{
required: true,
message: "Please select Activity zone",
trigger: "change",
},
],
count: [
{
required: true,
message: "Please select Activity count",
trigger: "change",
},
],
date1: [
{
type: "date",
required: true,
message: "Please pick a date",
trigger: "change",
},
],
date2: [
{
type: "date",
required: true,
message: "Please pick a time",
trigger: "change",
},
],
location: [
{
required: true,
message: "Please select a location",
trigger: "change",
},
],
type: [
{
type: "array",
required: true,
message: "Please select at least one activity type",
trigger: "change",
},
],
resource: [
{
required: true,
message: "Please select activity resource",
trigger: "change",
},
],
desc: [
{ required: true, message: "Please input activity form", trigger: "blur" },
],
});
const submitForm = async (formEl: FormInstance | undefined) => {
if (!formEl) return;
await formEl.writer?.validate((valid, fields) => {
if (valid) {
console.log("submit!");
} else {
console.log("error submit!", fields);
}
});
};
const resetForm = (
formEl: InstanceType<typeof ElFormDispatcher> | undefined,
) => {
if (!formEl) return;
formEl.writer?.resetFields();
};
const options = Array.from({ length: 10000 }).map((_, idx) => ({
value: `${idx + 1}`,
label: `${idx + 1}`,
}));
const handleStateToggle = () => {
console.log(`Current stage: ${rwState.value}`);
};
</script>
隐藏源码
尺寸控制
表单中的所有子组件都继承了该表单的 size 属性。 同样,form-item 也有一个 size 属性。
如果希望某个表单项或某个表单组件的尺寸不同于 Form 上的 size 属性,直接为这个表单项或表单组件设置自己的 size 属性即可。
ReadWrite
vue
<template>
<div class="flex items-center">
<el-radio-group v-model="size" aria-label="size control">
<el-radio-button value="large">large</el-radio-button>
<el-radio-button value="default">default</el-radio-button>
<el-radio-button value="small">small</el-radio-button>
</el-radio-group>
<el-radio-group v-model="labelPosition" aria-label="position control">
<el-radio-button value="left">Left</el-radio-button>
<el-radio-button value="right">Right</el-radio-button>
<el-radio-button value="top">Top</el-radio-button>
</el-radio-group>
<el-switch
v-model="rwState"
active-value="write"
inactive-value="read"
active-text="Write"
inactive-text="Read"
@change="handleStateToggle"
>
Toggle State
</el-switch>
</div>
<br />
<el-form-dispatcher
style="max-width: 600px"
:model="sizeForm"
label-width="auto"
:label-position="labelPosition"
:size="size"
:rw-dispatcher-state="rwState"
>
<el-form-item label="Activity name">
<el-input-dispatcher v-model="sizeForm.name" />
</el-form-item>
<el-form-item label="Activity zone">
<el-select-dispatcher
v-model="sizeForm.region"
placeholder="please select your zone"
>
<el-option label="Zone one" value="shanghai" />
<el-option label="Zone two" value="beijing" />
</el-select-dispatcher>
</el-form-item>
<el-form-item label="Activity time">
<el-col :span="11">
<el-date-picker-dispatcher
v-model="sizeForm.date1"
type="date"
aria-label="Pick a date"
placeholder="Pick a date"
style="width: 100%"
/>
</el-col>
<el-col class="text-center" :span="1" style="margin: 0 0.5rem">-</el-col>
<el-col :span="11">
<el-time-picker-dispatcher
v-model="sizeForm.date2"
aria-label="Pick a time"
placeholder="Pick a time"
style="width: 100%"
/>
</el-col>
</el-form-item>
<el-form-item label="Activity type">
<el-checkbox-group-dispatcher v-model="sizeForm.type">
<el-checkbox-button value="Online activities" name="type">
Online activities
</el-checkbox-button>
<el-checkbox-button value="Promotion activities" name="type">
Promotion activities
</el-checkbox-button>
</el-checkbox-group-dispatcher>
</el-form-item>
<el-form-item label="Resources">
<el-radio-group-dispatcher v-model="sizeForm.resource">
<el-radio border value="Sponsor">Sponsor</el-radio>
<el-radio border value="Venue">Venue</el-radio>
</el-radio-group-dispatcher>
</el-form-item>
<el-form-item>
<el-button type="primary" @click="onSubmit">Create</el-button>
<el-button>Cancel</el-button>
</el-form-item>
</el-form-dispatcher>
</template>
<script lang="ts" setup>
import { reactive, ref } from "vue";
import type { ComponentSize, FormProps } from "element-plus";
import { type RWDispatcherState } from "element-plus-form-dispatcher/helper";
const size = ref<ComponentSize>("default");
const labelPosition = ref<FormProps["labelPosition"]>("right");
const rwState = ref<RWDispatcherState>("write");
const sizeForm = reactive({
name: "",
region: "",
date1: "",
date2: "",
delivery: false,
type: [],
resource: "",
desc: "",
});
function onSubmit() {
console.log("submit!");
}
const handleStateToggle = () => {
console.log(`Current stage: ${rwState.value}`);
};
</script>
<style>
.el-radio-group {
margin-right: 12px;
}
</style>
隐藏源码
禁用表单
ReadWrite
vue
<template>
<div>
<el-form-dispatcher
:model="form"
disabled
label-width="auto"
:rw-dispatcher-state="rwState"
style="max-width: 600px"
>
<el-form-item label="Activity name">
<el-input-dispatcher v-model="form.name" />
</el-form-item>
<el-form-item label="Activity zone">
<el-select-dispatcher
v-model="form.region"
placeholder="please select your zone"
>
<el-option label="Zone one" value="shanghai" />
<el-option label="Zone two" value="beijing" />
</el-select-dispatcher>
</el-form-item>
<el-form-item label="Activity time">
<el-col :span="11">
<el-date-picker-dispatcher
v-model="form.date1"
type="date"
placeholder="Pick a date"
style="width: 100%"
/>
</el-col>
<el-col :span="2" class="text-center">
<span class="text-gray-500">-</span>
</el-col>
<el-col :span="11">
<el-time-picker-dispatcher
v-model="form.date2"
placeholder="Pick a time"
style="width: 100%"
/>
</el-col>
</el-form-item>
<el-form-item label="Instant delivery">
<el-switch-dispatcher v-model="form.delivery" />
</el-form-item>
<el-form-item label="Activity type">
<el-checkbox-group-dispatcher v-model="form.type">
<el-checkbox value="Online activities" name="type">
Online activities text
</el-checkbox>
<el-checkbox value="Promotion activities" name="type">
Promotion activities text
</el-checkbox>
<el-checkbox value="Offline activities" name="type">
Offline activities text
</el-checkbox>
<el-checkbox value="Simple brand exposure" name="type">
Simple brand exposure text
</el-checkbox>
</el-checkbox-group-dispatcher>
</el-form-item>
<el-form-item label="Resources">
<el-radio-group-dispatcher v-model="form.resource">
<el-radio value="Sponsor">Sponsor text</el-radio>
<el-radio value="Venue">Venue text</el-radio>
</el-radio-group-dispatcher>
</el-form-item>
<el-form-item label="Activity form">
<el-input-dispatcher v-model="form.desc" type="textarea" />
</el-form-item>
<el-form-item>
<el-button type="primary" @click="onSubmit">Create</el-button>
<el-button>Cancel</el-button>
</el-form-item>
</el-form-dispatcher>
<el-switch
v-model="rwState"
active-value="write"
inactive-value="read"
active-text="Write"
inactive-text="Read"
@change="handleStateToggle"
>
Toggle State
</el-switch>
</div>
</template>
<script lang="ts" setup>
import { reactive, ref } from "vue";
import { type RWDispatcherState } from "element-plus-form-dispatcher/helper";
const rwState = ref<RWDispatcherState>("write");
// do not use same name with ref
const form = reactive({
name: "张三",
region: "shanghai",
delivery: false,
desc: "xxxxxxxxxx",
date1: "2026-08-24",
date2: "2026-08-24 20:21:15",
resource: "Venue",
type: ["Online activities", "Promotion activities"],
});
const handleStateToggle = () => {
console.log(`Current stage: ${rwState.value}`);
};
const onSubmit = () => {
console.log("submit!");
};
</script>
隐藏源码
API
与 el-form 的 props attrs slots 完全一致