react-native-elements-storybook

react-native-elements-storybook copied to clipboard

A Storybook for React Native Elements UI Library

Get Started

Development

1. Install package dependencies

➜  react-native-elements-storybook git:(master) ✗ yarn

2. Start Storybook

➜  react-native-elements-storybook git:(master) ✗ yarn storybook

It will start webpack-dev-server at port 6006 and opens the browser automagically.

╭────────────────────────────────────────────────────╮
│                                                    │
│   Storybook 5.0.6 started                          │
│   20 s for manager and 22 s for preview            │
│                                                    │
│   Local:            http://localhost:6006/         │
│                                                    │
╰────────────────────────────────────────────────────╯

Deployment

1. Export storybook as a static web app and place it inside the .out directory

✗ yarn build-storybook

2. Now you can deploy the content in the .out directory wherever you want.

To test it locally, using serve for example:

✗ npx serve .out

Start Storybook in iOS Simulator

✗ yarn ios

Components included:

• [x] Avatar
• [x] Badge
• [x] Button
• [x] ButtonGroup
• [x] Card
• [x] CheckBox
• [x] Divider
• [x] Header
• [x] Icon
• [x] Image
• [x] Input
• [x] ListItem
• [ ] Overlay
• [x] Pricing
• [ ] Rating
• [ ] SearchBar
• [ ] Slider
• [x] SocialIcon
• [x] Text
• [x] Tile
• [ ] Tooltip

Contributing

Interested in contributing to this repo? Submit a PR for a new feature/bug fix.

First Contributors

We encourage everyone to contribute & submit PR's especially first-time contributors. Look for the label Good First Issue on the issues. Click here to see them.

If there is something you's like to see or request a new feature, please submit an issue or a pull request.