element-plus/website/docs/es/switch.md
PengMingJiu 886f2a3075
docs(docs): update the 'value' property to 'ModelValue' (#2044)
* docs(docs): update the 'value' property to 'ModelValue'

* docs: replace modelValue to model-value
2021-05-24 11:10:53 +08:00

8.0 KiB

Switch

Switch es utilizado para realizar cambios entre dos estados opuestos.

Uso básico

:::demo Enlace v-model a una variable de tipo Boolean. Los atributos active-color y inactive-color deciden el color de fondo en cada estado.

<el-switch v-model="value1"> </el-switch>
<el-switch v-model="value2" active-color="#13ce66" inactive-color="#ff4949">
</el-switch>

<script>
  export default {
    data() {
      return {
        value1: true,
        value2: true,
      }
    },
  }
</script>

:::

Texto de descripción

:::demo Puede agregar los atributos active-text y inactive-text para mostrar los textos.

<el-switch
  v-model="value1"
  active-text="Pay by month"
  inactive-text="Pay by year"
>
</el-switch>
<el-switch
  style="display: block"
  v-model="value2"
  active-color="#13ce66"
  inactive-color="#ff4949"
  active-text="Pay by month"
  inactive-text="Pay by year"
>
</el-switch>

<script>
  export default {
    data() {
      return {
        value1: true,
        value2: true,
      }
    },
  }
</script>

:::

Tipos de valores extendidos

:::demo Puede establecer los atributos active-value y inactive-value. Ambos reciben valores de tipo Boolean, String o Number.

<el-tooltip :content="'Switch value: ' + value" placement="top">
  <el-switch
    v-model="value"
    active-color="#13ce66"
    inactive-color="#ff4949"
    active-value="100"
    inactive-value="0"
  >
  </el-switch>
</el-tooltip>

<script>
  export default {
    data() {
      return {
        value: '100',
      }
    },
  }
</script>

:::

Disabled

:::demo Agregar el atributo disabled desactiva el componente Switch.

<el-switch v-model="value1" disabled> </el-switch>
<el-switch v-model="value2" disabled> </el-switch>

<script>
  export default {
    data() {
      return {
        value1: true,
        value2: false,
      }
    },
  }
</script>

:::

Loading

:::demo Setting the loading attribute to true indicates a loading state on the Switch.

<el-switch v-model="value1" loading> </el-switch>
<el-switch v-model="value2" loading> </el-switch>
<script>
  export default {
    data() {
      return {
        value1: true,
        value2: false,
      }
    },
  }
</script>

:::

prevent switching

:::demo set the beforeChange property, If false is returned or a Promise is returned and then is rejected, will stop switching.

<el-switch v-model="value1" :loading="loading1" :beforeChange="beforeChange1">
</el-switch>
<el-switch v-model="value2" :loading="loading2" :beforeChange="beforeChange2">
</el-switch>
<script>
  import { reactive, toRefs } from 'vue'
  import { ElMessage } from 'element-plus'

  export default {
    setup() {
      const status1 = reactive({
        value1: false,
        loading1: false,
      })

      const beforeChange1 = () => {
        status1.loading1 = true
        return new Promise(resolve => {
          setTimeout(() => {
            status1.loading1 = false
            ElMessage.success('switch success')
            return resolve(true)
          }, 1000)
        })
      }

      const status2 = reactive({
        value2: false,
        loading2: false,
      })

      const beforeChange2 = () => {
        status2.loading2 = true
        return new Promise((resolve, reject) => {
          setTimeout(() => {
            status2.loading2 = false
            ElMessage.error('switch failed')
            return reject(new Error('error'))
          }, 1000)
        })
      }

      return {
        ...toRefs(status1),
        ...toRefs(status2),
        beforeChange1,
        beforeChange2,
      }
    },
  }
</script>

:::

Atributos

Atributo Descripción Tipo Valores aceptados Por defecto
model-value / v-model valor vinculante, debe ser equivalente al active-value o al inactive-value. El tipo por defecto es el tipo boolean. boolean / string / number
disabled si Switch esta deshabilitado boolean false
loading whether Switch is in loading state boolean false
width ancho del componente Switch number 40
active-icon-class nombre de la clase del icono mostrado en el estado on, sobrescribe active-text string
inactive-icon-class nombre de la clase del icono mostrado en el estado off, sobrescribe inactive-text string
active-text texto mostrado en el estado on string
inactive-text texto mostrado en el estado off string
active-value cambia su valor cuando se encuentra en el estado on boolean / string / number true
inactive-value cambia su valor cuando se encuentra en el estado off boolean / string / number false
active-color color de fondo cuando se encuentra en el estado on string #409EFF
inactive-color color de fondo cuando se encuentra en el estado off string #C0CCDA
name nombre de entrada del componente Switch string
validate-event si se debe lanzar la validación de formulario boolean true
before-change before-change hook before the switch state changes. If false is returned or a Promise is returned and then is rejected, will stop switching function

Eventos

Nombre del evento Descripción Parametro
change se dispara cuando el valor cambia valor

después de cambiar

Metodos

Metodo Descripción Parametro
focus foco al componente Switch