carbon-design-system/carbon

[Checkbox]: Nested implementation

Open

#12,434 opened on Oct 31, 2022

View on GitHubContributor guide
 (8 comments) (0 reactions) (0 assignees)JavaScript (1,733 forks)batch import
afrohackscomponent: checkboxhacktoberfestneeds: community contributionpackage: @carbon/reactproposal: acceptedtype: enhancement 💡

Repository metrics

Stars
 (7,442 stars)
PR merge metrics
 (Avg merge 9d 14h) (106 merged PRs in 30d)

Description

Discussed in https://github.com/carbon-design-system/carbon/discussions/11916

Originally posted by urbanisierung August 5, 2022 Carbon Docs describe nested checkboxes with parent and child elements:

image

I couldn't find any code docs about that. Is there a ready to use component available? Do you have an example for that?

Thanks!

Acceptance Criteria

  • Coded component in /packages/react for parent checkboxes to support select all/none and show indeterminate state when appropriate
  • Update styling in @carbon/styles to add the extra padding to nested checkboxes to match the design spec
  • Add a new example story to storybook
  • Add the story to be covered by AVT and VRT tests in ./e2e

Contributor guide

Research direction
Implement a parent checkbox component that manages child checkboxes, showing indeterminate state when some children are checked. Use React state to track children selection. Add styling with additional padding for nested checkboxes in @carbon/styles. Create a story in storybook demonstrating the nested checkbox behavior. Add e2e tests for the new story.
Tech stack
javascriptreact
Domain
frontend
Issue type
Feature
DifficultyEstimated implementation difficulty for a new contributor, from 1 for very small changes to 5 for expert-level work.
3
Estimated timeA rough time range for an experienced contributor to investigate, implement, test, and prepare a pull request.
1-2 days
Activity statusHow available the issue appears right now: fresh, active, stale, blocked, or waiting on maintainer input.
Active
ClarityHow clearly the issue explains the expected change, acceptance criteria, and next step.
Clear
Prerequisites
ReactGit
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
65