-
Notifications
You must be signed in to change notification settings - Fork 6
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
fix(docz): remove props broked props component samples
- Loading branch information
leonardo.rigon
committed
Nov 6, 2020
1 parent
2512dbd
commit bcf4fbc
Showing
9 changed files
with
113 additions
and
29 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,106 @@ | ||
--- | ||
name: Index | ||
route: / | ||
--- | ||
import imageUrl from '../../logo.png' | ||
|
||
<!-- Logo --> | ||
<div style={{ display: 'flex', justifyContent: 'center', marginTop: '30px' }}> | ||
<img width="150" src={imageUrl} alt="Flipper-UI logo" /> | ||
<h1 align="center" style={{ marginLeft: "4px"}}>Flipper-UI</h1> | ||
</div> | ||
|
||
## Installation | ||
|
||
Flipper-UI is available as an [npm package](https://www.npmjs.com/package/flipper-ui). | ||
|
||
```sh | ||
// with npm | ||
npm install flipper-ui | ||
|
||
// with yarn | ||
yarn add flipper-ui | ||
``` | ||
|
||
## Usage | ||
|
||
Here is a quick example to get you started, **it's all you need**: | ||
|
||
```jsx | ||
import React from 'react' | ||
import ReactDOM from 'react-dom' | ||
import { Button } from 'flipper-ui' | ||
|
||
function App() { | ||
return ( | ||
<Button variant="contained" color="primary"> | ||
Hello World | ||
</Button> | ||
); | ||
} | ||
|
||
ReactDOM.render(<App />, document.querySelector('#app')); | ||
``` | ||
|
||
## Components | ||
|
||
- [x] Advertise | ||
- [x] AppBar/Header | ||
- [x] AutoComplete | ||
- [x] Avatar | ||
- [x] Badge | ||
- [x] Box | ||
- [x] Button | ||
- [x] Checkbox | ||
- [x] Chip | ||
- [x] Collapse | ||
- [x] DatePicker | ||
- [x] Dialog | ||
- [x] Divider | ||
- [x] Expansion Panel | ||
- [x] Menu | ||
- [x] Fade | ||
- [x] Floating Action Button | ||
- [x] Grow | ||
- [x] Icon | ||
- [x] Icon Button | ||
- [x] List | ||
- [x] ListItem | ||
- [x] Paper | ||
- [x] Progress | ||
- [x] Sidebar/Drawer | ||
- [x] Switcher | ||
- [x] Radio | ||
- [x] RadioGroup | ||
- [x] Select | ||
- [x] Slide | ||
- [x] Snackbar | ||
- [x] Table | ||
- [x] Tabs | ||
- [x] TextArea | ||
- [x] TextField | ||
- [x] Tooltip | ||
- [x] Typography | ||
- [x] Zoom | ||
|
||
## Next Components | ||
|
||
- [ ] Carousel/Gallery | ||
- [ ] Tree | ||
|
||
## Documentation | ||
|
||
Check out our [documentation website](https://nginformatica.github.io/flipper-ui/). | ||
|
||
## Contributing | ||
|
||
Bug reports, feature requests and other contributions are more than welcome! <br/> | ||
Whenever possible, please make a pull request with the implementation instead of just requesting it. | ||
|
||
> If the feature is big, open an issue first for discussion. | ||
|
||
## License | ||
|
||
This project is licensed under the terms of the | ||
[MIT license](/LICENSE). |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters