JedWatson / JedWatson/react-select

Website props are not accurate

Open
#5,356 1 comment 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

issue/bug-unconfirmed
Dominant language
TypeScript
Stars
28k
Forks
4.1k
PR merge metrics
No merged PRs in 30d

Description

Update website examples.

Docs refer to it as isSearchable instead of what actually worked which is searchable. This is this case with other is* props.

Fails (but docs say is correct)
<Select 
    options={sizes}
    searchable={false}
/>
Works
<Select 
    options={sizes}
    searchable={false}
/>

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

Search the website documentation for references to isSearchable, then compare those examples with the Select API and the searchable prop shown in the issue. Correct the inaccurate examples and run the website documentation checks or build to confirm the pages remain valid.

Written by the indexing model from the issue text.

Assessment

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

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.