> For the complete documentation index, see [llms.txt](https://docs.realmacsoftware.com/elements-docs/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://docs.realmacsoftware.com/elements-docs/using-elements/components/form/checkbox.md). # Checkbox Checkbox creates a group of independently selectable options. Use it for preferences, opt-ins, feature choices, or required acknowledgements. ### How to Use Checkbox You’ll find Checkbox under **Forms** in the Components list. 1. Place Checkbox inside a [Form](/elements-docs/using-elements/components/form.md). 2. Enter a shared Name for the group. 3. Add items to the Options collection. 4. Give every option a visible Label and submitted Value. 5. Enable Required only when every displayed option must be selected. 6. Style checked, unchecked, label, and focus states. ### Component Settings #### Settings **Required** is off by default. When enabled, each rendered Checkbox option is marked as required, so use it when every listed acknowledgement must be selected. **Name** is blank by default. Checkbox submits the selected values as a group using this name. **Alignment** arranges options Horizontally or Vertically and defaults to Vertical. #### Checkbox Use **State** to edit Unchecked and Checked appearance. It defaults to Unchecked. * **Unchecked** — Border Surface 50; Background Surface 50. * **Checked** — Border Brand 500; Background Brand 500. Border Width and Border Radius use Theme Studio controls. #### Options The **Options** collection adds, removes, and reorders choices. Each item contains: * **Label** — Text shown to the visitor. Blank by default. * **Value** — Value included in the submission. Blank by default. Use a stable machine-friendly Value such as `newsletter` rather than repeating a long sentence. #### Label Label colours default to Surface 50 when Unchecked and Brand 500 when Checked. **Font** defaults to Body and **Size** to Base. #### Outline **Type** defaults to None and can be Static or Focus. Focus reveals Unfocused and Focused states. Outline defaults are Solid style, Surface 500 colour, 100% opacity, width 1, and offset 0. #### Sizing and Spacing Checkbox **Size** defaults to theme spacing 4. Option **Gap** defaults to theme spacing 4. ### Accessibility Use labels that make sense when read independently. Keep a visible keyboard-focus outline and place required legal consent in clear text rather than relying on colour or position. ### Related Components * [Radio](/elements-docs/using-elements/components/form/radio.md) — Allows exactly one choice from a group. * [Label](/elements-docs/using-elements/components/form/label.md) — Labels individual fields. * [Form](/elements-docs/using-elements/components/form.md) — Configures delivery and validation. | Common Control | Description | | ------------------------------------------------------------------------------------------------------------------ | ----------------------------------------------------------------------- | | [Link](/elements-docs/using-elements/components/common-controls/link.md) | Link to a page, resource, anchor, email address, or website. | | [Layout](/elements-docs/using-elements/components/common-controls/layout.md) | Control positioning, stacking, visibility, overflow, and isolation. | | [Sizing](/elements-docs/using-elements/components/common-controls/sizing.md) | Set width, height, and responsive size constraints. | | [Spacing](/elements-docs/using-elements/components/common-controls/spacing.md) | Add responsive margin and padding. | | [Typography & Text Styles](/elements-docs/using-elements/components/common-controls/typography-and-text-styles.md) | Control fonts, text spacing, decoration, colour, and semantic wrappers. | | [Backgrounds](/elements-docs/using-elements/components/common-controls/backgrounds.md) | Apply colour, image, gradient, SVG, video, and hover backgrounds. | | [Transitions](/elements-docs/using-elements/components/common-controls/transitions.md) | Choose what animates and set its timing curve, duration, and delay. | | [Effects](/elements-docs/using-elements/components/common-controls/effects.md) | Apply shadows, opacity, and hover effects. | | [Filters](/elements-docs/using-elements/components/common-controls/filters.md) | Apply blur, brightness, saturation, shadow, and backdrop effects. | | [Transforms](/elements-docs/using-elements/components/common-controls/transforms.md) | Scale, rotate, move, and skew components. | | [Borders](/elements-docs/using-elements/components/common-controls/borders.md) | Set border style, colour, opacity, width, radius, and hover states. | | [Advanced](/elements-docs/using-elements/components/common-controls/advanced.md) | Add CSS classes and IDs, or change supported HTML tags. | --- # Agent Instructions This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com. ## Querying This Documentation If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question. Perform an HTTP GET request on the current page URL with the `ask` query parameter, and the optional `goal` query parameter: ``` GET https://docs.realmacsoftware.com/elements-docs/using-elements/components/form/checkbox.md?ask=&goal= ``` `ask` is the immediate question: it should be specific, self-contained, and written in natural language. `goal` is optional and describes the broader end goal you are ultimately trying to accomplish on behalf of the user. GitBook uses it to tailor the answer towards what is most useful for that goal. The response will contain a direct answer to the question and relevant excerpts and sources from the documentation. Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.