{"componentChunkName":"component---src-templates-cms-page-tsx","path":"/versions/8/develop/checkbox/","result":{"data":{"sitePage":{"pageContext":{"page":{"node":{"title":"Checkbox","navTitle":null,"slug":"develop/checkbox/","hidePage":false,"collapsibleGroup":"components","group":"form-controls","seoDescription":"Checkboxes allow the user to select or unselect options.","cosmosComponent":{"component":{"component":"Checkbox","package":"core"}},"childStrapiDeveloperComponentPageOverviewTextnode":{"overview":"_Note: All components shown on this site are supported by the Constellation design system. To learn how to configure Theme Cosmos, visit [Pega Community](https://docs.pega.com/user-experience/87/theme-cosmos)._\n\nCheckboxes allow users to select or unselect options."},"body":[{"id":"ee21721a-35bb-5bdd-88a0-65bf7f98b6ff","strapi_component":"layout.section","title":"Usage","subSections":[],"childStrapiComponentLayoutSectionBodyTextnode":{"body":"Checkboxes should be used when displaying less than 7 options to choose from. If you require more than 7 options, consider using a [Select](/versions/8/develop/select) Field instead. The Checkbox component allows for standard [Form](/versions/8/develop/form) Field structures such as being set **required**, **disabled**, or **readOnly**, as well as including a **label**, **status**, or **info**.\n\nIf there is a **label** and the Field is not **disabled**, passing an object to the **additionalInfo** prop that includes a **heading** and **content** will provide the user with more useful information on the Field when they click on the associated information [Icon](/versions/8/develop/icon).\n\nUse a single Checkbox for binary selections, such as a decision or affirmation. A user may select and deselect the Checkbox as many times as they like. Do not use the Checkbox when a user MUST make an active decision, such as yes or no (use [RadioButtons](/versions/8/develop/radio-button)) or if you are expecting the changes to apply instantly (use a [Switch](/versions/8/develop/switch))."}},{"id":"6ef13f96-c9cb-5d05-87be-e0e9268e50c4","strapi_component":"demo.code-editor","demo":{"demoName":"DefaultCheckbox","component":"Checkbox","package":"core"}},{"id":"420ab0e1-3b0a-5be2-ab22-f1122cd29fac","strapi_component":"layout.section","title":"CheckboxGroup","subSections":[],"childStrapiComponentLayoutSectionBodyTextnode":{"body":"If there are multiple options to select, wrap the Checkboxes in a CheckboxGroup. By doing so, all of the selections made will belong to the same [Form](/versions/8/develop/form) value."}},{"id":"230b6895-dbc9-548f-88dd-86f55cfdd63d","strapi_component":"demo.code-editor","demo":{"demoName":"CheckboxGroupDemo","component":"CheckboxGroup","package":"core"}},{"id":"d705d562-6bc3-5f72-bf12-e6f2906cb223","strapi_component":"layout.section","title":"Checkbox cards","subSections":[{"id":"33479510-11b9-5cdb-b53f-79472dd14928","title":"Checkbox","childStrapiComponentLayoutSubSectionBodyTextnode":null}],"childStrapiComponentLayoutSectionBodyTextnode":{"body":"A Checkbox can be set to render as a [Card](/versions/8/develop/card) which can be ideal to display large volumes of content within a single wrapper. You can set **variant** to _card_ on either a Checkbox or a CheckboxGroup."}},{"id":"0be07187-9466-5bfd-baf9-5274f0c36250","strapi_component":"demo.code-editor","demo":{"demoName":"CheckboxCard","component":"Checkbox","package":"core"}},{"id":"fe1a6e52-6b4f-56fd-835f-61136a4280ce","strapi_component":"layout.sub-section","title":"CheckboxGroup","childStrapiComponentLayoutSubSectionBodyTextnode":null},{"id":"ba354287-8987-5860-b0df-f15ad207d4a4","strapi_component":"demo.code-editor","demo":{"demoName":"CheckboxCardGroup","component":"CheckboxGroup","package":"core"}}],"relatedComponents":[{"displayText":"Card","link":"/versions/8/develop/card"},{"displayText":"RadioButton","link":"/versions/8/develop/radio-button"},{"displayText":"Select","link":"/versions/8/develop/select"},{"displayText":"Switch","link":"/versions/8/develop/switch"}],"propsTable":true,"themeTree":{"editable":false,"component":true,"target":"checkbox"}}},"slugs":["design/navigate-the-application/","design/pulse/","design/case-lifecycle/","design/case-preview/","design/case-page/","design/date-time-input/","design/location-input/","design/rich-text-editor/","design/app-shell/","design/date-time-display/","design/followers/","design/related-cases/","design/attachments/","design/stakeholders/","design/tasks/","design/card/","design/form/","design/icon/","design/checkbox/","design/currency-input/","design/email-input/","design/field-group/","design/file-input/","design/form-progress/","design/number-input/","design/phone-input/","design/radio-button/","design/select-combobox/","design/text-area/","design/text-input/","design/url-input/","design/breadcrumbs/","design/link/","design/tabs/","design/avatar/","design/badge/","design/banner/","design/empty-state/","design/file-display/","design/app-announcement/","design/modal-dialog/","design/popover/","design/toast/","design/tooltip/","design/field-value-list/","design/meta-list/","design/summary-list/","design/timeline-list/","design/button/","design/skip-links/","design/contextual-information/","design/table/","develop/avatar/","develop/badge/","develop/banner/","develop/boolean/","develop/button/","develop/card/","develop/checkbox/","develop/color-picker/","develop/combo-box/","develop/currency-input/","develop/currency-display/","develop/date-time-display/","develop/date-time-input/","develop/drawer/","develop/email-display/","develop/empty-state/","develop/error-state/","develop/expand-collapse/","develop/field-group/","develop/field-value-list/","develop/file-display/","develop/file-input/","develop/flex/","develop/grid/","develop/image/","develop/input/","develop/label/","develop/link/","develop/location-display/","develop/location-input/","develop/menu-button/","develop/meta-list/","develop/number-display/","develop/number-input/","develop/page-templates/","develop/phone-display/","develop/phone-input/","develop/progress/","develop/radio-button/","develop/rating/","develop/select/","develop/slider/","develop/summary-item/","develop/summary-list/","develop/switch/","develop/tabs/","develop/text/","develop/text-area/","develop/url-display/","develop/configuration/","develop/theme/","develop/search-input/","develop/icon/","develop/credit-card-input/","develop/credit-card-display/","develop/ai-button/","develop/danger-button/","develop/","develop/getting-started-react/","design/manage-your-work/","design/design-tokens/","design/","design/getting-started/","design/patterns/","design/search-for-information/","design/explore-data/","design/create-custom-landing-pages/","design/accessibility/","design/about-components/","design/ui-architecture/","design/start-your-work-day/","design/design-kits/","design/complete-your-work-tasks/","design/ux-writing-guidelines","design/responsive-adaptive/"]}}},"pageContext":{"page":{"node":{"title":"Checkbox","navTitle":null,"slug":"develop/checkbox/","hidePage":false,"collapsibleGroup":"components","group":"form-controls","seoDescription":"Checkboxes allow the user to select or unselect options.","cosmosComponent":{"component":{"component":"Checkbox","package":"core"}},"childStrapiDeveloperComponentPageOverviewTextnode":{"overview":"_Note: All components shown on this site are supported by the Constellation design system. To learn how to configure Theme Cosmos, visit [Pega Community](https://docs.pega.com/user-experience/87/theme-cosmos)._\n\nCheckboxes allow users to select or unselect options."},"body":[{"id":"ee21721a-35bb-5bdd-88a0-65bf7f98b6ff","strapi_component":"layout.section","title":"Usage","subSections":[],"childStrapiComponentLayoutSectionBodyTextnode":{"body":"Checkboxes should be used when displaying less than 7 options to choose from. If you require more than 7 options, consider using a [Select](/versions/8/develop/select) Field instead. The Checkbox component allows for standard [Form](/versions/8/develop/form) Field structures such as being set **required**, **disabled**, or **readOnly**, as well as including a **label**, **status**, or **info**.\n\nIf there is a **label** and the Field is not **disabled**, passing an object to the **additionalInfo** prop that includes a **heading** and **content** will provide the user with more useful information on the Field when they click on the associated information [Icon](/versions/8/develop/icon).\n\nUse a single Checkbox for binary selections, such as a decision or affirmation. A user may select and deselect the Checkbox as many times as they like. Do not use the Checkbox when a user MUST make an active decision, such as yes or no (use [RadioButtons](/versions/8/develop/radio-button)) or if you are expecting the changes to apply instantly (use a [Switch](/versions/8/develop/switch))."}},{"id":"6ef13f96-c9cb-5d05-87be-e0e9268e50c4","strapi_component":"demo.code-editor","demo":{"demoName":"DefaultCheckbox","component":"Checkbox","package":"core"}},{"id":"420ab0e1-3b0a-5be2-ab22-f1122cd29fac","strapi_component":"layout.section","title":"CheckboxGroup","subSections":[],"childStrapiComponentLayoutSectionBodyTextnode":{"body":"If there are multiple options to select, wrap the Checkboxes in a CheckboxGroup. By doing so, all of the selections made will belong to the same [Form](/versions/8/develop/form) value."}},{"id":"230b6895-dbc9-548f-88dd-86f55cfdd63d","strapi_component":"demo.code-editor","demo":{"demoName":"CheckboxGroupDemo","component":"CheckboxGroup","package":"core"}},{"id":"d705d562-6bc3-5f72-bf12-e6f2906cb223","strapi_component":"layout.section","title":"Checkbox cards","subSections":[{"id":"33479510-11b9-5cdb-b53f-79472dd14928","title":"Checkbox","childStrapiComponentLayoutSubSectionBodyTextnode":null}],"childStrapiComponentLayoutSectionBodyTextnode":{"body":"A Checkbox can be set to render as a [Card](/versions/8/develop/card) which can be ideal to display large volumes of content within a single wrapper. You can set **variant** to _card_ on either a Checkbox or a CheckboxGroup."}},{"id":"0be07187-9466-5bfd-baf9-5274f0c36250","strapi_component":"demo.code-editor","demo":{"demoName":"CheckboxCard","component":"Checkbox","package":"core"}},{"id":"fe1a6e52-6b4f-56fd-835f-61136a4280ce","strapi_component":"layout.sub-section","title":"CheckboxGroup","childStrapiComponentLayoutSubSectionBodyTextnode":null},{"id":"ba354287-8987-5860-b0df-f15ad207d4a4","strapi_component":"demo.code-editor","demo":{"demoName":"CheckboxCardGroup","component":"CheckboxGroup","package":"core"}}],"relatedComponents":[{"displayText":"Card","link":"/versions/8/develop/card"},{"displayText":"RadioButton","link":"/versions/8/develop/radio-button"},{"displayText":"Select","link":"/versions/8/develop/select"},{"displayText":"Switch","link":"/versions/8/develop/switch"}],"propsTable":true,"themeTree":{"editable":false,"component":true,"target":"checkbox"}}},"slugs":["design/navigate-the-application/","design/pulse/","design/case-lifecycle/","design/case-preview/","design/case-page/","design/date-time-input/","design/location-input/","design/rich-text-editor/","design/app-shell/","design/date-time-display/","design/followers/","design/related-cases/","design/attachments/","design/stakeholders/","design/tasks/","design/card/","design/form/","design/icon/","design/checkbox/","design/currency-input/","design/email-input/","design/field-group/","design/file-input/","design/form-progress/","design/number-input/","design/phone-input/","design/radio-button/","design/select-combobox/","design/text-area/","design/text-input/","design/url-input/","design/breadcrumbs/","design/link/","design/tabs/","design/avatar/","design/badge/","design/banner/","design/empty-state/","design/file-display/","design/app-announcement/","design/modal-dialog/","design/popover/","design/toast/","design/tooltip/","design/field-value-list/","design/meta-list/","design/summary-list/","design/timeline-list/","design/button/","design/skip-links/","design/contextual-information/","design/table/","develop/avatar/","develop/badge/","develop/banner/","develop/boolean/","develop/button/","develop/card/","develop/checkbox/","develop/color-picker/","develop/combo-box/","develop/currency-input/","develop/currency-display/","develop/date-time-display/","develop/date-time-input/","develop/drawer/","develop/email-display/","develop/empty-state/","develop/error-state/","develop/expand-collapse/","develop/field-group/","develop/field-value-list/","develop/file-display/","develop/file-input/","develop/flex/","develop/grid/","develop/image/","develop/input/","develop/label/","develop/link/","develop/location-display/","develop/location-input/","develop/menu-button/","develop/meta-list/","develop/number-display/","develop/number-input/","develop/page-templates/","develop/phone-display/","develop/phone-input/","develop/progress/","develop/radio-button/","develop/rating/","develop/select/","develop/slider/","develop/summary-item/","develop/summary-list/","develop/switch/","develop/tabs/","develop/text/","develop/text-area/","develop/url-display/","develop/configuration/","develop/theme/","develop/search-input/","develop/icon/","develop/credit-card-input/","develop/credit-card-display/","develop/ai-button/","develop/danger-button/","develop/","develop/getting-started-react/","design/manage-your-work/","design/design-tokens/","design/","design/getting-started/","design/patterns/","design/search-for-information/","design/explore-data/","design/create-custom-landing-pages/","design/accessibility/","design/about-components/","design/ui-architecture/","design/start-your-work-day/","design/design-kits/","design/complete-your-work-tasks/","design/ux-writing-guidelines","design/responsive-adaptive/"]}},"staticQueryHashes":["1103706436","2075638250","2949869146","3642924123","793757994"]}