Checkbox ​

Un grupo de opciones para manejar múltiples elecciones.

WARNING

label act as value has been deprecated, label is used only as display text, this action will be removed in 3.0.0, consider switching to new API.

TIP

New API value has been added in 2.6.0, the examples in the document all use the value. If you are using a version less than 2.6.0 and using checkbox-group, please refer to:

vue
<template>
  <el-checkbox-group v-model="checkList">
    <!-- works when >=2.6.0, recommended ✔️ value not work when <2.6.0 ❌ -->
    <el-checkbox label="Option 1" value="Value 1" />
    <!-- works when <2.6.0, deprecated act as value when >=3.0.0 -->
    <el-checkbox label="Option 2 & Value 2" />
  </el-checkbox-group>
</template>

Uso básico ​

El checkbox solo se puede utilizar para cambiar entre dos estados.

Define v-model(variable enlazada) en el-checkbox. El valor por defecto es un Boolean para un checkbox, y se convierte en true cuando este es seleccionado. El contenido dentro de la etiqueta el-checkbox se convertirá en la descripción después del checkbox.

Estado deshabilitado ​

Estado deshabilitado para el checkbox.

Establezca el atributo disabled.

Grupo de Checkboxes ​

Es usado por múltiples checkboxes los cuales están enlazados a un grupo, indica si una opción está seleccionada verificando si esta está marcada.

El elemento checkbox-group puede manejar múltiples checkboxes en un grupo usando v-model enlazando a un Array. Inside the el-checkbox element, value is the value of the checkbox. Si en la etiqueta no hay contenido anidado, label se mostrara como la descripción al lado del botón del checkbox. value also corresponds with the element values in the array. Estará seleccionado si el valor especificado existe en el array y viceversa.

Options attribute 2.11.2 ​

Shortcut from basic el-checkbox-group usage. You can customize the alias of the options through the props attribute.

Indeterminado ​

La propiedad indeterminate puede ser usada para generar el efecto de marcar todos (check all).

Mínimo / Máximo de elementos marcados ​

Las propiedades min y max pueden limitar la cantidad de elementos seleccionados.

Estilo del botón ​

Checkbox tipo Botón.

Solo debe cambiar el elemento el-checkbox por el elemento el-checkbox-button. Se provee el atributo size.

Con bordes ​

El atributo border agrega un borde a los Checkboxes.

API Checkbox ​

Checkbox Attributes ​

NombreDescripciónTipoPor defecto
model-value / v-modelvalor enlazadostring / number / boolean—
value 2.6.0valor del checkbox cuando es usado dentro de un checkbox-groupstring / number / boolean / object—
labellabel of the Checkbox when used inside a checkbox-group. If there's no value, label will act as valuestring / number / boolean / object—
true-value 2.6.0valor del Checkbox si está marcadostring / number—
false-value 2.6.0valor del Checkbox si no está marcadostring / number—
disabledespecífica si el Checkbox está deshabilitadobooleanfalse
borderespecifica si agrega un borde alrededor del Checkboxbooleanfalse
sizetamaño del Checkboxenum—
nameatributo name nativostring—
checkedespecifica si el Checkbox está marcadobooleanfalse
indeterminateEstablecer estado indeterminado, sólo responsable del control de estilobooleanfalse
validate-eventsi se activa la validación del formulariobooleantrue
tabindexinput tabindexstring / number—
idinput idstring—
aria-controls a11y 2.7.2igual que aria-controls, tendrá efecto cuando indeterminar es verdaderostring—
aria-label a11ynative aria-label attributestring—
true-label deprecatedvalue of the Checkbox if it's checkedstring / number—
false-label deprecatedvalue of the Checkbox if it's not checkedstring / number—
controls a11y deprecatedsame as aria-controls, takes effect when indeterminate is truestring—

Checkbox Events ​

NombreDescripciónTipo
changese dispara cuando el valor cambiaFunction

Checkbox Slots ​

NombreDescripción
defaultpersonaliza el contenido por defecto

API de CheckboxGroup ​

CheckboxGroup Attributes ​

NombreDescripciónTipoPor defecto
model-value / v-modelvalor enlazadoarray[]
sizetamaño del Checkboxenum—
disabledespecífica si los checkboxes anidados están deshabilitadosbooleanfalse
mincantidad mínima de checkboxes que deben ser marcadosnumber—
maxcantidad máxima de checkboxes que pueden ser marcadosnumber—
aria-label a11y 2.7.2native aria-label attributestring—
text-colorcolor de las letras cuando el botón está activostring#ffffff
fillcolor del borde y de fondo cuando el botón está activostring#409eff
tagetiqueta de elemento del grupo de checkboxstringdiv
validate-eventsi se activa la validación del formulariobooleantrue
label a11y deprecatednative aria-label attributestring—
options 2.11.2data of the options, the key of value and label and disabled can be customize by propsarray—
props 2.11.2configuration optionsobject{value: 'value', label: 'label', disabled: 'disabled'}
type 2.11.5component type to render options (e.g. 'button')enum'checkbox'

CheckboxGroup Events ​

NombreDescripciónTipo
changese dispara cuando el valor cambiaFunction

CheckboxGroup Slots ​

NombreDescripciónSubtags
defaultpersonaliza el contenido por defectoCheckbox / Checkbox-button

CheckboxButton API ​

CheckboxButton Attributes ​

NameDescriptionTipoPor defecto
value 2.6.0valor del checkbox cuando es usado dentro de un checkbox-groupstring / number / boolean / object—
labellabel of the checkbox when used inside a checkbox-group. If there's no value, label will act as valuestring / number / boolean / object—
true-value 2.6.0valor del checkbox si este está marcadostring / number—
false-value 2.6.0valor del checkbox si este no está marcadostring / number—
disabledespecifica si el checkbox está deshabilitadobooleanfalse
nameatributo 'name' nativostring—
checkedsi el checkbox está marcadobooleanfalse
true-label deprecatedvalue of the checkbox if it's checkedstring / number—
false-label deprecatedvalue of the checkbox if it's not checkedstring / number—

CheckboxButton Slots ​

NombreDescripción
por defectopersonaliza el contenido por defecto

Fuente ​

Componentes • Style • Documentación

Contribuidores ​