1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237
|
---
id: Checkbox
section: components
subsection: forms
cssPrefix: pf-v6-c-check
---## Examples
### Basic
```html
<div class="pf-v6-c-check">
<input
class="pf-v6-c-check__input"
type="checkbox"
id="basic-example-example-input"
name="basic-example-example-input"
/>
<label class="pf-v6-c-check__label" for="basic-example-example-input">Check</label>
</div>
```
### Required
```html
<div class="pf-v6-c-check">
<input
class="pf-v6-c-check__input"
type="checkbox"
id="check-required-example-input"
name="check-required-example-input"
/>
<label class="pf-v6-c-check__label" for="check-required-example-input">
Check
<span class="pf-v6-c-check__label-required" aria-hidden="true">*</span>
</label>
</div>
```
### Checked
```html
<div class="pf-v6-c-check">
<input
class="pf-v6-c-check__input"
type="checkbox"
id="check-checked-example-input"
name="check-checked-example-input"
checked
/>
<label
class="pf-v6-c-check__label"
for="check-checked-example-input"
>Check checked</label>
</div>
```
### Label wrapping input
```html
<label class="pf-v6-c-check" for="check-label-wrapping-input-example-input">
<input
class="pf-v6-c-check__input"
type="checkbox"
id="check-label-wrapping-input-example-input"
name="check-label-wrapping-input-example-input"
/>
<span class="pf-v6-c-check__label">Check label wraps input</span>
</label>
```
### Reversed
```html
<div class="pf-v6-c-check">
<label
class="pf-v6-c-check__label"
for="check-reversed-example-input"
>Check reversed</label>
<input
class="pf-v6-c-check__input"
type="checkbox"
id="check-reversed-example-input"
name="check-reversed-example-input"
/>
</div>
```
### Disabled
```html
<div class="pf-v6-c-check">
<input
class="pf-v6-c-check__input"
type="checkbox"
id="check-disabled-example-input"
name="check-disabled-example-input"
disabled
/>
<label
class="pf-v6-c-check__label pf-m-disabled"
for="check-disabled-example-input"
>Check disabled</label>
</div>
<div class="pf-v6-c-check">
<input
class="pf-v6-c-check__input"
type="checkbox"
id="check-disabled-checked-example-input"
name="check-disabled-checked-example-input"
checked
disabled
/>
<label
class="pf-v6-c-check__label pf-m-disabled"
for="check-disabled-checked-example-input"
>Check disabled checked</label>
</div>
```
### With description
```html
<div class="pf-v6-c-check">
<input
class="pf-v6-c-check__input"
type="checkbox"
aria-describedby="check-with-example-description-example-description"
id="check-with-example-description-example-input"
name="check-with-example-description-example-input"
/>
<label
class="pf-v6-c-check__label"
for="check-with-example-description-example-input"
>Check with description</label>
<span
class="pf-v6-c-check__description"
id="check-with-example-description-example-description"
>Single-tenant cloud service hosted and managed by Red Hat that offers high-availability enterprise-grade clusters in a virtual private cloud on AWS od GCP.</span>
</div>
```
### With body
```html
<div class="pf-v6-c-check">
<input
class="pf-v6-c-check__input"
type="checkbox"
id="check-with-example-body-example-input"
name="check-with-example-body-example-input"
/>
<label
class="pf-v6-c-check__label"
for="check-with-example-body-example-input"
>Check with body</label>
<span class="pf-v6-c-check__body">This is where custom content goes.</span>
</div>
```
### With description and body
```html
<div class="pf-v6-c-check">
<input
class="pf-v6-c-check__input"
type="checkbox"
aria-describedby="check-with-example-description-body-example-description"
id="check-with-example-description-body-example-input"
name="check-with-example-description-body-example-input"
/>
<label
class="pf-v6-c-check__label"
for="check-with-example-description-body-example-input"
>Check with description and body</label>
<span
class="pf-v6-c-check__description"
id="check-with-example-description-body-example-description"
>Single-tenant cloud service hosted and managed by Red Hat that offers high-availability enterprise-grade clusters in a virtual private cloud on AWS od GCP.</span>
<span class="pf-v6-c-check__body">This is where custom content goes.</span>
</div>
```
### Standalone input
```html
<label
class="pf-v6-c-check pf-m-standalone"
for="standalone-input-example-input"
>
<input
class="pf-v6-c-check__input"
type="checkbox"
id="standalone-input-example-input"
name="standalone-input-example-input"
aria-label="Standalone check"
/>
</label>
```
## Documentation
### Overview
The Check component is provided for use cases outside of forms. If it is used without label text ensure some sort of label for assistive technologies. (for example: `aria-label`)
If you extend this component or modify the styles of this component, then make sure any hover styles defined are applied to the clickable elements, like `<input>` or `<label>` since hover styles are used to convey the clickable target area of an element. To maximize the target area, use the example html where the `<label>` is the wrapping element.
### Accessibility
| Attribute | Applied to | Outcome |
| -- | -- | -- |
| `disabled` | `.pf-v6-c-check__input` | Indicates that the element is unavailable and removes it from keyboard focus. **Required when input is disabled** |
| `required` | `.pf-v6-c-check__input` | Indicates that the element is required. |
| `aria-describedby` | `.pf-v6-c-check__input` | When using `.pf-v6-c-check__description` make use of this on the input. |
### Usage
| Class | Applied to | Outcome |
| -- | -- | -- |
| `.pf-v6-c-check` | `<div>`, `<label>` | Initiates the check component. **Required** |
| `.pf-v6-c-check__input` | `<input type="checkbox">` | Initiates a check input. **Required** |
| `.pf-v6-c-check__label` | `<label>`, `<span>` | Initiates a label. **Required** |
| `.pf-v6-c-check__label-required` | `<span>` | Initiates a required indicator. |
| `.pf-v6-c-check__description` | `<span>` | Initiates a check description. |
| `.pf-v6-c-check__body` | `<span>` | Initiates a check body. |
| `.pf-m-standalone` | `.pf-v6-c-check` | Modifies the check component for use with a standalone `<input type="checkbox">`. **Required when there is no label** |
| `.pf-m-disabled` | `.pf-v6-c-check__label` | Modifies the check component for the disabled state. **Required when input is disabled** |
|