View Storybook at: https://master--6184ce54b9c7c1003ac1e1e3.chromatic.com
React Pickers consist of UI Components to solve use cases of "picking"! Be it a radio button, checkbox, dropdown, multi select dropdown, cards. The end goal is to pick one or more options, and most of the times we also want to preselect some options.
The implementation of this picker is done in multiple layers, the bottom most one which drives the logic is a renderless hook. So, you can use that if needed and build any kind of picker you need. The most important aspect of this hook is the prop: dataSource
.
When you implement any picker - the question you would eventually face is where does the picker gets it's options from! We solved it simply introducing a callback function which the component itself calls or you can trigger it too.
dataSource={(q) => {
return [
{ 'label': 'Asia', "value": 'asia' }
{ 'label': 'Europe', "value": 'europe' }
]
}}
You can have something as simple as above, which serves as static data. Do you need to mention the key as "value"? You can override that too if you want. But, "value" seems to cover most of the use cases which we faced.
dataSource={async (q) => {
let response = await callSomeAPI();
return restructureResponseAsOptions(response);
}}
<Picker
label="Select Continent"
dataSource={async (q) => {
let response = await callSomeAPI();
return restructureResponseAsOptions(response);
}}
defaultSelected={[
{ 'label': 'Asia', "value": 'asia' }
]}
/>
<Picker
label="Select Continent(s)"
dataSource={async (q) => {
let response = await callSomeAPI();
return restructureResponseAsOptions(response);
}}
defaultSelected={[
{ 'label': 'Asia', "value": 'asia' }
]}
multiple
/>
- There is a
src
folder where you can write your components - Whichever components you want to be exposed would go into:
index.js
There are two ways you can develop components.
- Run:
yarn storybook
which will run the storybook in your localhost - When you write your own component, also write a
.stories.jsx
and storybook would pick it up
- Create a brand new react js app (Ex: my-app) using following: https://reactjs.org/docs/create-a-new-react-app.html#create-react-app
- Run
yarn link
in current component library. Ex: If you component name is react-tables, you would run yarn link inside react-tables - Go to newly created reactjs app (my-app) and run
yarn link @reusejs/react-tables
- At the same time also run
yarn serve
in react-tables, so that as you make changes, build happens simultaneously and your my-app refreshes it
Hit us on discord on ideas
channel. Propose your ideas, we will blow our brains out.
Right now we don't a lot of hard and fast rules.
Just follow: https://www.atlassian.com/git/tutorials/comparing-workflows/forking-workflow
Basically:
- Fork the component to which you want to contribute
- Make your changes, test it properly
- Raise a Pull Request
Once your pull request is made, a release would be schedule which will push the library to npm to @reusejs org. You can't push to reusejs org.
react-button is freely distributable under the terms of the MIT license.