-
Notifications
You must be signed in to change notification settings - Fork 4
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Merge pull request #9810 from department-of-veterans-affairs/jw-ds-pu…
…blish-checkbox Publish Checkbox documentation
- Loading branch information
Showing
4 changed files
with
60 additions
and
41 deletions.
There are no files selected for viewing
53 changes: 53 additions & 0 deletions
53
VAMobile/documentation/design/Components/Selection and input/Checkbox.md
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,53 @@ | ||
--- | ||
title: Checkbox | ||
--- | ||
|
||
Allows users to select one or more items from a list. Checkboxes are an easily understandable way to indicate that users can select one or more answers to a question or items from a list. | ||
|
||
## Examples | ||
|
||
### Checkbox | ||
|
||
#### Default | ||
**Open in**: [Storybook](https://department-of-veterans-affairs.github.io/va-mobile-library/?path=/docs/checkbox--default) | [Figma](https://www.figma.com/design/Zzt8z60hCtdEzXx2GFWghH/%F0%9F%93%90-Component-Library---Design-System---VA-Mobile?node-id=1415-384&t=iHMS9U3pTWPZb8Qb-4) | ||
<iframe width="620" height="250" alt="Image of component in Storybook" src="https://department-of-veterans-affairs.github.io/va-mobile-library/?path=/story/checkbox--default&full=1&shortcuts=false&singleStory=true" allowfullscreen></iframe> | ||
|
||
#### Tile | ||
**Open in**: [Storybook](https://department-of-veterans-affairs.github.io/va-mobile-library/?path=/docs/checkbox--tile) | [Figma](https://www.figma.com/design/Zzt8z60hCtdEzXx2GFWghH/%F0%9F%93%90-Component-Library---Design-System---VA-Mobile?node-id=1415-384&t=iHMS9U3pTWPZb8Qb-4) | ||
<iframe width="620" height="250" alt="Image of component in Storybook" src="https://department-of-veterans-affairs.github.io/va-mobile-library/?path=/story/checkbox--tile&full=1&shortcuts=false&singleStory=true" allowfullscreen></iframe> | ||
|
||
#### Error | ||
**Open in**: [Storybook](https://department-of-veterans-affairs.github.io/va-mobile-library/?path=/docs/checkbox--error) | [Figma](https://www.figma.com/design/Zzt8z60hCtdEzXx2GFWghH/%F0%9F%93%90-Component-Library---Design-System---VA-Mobile?node-id=1415-384&t=iHMS9U3pTWPZb8Qb-4) | ||
<iframe width="620" height="250" alt="Image of component in Storybook" src="https://department-of-veterans-affairs.github.io/va-mobile-library/?path=/story/checkbox--error&full=1&shortcuts=false&singleStory=true" allowfullscreen></iframe> | ||
|
||
### Checkbox Group | ||
|
||
#### Default | ||
**Open in**: [Storybook](https://department-of-veterans-affairs.github.io/va-mobile-library/?path=/docs/checkbox-group--default) | [Figma](https://www.figma.com/design/Zzt8z60hCtdEzXx2GFWghH/%F0%9F%93%90-Component-Library---Design-System---VA-Mobile?node-id=1415-441&t=iHMS9U3pTWPZb8Qb-4) | ||
<iframe width="620" height="500" alt="Image of component in Storybook" src="https://department-of-veterans-affairs.github.io/va-mobile-library/?path=/story/checkbox-group--default&full=1&shortcuts=false&singleStory=true" allowfullscreen></iframe> | ||
|
||
#### Tile | ||
**Open in**: [Storybook](https://department-of-veterans-affairs.github.io/va-mobile-library/?path=/docs/checkbox-group--tile) | [Figma](https://www.figma.com/design/Zzt8z60hCtdEzXx2GFWghH/%F0%9F%93%90-Component-Library---Design-System---VA-Mobile?node-id=1415-441&t=iHMS9U3pTWPZb8Qb-4) | ||
<iframe width="620" height="500" alt="Image of component in Storybook" src="https://department-of-veterans-affairs.github.io/va-mobile-library/?path=/story/checkbox-group--tile&full=1&shortcuts=false&singleStory=true" allowfullscreen></iframe> | ||
|
||
#### Error | ||
**Open in**: [Storybook](https://department-of-veterans-affairs.github.io/va-mobile-library/?path=/docs/checkbox-group--error) | [Figma](https://www.figma.com/design/Zzt8z60hCtdEzXx2GFWghH/%F0%9F%93%90-Component-Library---Design-System---VA-Mobile?node-id=1415-441&t=iHMS9U3pTWPZb8Qb-4) | ||
<iframe width="620" height="500" alt="Image of component in Storybook" src="https://department-of-veterans-affairs.github.io/va-mobile-library/?path=/story/checkbox-group--error&full=1&shortcuts=false&singleStory=true" allowfullscreen></iframe> | ||
|
||
## Usage | ||
[Refer to the VA Design System for usage guidance](https://design.va.gov/components/form/checkbox) | ||
|
||
## Code usage | ||
**Open Storybook**: [Checkbox](https://department-of-veterans-affairs.github.io/va-mobile-library/?path=/docs/checkbox--docs) | [Checkbox Group](https://department-of-veterans-affairs.github.io/va-mobile-library/?path=/docs/checkbox-group--docs) | ||
|
||
## Content considerations | ||
* Refer to the [VA Design System for content considerations](https://design.va.gov/components/form/checkbox#usage) | ||
|
||
## Accessibility considerations | ||
* Refer to the [VA Design System for accessibility considerations](https://design.va.gov/components/form/checkbox#accessibility-considerations) | ||
* Screenreaders should announce the name, role, and state of each checkbox. | ||
|
||
### Related | ||
* [Checkbox - VA Design System](https://design.va.gov/components/form/checkbox) | ||
* [Checkbox - USWDS](https://designsystem.digital.gov/components/checkbox/) | ||
* [Checkbox - Material Design](https://m3.material.io/components/checkbox/overview) |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters