docs(react): Update to react readme

This commit is contained in:
Josh Thomas
2018-12-19 11:11:59 -06:00
committed by GitHub
parent 394b42c3d5
commit 67f81f6004

View File

@ -3,11 +3,70 @@
These are React specific building blocks on top of `@ionic/core` components/services. These are React specific building blocks on top of `@ionic/core` components/services.
This is still under heavy development. It has not yet been released to NPM but if you want to download and build it please do so. If you would like to see an example app of the implementation please go to our [react conference app](https://github.com/ionic-team/ionic-react-conference-app)
## To Build ## To Build
1. run `npm run build` to build a distro to `dist` Run `npm run build` to build a distro to `dist` directory.
## Publishing # Current Status of Components
1. Run `npm run deploy` Below is a list of components and their current status. Please know that these will not be final implementations but this list can be used to understand current progress.
2. Commit and push any outstanding changes
| Component | Development Status | Tests |
| ------------------ |:------------------:|:-------------:|
| `ion-action-sheet` | under development | :x: |
| `ion-alert` | :white_check_mark: | :x: |
| `ion-app` | :white_check_mark: | :x: |
| `ion-avatar` | :white_check_mark: | :x: |
| `ion-button` | :white_check_mark: | :x: |
| `ion-buttons` | :white_check_mark: | :x: |
| `ion-card` | :white_check_mark: | :x: |
| `ion-card-content` | :white_check_mark: | :x: |
| `ion-card-header` | :white_check_mark: | :x: |
| `ion-col` | :white_check_mark: | :x: |
| `ion-content` | :white_check_mark: | :x: |
| `ion-datetime` | :white_check_mark: | :x: |
| `ion-fab` | :white_check_mark: | :x: |
| `ion-fab-button` | :white_check_mark: | :x: |
| `ion-fab-list` | :white_check_mark: | :x: |
| `ion-grid` | :white_check_mark: | :x: |
| `ion-header` | :white_check_mark: | :x: |
| `ion-icon` | :white_check_mark: | :x: |
| `ion-input` | :white_check_mark: | :x: |
| `ion-item` | :white_check_mark: | :x: |
| `ion-item-divider` | :white_check_mark: | :x: |
| `ion-item-group` | :white_check_mark: | :x: |
| `ion-item-option` | :white_check_mark: | :x: |
| `ion-item-options` | :white_check_mark: | :x: |
| `ion-item-sliding` | :white_check_mark: | :x: |
| `ion-label` | :white_check_mark: | :x: |
| `ion-list` | :white_check_mark: | :x: |
| `ion-list-header` | :white_check_mark: | :x: |
| `ion-loading` | :white_check_mark: | :x: |
| `ion-menu` | :white_check_mark: | :x: |
| `ion-menu-button` | :white_check_mark: | :x: |
| `ion-menu-toggle` | :white_check_mark: | :x: |
| `ion-modal` | under development | :x: |
| `ion-nav` | :white_check_mark: | :x: |
| `ion-popover` | under development | :x: |
| `ion-refresher` | :white_check_mark: | :x: |
| `ion-refresher-content` | :white_check_mark: | :x: |
| `ion-row` | :white_check_mark: | :x: |
| `ion-searchbar` | :white_check_mark: | :x: |
| `ion-segment` | :white_check_mark: | :x: |
| `ion-segment-button` | :white_check_mark: | :x: |
| `ion-select` | :white_check_mark: | :x: |
| `ion-select-option` | :white_check_mark: | :x: |
| `ion-slide` | :white_check_mark: | :x: |
| `ion-slides` | :white_check_mark: | :x: |
| `ion-split-pane` | :white_check_mark: | :x: |
| `ion-tab` | :white_check_mark: | :x: |
| `ion-tab-bar` | :white_check_mark: | :x: |
| `ion-tab-button` | :white_check_mark: | :x: |
| `ion-tabs` | :white_check_mark: | :x: |
| `ion-textarea` | :white_check_mark: | :x: |
| `ion-title` | :white_check_mark: | :x: |
| `ion-toast` | :white_check_mark: | :x: |
| `ion-toggle` | :white_check_mark: | :x: |
| `ion-toolbar` | :white_check_mark: | :x: |