WebApp【公共组件库】@前端(For Git Submodule)
edit | blame | history | raw

CSwitch 开关组件

功能说明

CSwitch 是一个开关组件,用于在表单中提供开关选择功能。组件基于 AtSwitch 封装,支持只读模式,并能显示必填和错误状态。

引用方式

import { CSwitch } from '@components/forms/switch';

组件参数

  • itemRes (Object,必填):表单数据资源对象,表单组件内部机制专用
  • readOnly (Boolean,可选):只读模式,默认为 false

使用示例

基础用法

<template>
  <CForm :form="form">
    <CFormItem name="notification" label="接收通知">
      <CSwitch />
    </CFormItem>
  </CForm>
</template>

<script>
import { CForm, CFormItem } from '@components/forms/form';
import { CSwitch } from '@components/forms/switch';

export default {
  components: {
    CForm,
    CFormItem,
    CSwitch
  },
  data() {
    return {
      form: {
        notification: false
      }
    };
  }
};
</script>

只读模式

<CFormItem name="notification" label="接收通知">
  <CSwitch :readOnly="true" />
</CFormItem>

注意事项

  1. CSwitch 组件的值为布尔类型,表示开关的开启或关闭状态
  2. 组件会根据表单项的 required 和 error 属性自动添加相应的样式
  3. 在只读模式下,开关将被禁用,无法切换状态
  4. 组件会自动将开关的状态同步到表单数据中