复选框

复选框是标准复选框元素的扩展，具有主题功能。

导入 #


import Checkbox from 'primevue/checkbox';

基础 #

二进制复选框与v-model一起用于双向值绑定和binary属性。


<Checkbox v-model="checked" binary />

组 #

多个复选框可以组合在一起。

奶酪

蘑菇

辣椒

洋葱


<div class="card flex flex-wrap justify-center gap-4">
    <div class="flex items-center gap-2">
        <Checkbox v-model="pizza" inputId="ingredient1" name="pizza" value="Cheese" />
        <label for="ingredient1"> Cheese </label>
    </div>
    <div class="flex items-center gap-2">
        <Checkbox v-model="pizza" inputId="ingredient2" name="pizza" value="Mushroom" />
        <label for="ingredient2"> Mushroom </label>
    </div>
    <div class="flex items-center gap-2">
        <Checkbox v-model="pizza" inputId="ingredient3" name="pizza" value="Pepper" />
        <label for="ingredient3"> Pepper </label>
    </div>
    <div class="flex items-center gap-2">
        <Checkbox v-model="pizza" inputId="ingredient4" name="pizza" value="Onion" />
        <label for="ingredient4"> Onion </label>
    </div>
</div>

表单 #

复选框与PrimeVue 表单库无缝集成。


<Form v-slot="$form" :resolver="resolver" :initialValues="initialValues" @submit="onFormSubmit" class="flex justify-center flex-col gap-4">
    <div class="flex flex-col gap-2">
        <CheckboxGroup name="ingredient" class="flex flex-wrap gap-4">
            <div class="flex items-center gap-2">
                <Checkbox inputId="cheese" value="Cheese" />
                <label for="cheese"> Cheese </label>
            </div>
            <div class="flex items-center gap-2">
                <Checkbox inputId="mushroom" value="Mushroom" />
                <label for="mushroom"> Mushroom </label>
            </div>
            <div class="flex items-center gap-2">
                <Checkbox inputId="pepper" value="Pepper" />
                <label for="pepper"> Pepper </label>
            </div>
            <div class="flex items-center gap-2">
                <Checkbox inputId="onion" value="Onion" />
                <label for="onion"> Onion </label>
            </div>
        </CheckboxGroup>
        <Message v-if="$form.ingredient?.invalid" severity="error" size="small" variant="simple">{{ $form.ingredient.error?.message }}</Message>
    </div>
    <Button type="submit" severity="secondary" label="Submit" />
</Form>

动态 #

可以使用值列表生成复选框。

会计

营销

生产

研究


<div v-for="category of categories" :key="category.key" class="flex items-center gap-2">
    <Checkbox v-model="selectedCategories" :inputId="category.key" name="category" :value="category.name" />
    <label :for="category.key">{{ category.name }}</label>
</div>

不确定 #

当存在不确定时，复选框会在视觉上掩盖实际值。


<Checkbox v-model="checked" indeterminate binary />

填充 #

指定variant属性为filled，以显示比默认outlined样式具有更高视觉强调的组件。


<Checkbox v-model="checked" binary variant="filled" />

尺寸 #

复选框提供小和大尺寸作为基本尺寸的替代方案。

小

普通

大


<div class="card flex flex-wrap justify-center gap-4">
    <div class="flex items-center gap-2">
        <Checkbox v-model="size" inputId="size_small" name="size" value="Small" size="small" />
        <label for="size_small" class="text-sm">Small</label>
    </div>
    <div class="flex items-center gap-2">
        <Checkbox v-model="size" inputId="size_normal" name="size" value="Normal" />
        <label for="size_normal">Normal</label>
    </div>
    <div class="flex items-center gap-2">
        <Checkbox v-model="size" inputId="size_large" name="size" value="Large" size="large" />
        <label for="size_large" class="text-lg">Large</label>
    </div>
</div>

无效 #

无效状态使用invalid属性显示，以指示验证失败。在与表单验证库集成时可以使用此样式。


<Checkbox v-model="checked" :invalid="!checked"  binary />

禁用 #

当存在disabled时，元素无法编辑和聚焦。


<Checkbox v-model="checked1" binary disabled />
<Checkbox v-model="checked2" binary disabled />

可访问性 #

屏幕阅读器

复选框组件在内部使用一个隐藏的原生复选框元素，该元素仅对屏幕阅读器可见。描述组件的值可以通过与inputId属性结合使用的label标签或使用aria-labelledby、aria-label属性来提供。


<label for="chkbox1">Remember Me</label>
<Checkbox inputId="chkbox1" />

<span id="chkbox2">Remember Me</span>
<Checkbox aria-labelledby="chkbox2" />

<Checkbox aria-label="Remember Me" />

键盘支持

键	功能
tab	将焦点移动到复选框。
空格	切换选中状态。

复选框