mapbox / mapbox/mr-ui

Document mr-ui ControlSwitch and ControlRange pass through <input> props like disabled

Open
#142 0 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

estimate-1 icebox jira-sync-complete p2
Dominant language
TypeScript
Stars
90
Forks
5
PR merge metrics
No merged PRs in 30d

Description

Right now it's unexpected that ControlSwitch and ControlRange pass through any loose props to ``.

This enabled `disabled` and there's tests for it, but I couldn't find any documentation.

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

Locate the documentation and tests for the ControlSwitch and ControlRange components, then review how loose props are passed to their input elements, including the existing disabled test. Update the component documentation to describe this behavior and confirm that disabled is covered.

Written by the indexing model from the issue text.

Assessment

Tech stack
typescript
Domain
documentation, frontend
Issue type
Documentation
Difficulty
2/5
Estimated time
1-3 hours
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
55/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.