salesforce / salesforce/design-system-react

Break default Checkbox export's callback

Open
#2,033 0 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

forms: checkbox needs-clarity
Dominant language
JavaScript
Stars
982
Forks
440
Avg merge
1d 21h
Merged PRs (30d)
4

Description

Currently the Checkbox component's onChange returns two different parameters depending on which checkbox file you import.

See https://github.com/salesforce/design-system-react/blob/master/components/forms/checkbox/index.jsx#L1

Contributor guide

Open the contributing guide

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

Start with components/forms/checkbox/index.jsx at the linked line and inspect the default Checkbox export alongside the other checkbox file. Trace how each export supplies onChange arguments and make the callback parameters consistent across imports. Done means the default export no longer returns a different parameter shape.

Written by the indexing model from the issue text.

Assessment

Tech stack
javascript, react
Domain
frontend
Issue type
Bug
Difficulty
2/5
Estimated time
1-3 hours
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
45/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.