Checkbox

A Checkbox is a binary input that can appear by itself or in a multiselect group. Checkboxes can be selected, unselected or in an indeterminate state.

Guidelines

When to use checkboxes

Checkboxes must feature a descriptive label. They may appear alone or as a part of a group. A checkbox may also have sub-options or child checkboxes.

Use the Checkbox component when you want users to make one or more selections from a list of options. A checkbox can also be used to accept terms and conditions. Avoid using checkboxes when only one selection is allowed; in such cases, use Radio instead.

Specifications

1. Checkbox
   The checkbox’s input makes the selection visually distinct.
2. Label
   The Checkbox must always contain a label, with the text size matching the base font size for consistency with the body text. Labels can include links and bold text and should be concise, clearly indicating the selected option.
3. Description (optional)
   If additional information about the label is required, a description can be included.
4. Custom input (optional)
   An additional input field can be included within the Checkbox to allow the user to input a custom response.

Component limitations

A Checkbox group should consist of at least 2 checkboxes, with no maximum limit on the number of checkboxes per group.

The Checkbox label will expand to fit longer text while the checkbox itself remains aligned with the first line of the label's text.

Refer to the Checkbox component in Codex Figma.

Types

Depending on the content type, the following types of Checkboxes are available:

1. With only label
   By default, the Checkbox always includes a label that matches the base font size for consistency.
2. With description
   In some cases, an optional description can be added below the label for additional information.
3. With custom input
   In cases where additional user input is required, an optional custom input field can be added below the label or description.

The custom input within the Radio can include any of the following form components designed to gather user input, including:

1. TextInput and TextArea
2. Select
3. Combobox
4. ChipInput
5. Lookup
6. A combination of more than one input

Note: Groups of Checkboxes, Radios, and Toggle switches are not allowed within this custom input.

Interaction states

The styles for Checkbox states were designed with accessible color variations. In addition to the 'check' icon, these make the checkboxes’ selected or unselected states (e.g. disabled, hover, active) easier to perceive:

1. Default unselected
2. Hover unselected
3. Active unselected
4. Focus unselected
5. Error unselected
6. Error-hover unselected
7. Error-active unselected
8. Error-focus unselected
9. Default selected
10. Hover selected
11. Active selected
12. Focus selected
13. Error selected
14. Error-hover selected
15. Error-active selected
16. Error-focus selected
17. Default indeterminate
18. Disabled unselected
19. Disabled selected
20. Disabled indeterminate

The error checkbox must always be accompanied by an inline error message,whether for a group or an individual checkbox. This message ensures users are informed about the error and provides guidance to fix it.

Accessibility note

The disabled state does not meet our minimum color contrast rules. WCAG 2.1 states that “…part[s] of an inactive user interface component […] have no contrast requirement”. ^[1] Provide sufficient information in a disabled element's context, so the user can understand what is disabled and how to enable it (if applicable).

Indeterminate state

In addition to selected and unselected, a checkbox can be in an indeterminate state. This state uses the 'subtract' icon. It is common for checkboxes to present a number of sub-options (which are also checkboxes). If all of the sub-options are checked, the main checkbox will also be checked, and if they're all unchecked, the main checkbox would be unchecked. If any one or more of the sub-options have a different state than the others, the main checkbox would present an indeterminate state. ^[2]

Best practices

Consider the following recommendations when using checkboxes.

Label’s format

Do:

• Accompany the Checkbox with a label that matches the base font size.
• Include a description below the label to provide additional information.
• Use text formatting like bold and italic in the label.
• Include standalone links within the label to provide additional information regarding a specific option when necessary.

Don't:

• Bold all Checkbox labels, even if a description is included, as this can interfere with the text hierarchy.
• Link the entire Checkbox label as it could cause issues with the selection.

Error state

Do:

• Include inline error messages for both individual and groups of checkboxes to inform users and guide them in fixing issues.

Don't:

• Leave the error checkbox without an accompanying error inline message.

Indeterminate checkbox

Do:

• Use the indeterminate checkbox when there is a long list of sub-checkboxes to select.
• Align secondary checkboxes with the label of the indeterminate checkbox.

Don't:

• Use the indeterminate checkbox when there is a short list of sub-checkboxes.
• Align all checkboxes together when using indeterminate checkboxes.

Inline checkboxes

Do:

• Use inline checkboxes, but reserve its use for specific cases to prevent disruptions in the reading flow.

Don't:

• Use inline checkboxes if there are too many checkboxes per line.
• Use inline checkboxes if there is significant variation in the length of the checkbox labels.

Custom input within the Radio

Do:

• Combine 2 different fields within the custom input if needed.

Don't:

• Nest another group of radios, checkboxes, or toggle switches within the custom input.

Do:

• Display the custom input at the end of a Checkbox group whenever possible.
• Disable the custom input unless its corresponding Checkbox is selected.

Don't:

• Design a layout where multiple Checkboxes include custom inputs visible simultaneously.
• Enable the custom input when its corresponding Checkbox is not selected.

Content

A checkbox lets a reader choose one or more options from a list.

Do:

• Create a direct question or a complete sentence to precede the checkboxes. Translatable & Clear

Don't:

• Split the sentence in the leading label across the choices. Translatable

Keyboard navigation

Key	Function
Tab	It moves the focus to the next Checkbox within a group or to the next interactive element in tab order.
Shift + Tab	It moves the focus to the previous Checkbox within a group or to the previous interactive element.
Space	If the focus is placed on the Checkbox, it toggles the Checkbox state.

References

1. Web Content Accessibility Guidelines (WCAG) 2.1 – Success Criterion 1.4.3 Contrast (Minimum)
2. MDN: <input type="checkbox"> Indeterminate state checkboxes

Demos

Open up the browser console to see events emitted on input.

Configurable

Checkbox

<cdx-checkbox v-model="checkboxValue" />

Name	Value
Props
status	default error
disabled
indeterminate
View
Reading direction	Left to right (LTR) Right to left (RTL)

Single checkbox with label and description

Always include label text via the default slot. You can also add description text via the #description slot.

A single checkbox does not need an inputValue prop. v-model is bound to a boolean value: true for checked, false for unchecked.

Checkbox value: false

Send password reset emails only when both email address and username are provided. This improves privacy and helps prevent unsolicited emails.

NPM

<template>
	<p class="cdx-docs-demo-text">
		Checkbox value: {{ checkboxValue }}
	</p>

	<cdx-checkbox v-model="checkboxValue" @update:model-value="onUpdate">
		Send password reset emails only when both email address and username are provided.
		<template #description>
			This improves privacy and helps prevent unsolicited emails.
		</template>
	</cdx-checkbox>
</template>

<script>
import { defineComponent, ref } from 'vue';
import { CdxCheckbox } from '@wikimedia/codex';

export default defineComponent( {
	name: 'CheckboxWithDescription',
	components: { CdxCheckbox },
	setup() {
		const checkboxValue = ref( false );

		function onUpdate( value ) {
			// eslint-disable-next-line no-console
			console.log( 'update:modelValue event emitted with value:', value );
		}

		return {
			checkboxValue,
			onUpdate
		};
	}
} );
</script>

MediaWiki

<template>
	<p class="cdx-docs-demo-text">
		Checkbox value: {{ checkboxValue }}
	</p>

	<cdx-checkbox v-model="checkboxValue" @update:model-value="onUpdate">
		Send password reset emails only when both email address and username are provided.
		<template #description>
			This improves privacy and helps prevent unsolicited emails.
		</template>
	</cdx-checkbox>
</template>

<script>
const { defineComponent, ref } = require( 'vue' );
const { CdxCheckbox } = require( '@wikimedia/codex' );

module.exports = defineComponent( {
	name: 'CheckboxWithDescription',
	components: { CdxCheckbox },
	setup() {
		const checkboxValue = ref( false );

		function onUpdate( value ) {
			// eslint-disable-next-line no-console
			console.log( 'update:modelValue event emitted with value:', value );
		}

		return {
			checkboxValue,
			onUpdate
		};
	}
} );
</script>

Name	Value
View
Reading direction	Left to right (LTR) Right to left (RTL)

Form field

When used in a form, a single Checkbox or group of Checkboxes can be wrapped in the Field component to add features like a semantic label, description and help text, validation messages, and more. See the Field page for more information.

When building a Checkbox field, always set isFieldset to true, even for a single Checkbox, to ensure accessibility support. This wraps the group in a <fieldset> element and labels it with an associated <legend>.

If using a Checkbox or Checkbox group outside of a form, follow the instructions in the next demo.

Discussion pages These options are provided for the Discussion Tools Beta Feature.

Enable quick replying

Enable quick topic adding

Automatically subscribe to topics

Learn more about these features at the feature summary. These tools require JavaScript to be enabled in your browser.

NPM

<template>
	<cdx-field :is-fieldset="true">
		<cdx-checkbox
			v-for="checkbox in checkboxes"
			:key="'checkbox-' + checkbox.value"
			v-model="checkboxValue"
			:input-value="checkbox.value"
		>
			{{ checkbox.label }}
		</cdx-checkbox>
		<template #label>
			Discussion pages
		</template>
		<template #description>
			These options are provided for the Discussion Tools Beta Feature.
		</template>
		<template #help-text>
			Learn more about these features at the <a href="#">feature summary</a>.
			These tools require JavaScript to be enabled in your browser.
		</template>
	</cdx-field>
</template>

<script>
import { defineComponent, ref } from 'vue';
import { CdxCheckbox, CdxField } from '@wikimedia/codex';

export default defineComponent( {
	name: 'CheckboxField',
	components: { CdxCheckbox, CdxField },
	setup() {
		const checkboxValue = ref( [ 'quickReply', 'quickTopic' ] );
		const checkboxes = [
			{
				label: 'Enable quick replying',
				value: 'quickReply'
			},
			{
				label: 'Enable quick topic adding',
				value: 'quickTopic'
			},
			{
				label: 'Automatically subscribe to topics',
				value: 'autoSubscribe'
			}
		];

		return {
			checkboxValue,
			checkboxes
		};
	}
} );
</script>

MediaWiki

<template>
	<cdx-field :is-fieldset="true">
		<cdx-checkbox
			v-for="checkbox in checkboxes"
			:key="'checkbox-' + checkbox.value"
			v-model="checkboxValue"
			:input-value="checkbox.value"
		>
			{{ checkbox.label }}
		</cdx-checkbox>
		<template #label>
			Discussion pages
		</template>
		<template #description>
			These options are provided for the Discussion Tools Beta Feature.
		</template>
		<template #help-text>
			Learn more about these features at the <a href="#">feature summary</a>.
			These tools require JavaScript to be enabled in your browser.
		</template>
	</cdx-field>
</template>

<script>
const { defineComponent, ref } = require( 'vue' );
const { CdxCheckbox, CdxField } = require( '@wikimedia/codex' );

module.exports = defineComponent( {
	name: 'CheckboxField',
	components: { CdxCheckbox, CdxField },
	setup() {
		const checkboxValue = ref( [ 'quickReply', 'quickTopic' ] );
		const checkboxes = [
			{
				label: 'Enable quick replying',
				value: 'quickReply'
			},
			{
				label: 'Enable quick topic adding',
				value: 'quickTopic'
			},
			{
				label: 'Automatically subscribe to topics',
				value: 'autoSubscribe'
			}
		];

		return {
			checkboxValue,
			checkboxes
		};
	}
} );
</script>

Checkbox group

For a group of related checkboxes, each Checkbox component's v-model will be bound to an array of the inputValue props of the checkboxes that are currently "on".

This demo shows what to do when using a Checkbox group outside of a form:

1. Wrap the group in an element with role="group"
2. Connect the group with a label via the aria-labelledby attribute

Checkbox group value: [ "checkbox-2", "checkbox-6" ]

Checkbox group demo

Checkbox 1

Checkbox 2 (initially selected)

Checkbox 3, which has a very long label that spans onto a second line to demonstrate what happens when text wraps

Checkbox 4 (indeterminate)

Checkbox 5 (disabled)

Checkbox 6 (initially selected, disabled)

NPM

<template>
	<div>
		<p class="cdx-docs-demo-text">
			Checkbox group value: {{ checkboxValue }}
		</p>

		<div role="group" aria-labelledby="cdx-demo-checkbox-group-label">
			<cdx-label id="cdx-demo-checkbox-group-label">
				Checkbox group demo
			</cdx-label>

			<cdx-checkbox
				v-for="checkbox in checkboxes"
				:key="'checkbox-' + checkbox.value"
				v-model="checkboxValue"
				:input-value="checkbox.value"
				:disabled="checkbox.disabled"
				:indeterminate="checkbox.indeterminate"
				@update:model-value="onUpdate"
			>
				{{ checkbox.label }}
			</cdx-checkbox>
		</div>
	</div>
</template>

<script>
import { defineComponent, ref } from 'vue';
import { CdxCheckbox, CdxLabel } from '@wikimedia/codex';

export default defineComponent( {
	name: 'CheckboxGroup',
	components: { CdxCheckbox, CdxLabel },
	setup() {
		const checkboxValue = ref( [ 'checkbox-2', 'checkbox-6' ] );
		const checkboxes = [
			{
				label: 'Checkbox 1',
				value: 'checkbox-1',
				disabled: false
			},
			{
				label: 'Checkbox 2 (initially selected)',
				value: 'checkbox-2',
				disabled: false
			},
			{
				label: 'Checkbox 3, which has a very long label that spans onto a second line to demonstrate what happens when text wraps',
				value: 'checkbox-3',
				disabled: false
			},
			{
				label: 'Checkbox 4 (indeterminate)',
				value: 'checkbox-4',
				indeterminate: true,
				disabled: false
			},
			{
				label: 'Checkbox 5 (disabled)',
				value: 'checkbox-5',
				disabled: true
			},
			{
				label: 'Checkbox 6 (initially selected, disabled)',
				value: 'checkbox-6',
				disabled: true
			}
		];

		function onUpdate( value ) {
			// eslint-disable-next-line no-console
			console.log( 'update:modelValue event emitted with value:', value );
		}

		return {
			checkboxValue,
			checkboxes,
			onUpdate
		};
	}
} );
</script>

MediaWiki

<template>
	<div>
		<p class="cdx-docs-demo-text">
			Checkbox group value: {{ checkboxValue }}
		</p>

		<div role="group" aria-labelledby="cdx-demo-checkbox-group-label">
			<cdx-label id="cdx-demo-checkbox-group-label">
				Checkbox group demo
			</cdx-label>

			<cdx-checkbox
				v-for="checkbox in checkboxes"
				:key="'checkbox-' + checkbox.value"
				v-model="checkboxValue"
				:input-value="checkbox.value"
				:disabled="checkbox.disabled"
				:indeterminate="checkbox.indeterminate"
				@update:model-value="onUpdate"
			>
				{{ checkbox.label }}
			</cdx-checkbox>
		</div>
	</div>
</template>

<script>
const { defineComponent, ref } = require( 'vue' );
const { CdxCheckbox, CdxLabel } = require( '@wikimedia/codex' );

module.exports = defineComponent( {
	name: 'CheckboxGroup',
	components: { CdxCheckbox, CdxLabel },
	setup() {
		const checkboxValue = ref( [ 'checkbox-2', 'checkbox-6' ] );
		const checkboxes = [
			{
				label: 'Checkbox 1',
				value: 'checkbox-1',
				disabled: false
			},
			{
				label: 'Checkbox 2 (initially selected)',
				value: 'checkbox-2',
				disabled: false
			},
			{
				label: 'Checkbox 3, which has a very long label that spans onto a second line to demonstrate what happens when text wraps',
				value: 'checkbox-3',
				disabled: false
			},
			{
				label: 'Checkbox 4 (indeterminate)',
				value: 'checkbox-4',
				indeterminate: true,
				disabled: false
			},
			{
				label: 'Checkbox 5 (disabled)',
				value: 'checkbox-5',
				disabled: true
			},
			{
				label: 'Checkbox 6 (initially selected, disabled)',
				value: 'checkbox-6',
				disabled: true
			}
		];

		function onUpdate( value ) {
			// eslint-disable-next-line no-console
			console.log( 'update:modelValue event emitted with value:', value );
		}

		return {
			checkboxValue,
			checkboxes,
			onUpdate
		};
	}
} );
</script>

Inline checkboxes

Use the inline prop to get an inline layout.

Checkbox 1

Checkbox 2

NPM

<template>
	<div>
		<cdx-checkbox
			v-model="checkbox1Value"
			input-value="checkbox-1"
			:inline="true"
			@update:model-value="onUpdate"
		>
			Checkbox 1
		</cdx-checkbox>
		<cdx-checkbox
			v-model="checkbox2Value"
			input-value="checkbox-2"
			:inline="true"
			@update:model-value="onUpdate"
		>
			Checkbox 2
		</cdx-checkbox>
	</div>
</template>

<script>
import { defineComponent, ref } from 'vue';
import { CdxCheckbox } from '@wikimedia/codex';

export default defineComponent( {
	name: 'InlineCheckboxes',
	components: { CdxCheckbox },
	setup() {
		const checkbox1Value = ref( true );
		const checkbox2Value = ref( false );

		function onUpdate( value ) {
			// eslint-disable-next-line no-console
			console.log( 'update:modelValue event emitted with value:', value );
		}

		return {
			checkbox1Value,
			checkbox2Value,
			onUpdate
		};
	}
} );
</script>

MediaWiki

<template>
	<div>
		<cdx-checkbox
			v-model="checkbox1Value"
			input-value="checkbox-1"
			:inline="true"
			@update:model-value="onUpdate"
		>
			Checkbox 1
		</cdx-checkbox>
		<cdx-checkbox
			v-model="checkbox2Value"
			input-value="checkbox-2"
			:inline="true"
			@update:model-value="onUpdate"
		>
			Checkbox 2
		</cdx-checkbox>
	</div>
</template>

<script>
const { defineComponent, ref } = require( 'vue' );
const { CdxCheckbox } = require( '@wikimedia/codex' );

module.exports = defineComponent( {
	name: 'InlineCheckboxes',
	components: { CdxCheckbox },
	setup() {
		const checkbox1Value = ref( true );
		const checkbox2Value = ref( false );

		function onUpdate( value ) {
			// eslint-disable-next-line no-console
			console.log( 'update:modelValue event emitted with value:', value );
		}

		return {
			checkbox1Value,
			checkbox2Value,
			onUpdate
		};
	}
} );
</script>

Indeterminate state

The indeterminate state indicates that a checkbox is neither on nor off. Within this component, this state is purely visual. The parent component must house the logic to set a checkbox to the indeterminate state via this prop (e.g. in the case of a set of nested checkboxes where some boxes are checked and some are not, making the parent checkbox neither fully on nor fully off).

This prop is independent of the value provided by v-model. If indeterminate is set to true, the indeterminate visual state will display, but the value will not be affected. Nor will the value affect the visual state: indeterminate overrides the checked and unchecked visual states. If indeterminate changes to false, the visual state will reflect the current v-model value.

In the example below, all of the checkboxes have their indeterminate prop set to true initially. As a result, they all appear to be in the indeterminate state initially, whether they are checked or not. Checking or unchecking a checkbox will undo the indeterminate state since you have provided a definite value for the checkbox.

Checkbox group value: [ "checkbox-2", "checkbox-4" ]

Indeterminate checkbox demos

Checkbox 1

Checkbox 2 (initially selected)

Checkbox 3 (disabled)

Checkbox 4 (initially selected, disabled)

NPM

<template>
	<div>
		<p class="cdx-docs-demo-text">
			Checkbox group value: {{ checkboxValue }}
		</p>

		<cdx-field :is-fieldset="true" :hide-label="true">
			<template #label>
				Indeterminate checkbox demos
			</template>
			<cdx-checkbox
				v-for="checkbox in checkboxes"
				:key="'checkbox-' + checkbox.value"
				v-model="checkboxValue"
				:input-value="checkbox.value"
				:disabled="checkbox.disabled"
				:indeterminate="true"
				@update:model-value="onUpdate"
			>
				{{ checkbox.label }}
			</cdx-checkbox>
		</cdx-field>
	</div>
</template>

<script>
import { defineComponent, ref } from 'vue';
import { CdxCheckbox, CdxField } from '@wikimedia/codex';

export default defineComponent( {
	name: 'IndeterminateState',
	components: { CdxCheckbox, CdxField },
	setup() {
		const checkboxValue = ref( [ 'checkbox-2', 'checkbox-4' ] );
		const checkboxes = [
			{
				label: 'Checkbox 1',
				value: 'checkbox-1',
				disabled: false
			},
			{
				label: 'Checkbox 2 (initially selected)',
				value: 'checkbox-2',
				disabled: false
			},
			{
				label: 'Checkbox 3 (disabled)',
				value: 'checkbox-3',
				disabled: true
			},
			{
				label: 'Checkbox 4 (initially selected, disabled)',
				value: 'checkbox-4',
				disabled: true
			}
		];

		function onUpdate( value ) {
			// eslint-disable-next-line no-console
			console.log( 'update:modelValue event emitted with value:', value );
		}

		return {
			checkboxValue,
			checkboxes,
			onUpdate
		};
	}
} );
</script>

MediaWiki

<template>
	<div>
		<p class="cdx-docs-demo-text">
			Checkbox group value: {{ checkboxValue }}
		</p>

		<cdx-field :is-fieldset="true" :hide-label="true">
			<template #label>
				Indeterminate checkbox demos
			</template>
			<cdx-checkbox
				v-for="checkbox in checkboxes"
				:key="'checkbox-' + checkbox.value"
				v-model="checkboxValue"
				:input-value="checkbox.value"
				:disabled="checkbox.disabled"
				:indeterminate="true"
				@update:model-value="onUpdate"
			>
				{{ checkbox.label }}
			</cdx-checkbox>
		</cdx-field>
	</div>
</template>

<script>
const { defineComponent, ref } = require( 'vue' );
const { CdxCheckbox, CdxField } = require( '@wikimedia/codex' );

module.exports = defineComponent( {
	name: 'IndeterminateState',
	components: { CdxCheckbox, CdxField },
	setup() {
		const checkboxValue = ref( [ 'checkbox-2', 'checkbox-4' ] );
		const checkboxes = [
			{
				label: 'Checkbox 1',
				value: 'checkbox-1',
				disabled: false
			},
			{
				label: 'Checkbox 2 (initially selected)',
				value: 'checkbox-2',
				disabled: false
			},
			{
				label: 'Checkbox 3 (disabled)',
				value: 'checkbox-3',
				disabled: true
			},
			{
				label: 'Checkbox 4 (initially selected, disabled)',
				value: 'checkbox-4',
				disabled: true
			}
		];

		function onUpdate( value ) {
			// eslint-disable-next-line no-console
			console.log( 'update:modelValue event emitted with value:', value );
		}

		return {
			checkboxValue,
			checkboxes,
			onUpdate
		};
	}
} );
</script>

With custom input

To add a custom input, use the custom-input slot to pass in an input like TextInput, TextArea, Select, Combobox, ChipInput, Lookup, or a combination of more than one input.

In the example below, the custom input is always visible but remains disabled until the parent Checkbox is selected. Inside the custom input <div>, a Field wraps the TextInput to display its own validation message.

Form data: { "options": [ "quickReply", "quickTopic" ], "otherValue": "" }

Discussion pages These options are provided for the Discussion Tools Beta Feature.

Enable quick replying

Enable quick topic adding

Automatically subscribe to topics

Other

Learn more about these features at the feature summary. These tools require JavaScript to be enabled in your browser.

NPM

<template>
	<p class="cdx-docs-demo-text">
		Form data: {{ formData }}
	</p>
	<!-- Note: This form does not POST or GET on submit -->
	<form
		id="discussion-pages"
		name="discussion-form"
	>
		<cdx-field
			:is-fieldset="true"
			:status="status"
			:messages="messages"
			form="discussion-pages"
		>
			<cdx-checkbox
				v-for="checkbox in checkboxes"
				:key="'checkbox-' + checkbox.value"
				v-model="checkboxValue"
				name="checkbox-with-custom-input-demo"
				:input-value="checkbox.value"
				@change="validate( $event )"
			>
				{{ checkbox.label }}
				<template v-if="checkbox.value === 'other'" #custom-input>
					<cdx-field
						:is-fieldset="true"
						:status="textFieldStatus"
						:messages="textFieldMessages"
						class="my-custom-input-field"
					>
						<cdx-text-input
							v-model="inputValue"
							:disabled="!checkboxValue.includes( 'other' )"
							aria-label="TextInput custom input"
							placeholder="Custom option..."
						/>
					</cdx-field>
				</template>
			</cdx-checkbox>
			<template #label>
				Discussion pages
			</template>
			<template #description>
				These options are provided for the Discussion Tools Beta Feature.
			</template>
			<template #help-text>
				Learn more about these features at the <a href="#">feature summary</a>.
				These tools require JavaScript to be enabled in your browser.
			</template>
		</cdx-field>
		<cdx-button
			class="my-button"
			action="progressive"
			weight="primary"
			form="discussion-pages"
			name="submit-discussion-pages"
			type="submit"
			@click.prevent="onSubmit"
		>
			Submit
		</cdx-button>
	</form>
</template>

<script>
import { defineComponent, ref, computed, watch } from 'vue';
import { CdxCheckbox, CdxField, CdxTextInput, CdxButton } from '@wikimedia/codex';

export default defineComponent( {
	name: 'CheckboxWithCustomInput',
	components: { CdxCheckbox, CdxField, CdxTextInput, CdxButton },
	setup() {
		const checkboxValue = ref( [ 'quickReply', 'quickTopic' ] );
		const checkboxes = [
			{
				label: 'Enable quick replying',
				value: 'quickReply'
			},
			{
				label: 'Enable quick topic adding',
				value: 'quickTopic'
			},
			{
				label: 'Automatically subscribe to topics',
				value: 'autoSubscribe'
			},
			{
				label: 'Other',
				value: 'other'
			}
		];

		const inputValue = ref( '' );

		// Capture form data.
		const formData = computed( () => ( {
			options: checkboxValue,
			otherValue: inputValue
		} ) );

		// Validation
		const status = ref( 'default' );
		const textFieldStatus = ref( 'default' );
		const messages = { error: 'Please select at least one option' };
		const textFieldMessages = { error: '"Other" option must be provided' };
		function validate() {
			if ( checkboxValue.value.includes( 'other' ) ) {
				// When "other" checkbox is checked, ensure the custom input has a value.
				return inputValue.value.length > 0;
			} else if ( checkboxValue.value.length > 0 ) {
				// When a checkbox other than "other" is checked.
				return true;
			} else {
				// When no checkbox is checked, validation fails.
				return false;
			}
		}

		function onSubmit() {
			// When validation is successful, show the success message.
			if ( validate() ) {
				status.value = 'default';
				textFieldStatus.value = 'default';
				// eslint-disable-next-line no-alert
				alert( 'Validation successful!' );
			// When validation is unsuccessful, show an error state.
			} else if ( checkboxValue.value.includes( 'other' ) && inputValue.value.length === 0 ) {
				// When "other" is checked and text field is empty, show text field's error state.
				textFieldStatus.value = 'error';
			} else {
				// When validation is not successful (no checked checkbox), show the error state.
				status.value = 'error';
			}
		}

		watch( checkboxValue, () => {
			if ( validate() ) {
				// Reset the statuses when checkbox selection changes.
				status.value = 'default';
				textFieldStatus.value = 'default';
			} else if ( checkboxValue.value.length > 0 ) {
				// When validation is unsuceessful, reset the statuses when any checkbox
				// including "other" is selected.
				status.value = 'default';
				textFieldStatus.value = 'default';
			}
		} );

		watch( inputValue, () => {
			if ( validate() ) {
				// Reset the statuses when input changes.
				status.value = 'default';
				textFieldStatus.value = 'default';
			}
		} );

		return {
			checkboxValue,
			checkboxes,
			inputValue,
			formData,
			status,
			messages,
			validate,
			textFieldStatus,
			textFieldMessages,
			onSubmit
		};
	}
} );
</script>

<style lang="less">
@import ( reference ) '@wikimedia/codex-design-tokens/theme-wikimedia-ui.less';

.my-button {
	margin-top: @spacing-100;
}

.my-custom-input-field {
	.cdx-label {
		padding: 0;
	}

	.cdx-field__help-text {
		margin: 0;
	}
}

</style>

MediaWiki

<template>
	<p class="cdx-docs-demo-text">
		Form data: {{ formData }}
	</p>
	<!-- Note: This form does not POST or GET on submit -->
	<form
		id="discussion-pages"
		name="discussion-form"
	>
		<cdx-field
			:is-fieldset="true"
			:status="status"
			:messages="messages"
			form="discussion-pages"
		>
			<cdx-checkbox
				v-for="checkbox in checkboxes"
				:key="'checkbox-' + checkbox.value"
				v-model="checkboxValue"
				name="checkbox-with-custom-input-demo"
				:input-value="checkbox.value"
				@change="validate( $event )"
			>
				{{ checkbox.label }}
				<template v-if="checkbox.value === 'other'" #custom-input>
					<cdx-field
						:is-fieldset="true"
						:status="textFieldStatus"
						:messages="textFieldMessages"
						class="my-custom-input-field"
					>
						<cdx-text-input
							v-model="inputValue"
							:disabled="!checkboxValue.includes( 'other' )"
							aria-label="TextInput custom input"
							placeholder="Custom option..."
						></cdx-text-input>
					</cdx-field>
				</template>
			</cdx-checkbox>
			<template #label>
				Discussion pages
			</template>
			<template #description>
				These options are provided for the Discussion Tools Beta Feature.
			</template>
			<template #help-text>
				Learn more about these features at the <a href="#">feature summary</a>.
				These tools require JavaScript to be enabled in your browser.
			</template>
		</cdx-field>
		<cdx-button
			class="my-button"
			action="progressive"
			weight="primary"
			form="discussion-pages"
			name="submit-discussion-pages"
			type="submit"
			@click.prevent="onSubmit"
		>
			Submit
		</cdx-button>
	</form>
</template>

<script>
const { defineComponent, ref, computed, watch } = require( 'vue' );
const { CdxCheckbox, CdxField, CdxTextInput, CdxButton } = require( '@wikimedia/codex' );

module.exports = defineComponent( {
	name: 'CheckboxWithCustomInput',
	components: { CdxCheckbox, CdxField, CdxTextInput, CdxButton },
	setup() {
		const checkboxValue = ref( [ 'quickReply', 'quickTopic' ] );
		const checkboxes = [
			{
				label: 'Enable quick replying',
				value: 'quickReply'
			},
			{
				label: 'Enable quick topic adding',
				value: 'quickTopic'
			},
			{
				label: 'Automatically subscribe to topics',
				value: 'autoSubscribe'
			},
			{
				label: 'Other',
				value: 'other'
			}
		];

		const inputValue = ref( '' );

		// Capture form data.
		const formData = computed( () => ( {
			options: checkboxValue,
			otherValue: inputValue
		} ) );

		// Validation
		const status = ref( 'default' );
		const textFieldStatus = ref( 'default' );
		const messages = { error: 'Please select at least one option' };
		const textFieldMessages = { error: '"Other" option must be provided' };
		function validate() {
			if ( checkboxValue.value.includes( 'other' ) ) {
				// When "other" checkbox is checked, ensure the custom input has a value.
				return inputValue.value.length > 0;
			} else if ( checkboxValue.value.length > 0 ) {
				// When a checkbox other than "other" is checked.
				return true;
			} else {
				// When no checkbox is checked, validation fails.
				return false;
			}
		}

		function onSubmit() {
			// When validation is successful, show the success message.
			if ( validate() ) {
				status.value = 'default';
				textFieldStatus.value = 'default';
				// eslint-disable-next-line no-alert
				alert( 'Validation successful!' );
			// When validation is unsuccessful, show an error state.
			} else if ( checkboxValue.value.includes( 'other' ) && inputValue.value.length === 0 ) {
				// When "other" is checked and text field is empty, show text field's error state.
				textFieldStatus.value = 'error';
			} else {
				// When validation is not successful (no checked checkbox), show the error state.
				status.value = 'error';
			}
		}

		watch( checkboxValue, () => {
			if ( validate() ) {
				// Reset the statuses when checkbox selection changes.
				status.value = 'default';
				textFieldStatus.value = 'default';
			} else if ( checkboxValue.value.length > 0 ) {
				// When validation is unsuceessful, reset the statuses when any checkbox
				// including "other" is selected.
				status.value = 'default';
				textFieldStatus.value = 'default';
			}
		} );

		watch( inputValue, () => {
			if ( validate() ) {
				// Reset the statuses when input changes.
				status.value = 'default';
				textFieldStatus.value = 'default';
			}
		} );

		return {
			checkboxValue,
			checkboxes,
			inputValue,
			formData,
			status,
			messages,
			validate,
			textFieldStatus,
			textFieldMessages,
			onSubmit
		};
	}
} );
</script>

<style lang="less">
@import 'mediawiki.skin.variables.less';

.my-button {
	margin-top: @spacing-100;
}

.my-custom-input-field {
	.cdx-label {
		padding: 0;
	}

	.cdx-field__help-text {
		margin: 0;
	}
}

</style>

Vue usage

Typical use of this component will involve using v-for to loop through an array of items and output a Checkbox component for each one. Each Checkbox will have the same v-model prop, but different inputValue props and label content.

For a single checkbox, the v-model value will be a boolean true when the checkbox is checked and false when unchecked.

For multiple checkboxes, the v-model value will be an array of the inputValue props of any currently checked checkboxes (or an empty array if no checkboxes are checked).

Props

Prop name	Description	Type	Default
modelValue	Value of the checkbox or checkbox group. Provided by v-model binding in the parent component.	(string|number)[]	false
inputValue	HTML "value" attribute to assign to the input. Required for input groups.	string|number|boolean	false
name	HTML "name" attribute to assign to the input.	string	null
disabled	Whether the disabled attribute should be added to the input.	boolean	false
indeterminate	Whether the indeterminate visual state should be displayed. This is unrelated to the value provided by v-model, and the indeterminate visual state will override the checked or unchecked visual state.	boolean	false
inline	Whether the component should display inline. By default, display: block is set and a margin exists between sibling components, for a stacked layout.	boolean	false
hideLabel	Whether the label should be visually hidden. When true, the label will remain accessible to assistive technology.	boolean	false
status	Validation status of the Checkbox.	ValidationStatusType	'default'

Events

Event name	Properties	Description
update:modelValue	modelValue boolean|string[]|number[] - The new model value	Emitted when modelValue changes.

Slots

Name	Description	Bindings
default	Label text.
description	Short description text.
custom-input	Custom input.

CSS-only version

Markup structure

Checkbox 1

<div class="cdx-checkbox">
  <div class="cdx-checkbox__wrapper">
    <!-- <input> element with id, type, and any other necessary attributes.
		The actual input is visually hidden. -->
    <input
      id="checkbox-css-only-1"
      class="cdx-checkbox__input"
      type="checkbox"
    />
    <!-- Empty span that will be styled to look like a checkbox input. -->
    <span class="cdx-checkbox__icon"></span>
    <div class="cdx-checkbox__label cdx-label">
      <!-- Label with `for` attribute matching the input's id. -->
      <label for="checkbox-css-only-1" class="cdx-label__label">
        <span class="cdx-label__label__text"> Checkbox 1 </span>
      </label>
    </div>
  </div>
</div>

With description

To add a description below the label:

• Add a <span> after the <label> element with an ID and class cdx-label__description. Include the description text here.
• Add an aria-describedby attribute to the <input> element whose value is the ID of the description

Send password reset emails only when both email address and username are provided. This improves privacy and helps prevent unsolicited emails.

<div class="cdx-checkbox">
  <div class="cdx-checkbox__wrapper">
    <input
      id="checkbox-description-css-only-1"
      class="cdx-checkbox__input"
      type="checkbox"
      aria-describedby="cdx-description-css-1"
    />
    <span class="cdx-checkbox__icon"></span>
    <div class="cdx-checkbox__label cdx-label">
      <label for="checkbox-description-css-only-1" class="cdx-label__label">
        <span class="cdx-label__label__text">
          Send password reset emails only when both email address and username
          are provided.
        </span>
      </label>
      <span id="cdx-description-css-1" class="cdx-label__description">
        This improves privacy and helps prevent unsolicited emails.
      </span>
    </div>
  </div>
</div>

Checkbox group

Native attributes of the <input> element can be used. For example:

• Add the checked attribute to the <input> element if it should be selected initially.
• Add the disabled attribute to the <input> element if it should be disabled.

Note that indeterminate is not supported in the CSS-only version since it cannot be set without JavaScript.

Always include one of these two features for accessible grouping:

1. If using the Checkbox group in a field, wrap the group in a <fieldset> element and add a <legend> element with the group label. This method is demonstrated below and requires some style resets on <fieldset> and <legend>. You can use the CSS-only Field and Label components to reset browser styles of these elements.
2. If using the Checkbox group outside of a field, wrap the group in a <div> with role="group" and aria-labelledby set to the ID of the group label. See an example of this above.

CSS-only Checkbox group demo

Checkbox 1

Checkbox 2 (initially selected)

Checkbox 3, which has a very long label that spans onto a second line to demonstrate what happens when text wraps

Checkbox 4 (disabled)

Checkbox 5 (initially selected, disabled)

<fieldset class="cdx-field">
  <legend class="cdx-label">
    <span class="cdx-label__label__text">CSS-only Checkbox group demo</span>
  </legend>
  <div class="cdx-field__control">
    <div class="cdx-checkbox">
      <div class="cdx-checkbox__wrapper">
        <input
          id="checkbox-group-css-only-1"
          class="cdx-checkbox__input"
          type="checkbox"
        />
        <span class="cdx-checkbox__icon"></span>
        <div class="cdx-checkbox__label cdx-label">
          <label for="checkbox-group-css-only-1" class="cdx-label__label">
            <span class="cdx-label__label__text"> Checkbox 1 </span>
          </label>
        </div>
      </div>
    </div>
    <div class="cdx-checkbox">
      <div class="cdx-checkbox__wrapper">
        <input
          id="checkbox-group-css-only-2"
          class="cdx-checkbox__input"
          type="checkbox"
          checked
        />
        <span class="cdx-checkbox__icon"></span>
        <div class="cdx-checkbox__label cdx-label">
          <label for="checkbox-group-css-only-2" class="cdx-label__label">
            <span class="cdx-label__label__text">
              Checkbox 2 (initially selected)
            </span>
          </label>
        </div>
      </div>
    </div>
    <div class="cdx-checkbox">
      <div class="cdx-checkbox__wrapper">
        <input
          id="checkbox-group-css-only-3"
          class="cdx-checkbox__input"
          type="checkbox"
        />
        <span class="cdx-checkbox__icon"></span>
        <div class="cdx-checkbox__label cdx-label">
          <label for="checkbox-group-css-only-3" class="cdx-label__label">
            <span class="cdx-label__label__text">
              Checkbox 3, which has a very long label that spans onto a second
              line to demonstrate what happens when text wraps
            </span>
          </label>
        </div>
      </div>
    </div>
    <div class="cdx-checkbox">
      <div class="cdx-checkbox__wrapper">
        <input
          id="checkbox-group-css-only-4"
          class="cdx-checkbox__input"
          type="checkbox"
          disabled
        />
        <span class="cdx-checkbox__icon"></span>
        <div class="cdx-checkbox__label cdx-label">
          <label for="checkbox-group-css-only-4" class="cdx-label__label">
            <span class="cdx-label__label__text"> Checkbox 4 (disabled) </span>
          </label>
        </div>
      </div>
    </div>
    <div class="cdx-checkbox">
      <div class="cdx-checkbox__wrapper">
        <input
          id="checkbox-group-css-only-5"
          class="cdx-checkbox__input"
          type="checkbox"
          checked
          disabled
        />
        <span class="cdx-checkbox__icon"></span>
        <div class="cdx-checkbox__label cdx-label">
          <label for="checkbox-group-css-only-5" class="cdx-label__label">
            <span class="cdx-label__label__text">
              Checkbox 5 (initially selected, disabled)
            </span>
          </label>
        </div>
      </div>
    </div>
  </div>
</fieldset>

Inline checkboxes

Add the cdx-checkbox--inline class to the root element to get an inline layout.

Checkbox 1

Checkbox 2

<div class="cdx-checkbox cdx-checkbox--inline">
  <div class="cdx-checkbox__wrapper">
    <input
      id="checkbox-group-inline-css-only-1"
      class="cdx-checkbox__input"
      type="checkbox"
    />
    <span class="cdx-checkbox__icon"></span>
    <div class="cdx-checkbox__label cdx-label">
      <label for="checkbox-group-inline-css-only-1" class="cdx-label__label">
        <span class="cdx-label__label__text"> Checkbox 1 </span>
      </label>
    </div>
  </div>
</div>
<div class="cdx-checkbox cdx-checkbox--inline">
  <div class="cdx-checkbox__wrapper">
    <input
      id="checkbox-group-inline-css-only-2"
      class="cdx-checkbox__input"
      type="checkbox"
    />
    <span class="cdx-checkbox__icon"></span>
    <div class="cdx-checkbox__label cdx-label">
      <label for="checkbox-group-inline-css-only-2" class="cdx-label__label">
        <span class="cdx-label__label__text"> Checkbox 2 </span>
      </label>
    </div>
  </div>
</div>

With custom input

To add a custom input, add a <div> element with the cdx-radio__custom-input class inside a Checkbox. Inside the custom input, add an input like TextInput, TextArea, Select, Combobox, ChipInput, Lookup, or a combination of more than one input.

CSS-only Checkbox custom input demo

Checkbox 1

Checkbox 2 (initially selected)

Checkbox 3, with custom input

<fieldset class="cdx-field">
  <legend class="cdx-label">
    <span class="cdx-label__label__text"
      >CSS-only Checkbox custom input demo</span
    >
  </legend>
  <div class="cdx-field__control">
    <div class="cdx-checkbox">
      <div class="cdx-checkbox__wrapper">
        <input
          id="checkbox-custom-input-css-only-1"
          class="cdx-checkbox__input"
          type="checkbox"
        />
        <span class="cdx-checkbox__icon"></span>
        <div class="cdx-checkbox__label cdx-label">
          <label
            for="checkbox-custom-input-css-only-1"
            class="cdx-label__label"
          >
            <span class="cdx-label__label__text"> Checkbox 1 </span>
          </label>
        </div>
      </div>
    </div>
    <div class="cdx-checkbox">
      <div class="cdx-checkbox__wrapper">
        <input
          id="checkbox-custom-input-css-only-2"
          class="cdx-checkbox__input"
          type="checkbox"
          checked
        />
        <span class="cdx-checkbox__icon"></span>
        <div class="cdx-checkbox__label cdx-label">
          <label
            for="checkbox-custom-input-css-only-2"
            class="cdx-label__label"
          >
            <span class="cdx-label__label__text">
              Checkbox 2 (initially selected)
            </span>
          </label>
        </div>
      </div>
    </div>
    <div class="cdx-checkbox">
      <div class="cdx-checkbox__wrapper">
        <input
          id="checkbox-custom-input-css-only-3"
          class="cdx-checkbox__input"
          type="checkbox"
        />
        <span class="cdx-checkbox__icon"></span>
        <div class="cdx-checkbox__label cdx-label">
          <label
            for="checkbox-custom-input-css-only-3"
            class="cdx-label__label"
          >
            <span class="cdx-label__label__text">
              Checkbox 3, with custom input
            </span>
          </label>
        </div>
      </div>
      <div class="cdx-checkbox__custom-input">
        <div class="cdx-text-input">
          <input
            class="cdx-text-input__input"
            type="text"
            placeholder="Start typing..."
          />
        </div>
      </div>
    </div>
  </div>
</fieldset>