Skip to content

Commit

Permalink
fix(docz): remove props broked props component samples
Browse files Browse the repository at this point in the history
  • Loading branch information
leonardo.rigon committed Nov 6, 2020
1 parent 2512dbd commit bcf4fbc
Show file tree
Hide file tree
Showing 9 changed files with 113 additions and 29 deletions.
1 change: 0 additions & 1 deletion src/docz/README.md → README.md
Original file line number Diff line number Diff line change
Expand Up @@ -108,7 +108,6 @@ Whenever possible, please make a pull request with the implementation instead of

> If the feature is big, open an issue first for discussion.

## License

This project is licensed under the terms of the
Expand Down
5 changes: 1 addition & 4 deletions src/docz/Advertise.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -4,13 +4,10 @@ route: /advertise
---

import Advertise from '../core/Advertise'
import { Playground, Props } from 'docz'
import { Playground } from 'docz'

# Advertise

## Properties
<Props of={ Advertise } />

## Demo
<Playground style={ { padding: '10px', backgroundColor: 'silver' } }>
<Advertise
Expand Down
5 changes: 1 addition & 4 deletions src/docz/Box.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -4,13 +4,10 @@ route: /box
---

import Box from '../core/Box'
import { Playground, Props } from 'docz'
import { Playground, } from 'docz'

# Box

## Properties
<Props of={ Box } />

## Demo
<Playground style={ { padding: '10px', backgroundColor: 'silver' } }>
<Box>
Expand Down
5 changes: 1 addition & 4 deletions src/docz/Header.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -4,13 +4,10 @@ route: /header
---

import Header from '../core/Header'
import { Playground, Props } from 'docz'
import { Playground } from 'docz'

# Header

## Properties
<Props of={ Header } />

## Demo
<Playground>
<Header style={ { marginBottom: '12px' } } position='relative'>
Expand Down
106 changes: 106 additions & 0 deletions src/docz/Index.mdx
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).
5 changes: 1 addition & 4 deletions src/docz/Sidebar.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -8,13 +8,10 @@ import Container from '../core/Container'
import List from '../core/List'
import ListItem from '../core/ListItem'
import { Backup as IconBackup } from '../icons'
import { Playground, Props } from 'docz'
import { Playground } from 'docz'

# Sidebar

## Properties
<Props of={ Sidebar } />

## Normal
<Playground>
<Container
Expand Down
5 changes: 1 addition & 4 deletions src/docz/Stepper.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -5,13 +5,10 @@ route: /stepper

import Stepper from '../core/Stepper'
import { Delete } from '../icons'
import { Playground, Props } from 'docz'
import { Playground } from 'docz'

# Stepper

## Properties
<Props of={ Stepper } />

## Demo
<Playground>
<Stepper
Expand Down
5 changes: 1 addition & 4 deletions src/docz/Tabs.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -5,13 +5,10 @@ route: /tabs

import Tabs from '../core/Tabs'
import Tab from '../core/Tab'
import { Playground, Props } from 'docz'
import { Playground } from 'docz'

# Tabs

## Properties
<Props of={ Tabs } />

## Demo
<Playground>
<Tabs value={ 0 }>
Expand Down
5 changes: 1 addition & 4 deletions src/docz/Tooltip.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -5,14 +5,11 @@ route: /tooltip

import Tooltip from '../core/Tooltip'
import Button from '../core/Button'
import { Playground, Props } from 'docz'
import { Playground } from 'docz'
import { Add as IconAdd } from '../icons'

# Tooltip

## Properties
<Props of={ Tooltip } />

## Simple tooltip
<Playground>
<Tooltip title='Tooltip'>
Expand Down

0 comments on commit bcf4fbc

Please sign in to comment.