Files
ohif-viewer/platform/ui/src/components/Button/Button.mdx
T

441 lines
9.6 KiB
Plaintext
Raw Normal View History

2020-02-13 19:43:20 -03:00
---
name: Button
menu: Components
route: components/button
---
import { Playground, Props } from 'docz';
import Button from './';
2020-03-10 16:11:12 -03:00
import IconButton from '../IconButton';
import Icon from './../Icon';
2020-02-13 19:43:20 -03:00
# Button
Buttons are used to execute actions when users interacts with them.
2020-03-03 19:36:45 -03:00
## Import
```javascript
2020-03-23 17:50:58 -03:00
import { Button } from '@ohif/ui';
2020-03-03 19:36:45 -03:00
```
2020-03-06 17:31:25 -03:00
## Outlined Buttons
2020-02-13 19:43:20 -03:00
<Playground>
2020-03-12 13:23:05 -03:00
<div className="p-4">
<Button variant="outlined" className="m-1">
2020-02-13 19:43:20 -03:00
Default
</Button>
<Button variant="contained" color="primary" className="m-1">
2020-02-13 19:43:20 -03:00
Primary
</Button>
<Button variant="contained" color="secondary" className="m-1">
2020-02-13 19:43:20 -03:00
Secondary
</Button>
2020-03-12 13:23:05 -03:00
<Button variant="outlined" color="white" className="m-1">
White
</Button>
</div>
2020-02-13 19:43:20 -03:00
</Playground>
## Outlined Buttons
2020-02-13 19:43:20 -03:00
<Playground>
2020-03-12 13:23:05 -03:00
<div className="p-4">
<Button variant="contained" className="m-1">
2020-02-13 19:43:20 -03:00
Default
</Button>
<Button variant="outlined" color="primary" className="m-1">
2020-02-13 19:43:20 -03:00
Primary
</Button>
<Button variant="outlined" color="secondary" className="m-1">
2020-02-13 19:43:20 -03:00
Secondary
</Button>
2020-03-12 13:23:05 -03:00
<Button variant="contained" color="white" className="m-1">
White
</Button>
</div>
2020-02-13 19:43:20 -03:00
</Playground>
## Text Buttons
<Playground>
2020-03-12 13:23:05 -03:00
<div className="p-4">
<Button variant="text" className="m-1">
2020-02-13 19:43:20 -03:00
Default
</Button>
<Button variant="text" color="primary" className="m-1">
2020-02-13 19:43:20 -03:00
Primary
</Button>
<Button variant="text" color="secondary" className="m-1">
2020-02-13 19:43:20 -03:00
Secondary
</Button>
2020-03-12 13:23:05 -03:00
<Button variant="text" color="white" className="m-1">
White
</Button>
</div>
</Playground>
## Rounded Buttons
<Playground>
<div className="p-4">
<div className="mb-2">
<Button variant="contained" rounded="none" className="m-1">
Non Rounded
</Button>
<Button variant="contained" rounded="small" className="m-1">
Small Rounded
</Button>
<Button variant="contained" rounded="medium" className="m-1">
Medium Rounded
</Button>
<Button variant="contained" rounded="large" className="m-1">
Large Rounded
</Button>
<Button variant="contained" rounded="full" className="m-1">
Full Rounded
</Button>
</div>
<div className="mb-2">
<Button
variant="contained"
rounded="none"
color="primary"
className="m-1"
>
Non Rounded
</Button>
<Button
variant="contained"
rounded="small"
color="primary"
className="m-1"
>
Small Rounded
</Button>
<Button
variant="contained"
rounded="medium"
color="primary"
className="m-1"
>
Medium Rounded
</Button>
<Button
variant="contained"
rounded="large"
color="primary"
className="m-1"
>
Large Rounded
</Button>
<Button
variant="contained"
rounded="full"
color="primary"
className="m-1"
>
Full Rounded
</Button>
</div>
<div className="mb-2">
<Button
variant="contained"
rounded="none"
color="secondary"
className="m-1"
>
Non Rounded
</Button>
<Button
variant="contained"
rounded="small"
color="secondary"
className="m-1"
>
Small Rounded
</Button>
<Button
variant="contained"
rounded="medium"
color="secondary"
className="m-1"
>
Medium Rounded
</Button>
<Button
variant="contained"
rounded="large"
color="secondary"
className="m-1"
>
Large Rounded
</Button>
<Button
variant="contained"
rounded="full"
color="secondary"
className="m-1"
>
Full Rounded
</Button>
</div>
<div className="mb-2">
<Button
variant="contained"
rounded="none"
color="white"
className="m-1"
>
Non Rounded
</Button>
<Button
variant="contained"
rounded="small"
color="white"
className="m-1"
>
Small Rounded
</Button>
<Button
variant="contained"
rounded="medium"
color="white"
className="m-1"
>
Medium Rounded
</Button>
<Button
variant="contained"
rounded="large"
color="white"
className="m-1"
>
Large Rounded
</Button>
<Button
variant="contained"
rounded="full"
color="white"
className="m-1"
>
Full Rounded
</Button>
</div>
</div>
2020-02-13 19:43:20 -03:00
</Playground>
## Sizes
<Playground>
2020-03-12 13:23:05 -03:00
<div className="p-4">
2020-02-13 19:43:20 -03:00
<div>
<Button variant="text" size="small" className="m-1">
2020-02-13 19:43:20 -03:00
Small
</Button>
<Button variant="contained" size="medium" className="m-1">
2020-02-13 19:43:20 -03:00
Medium
</Button>
<Button variant="outlined" size="large" className="m-1">
2020-02-13 19:43:20 -03:00
Large
</Button>
</div>
<div>
<Button
variant="text"
2020-02-13 19:43:20 -03:00
size="small"
color="primary"
className="m-1"
2020-02-13 19:43:20 -03:00
>
Small
</Button>
<Button
variant="contained"
size="medium"
color="primary"
className="m-1"
2020-02-13 19:43:20 -03:00
>
Medium
</Button>
<Button
variant="outlined"
2020-02-13 19:43:20 -03:00
size="large"
color="primary"
className="m-1"
2020-02-13 19:43:20 -03:00
>
large
2020-02-28 15:31:42 -03:00
</Button>
</div>
<div>
<Button
variant="text"
size="small"
color="secondary"
className="m-1"
>
Small
</Button>
<Button
variant="contained"
size="medium"
color="secondary"
className="m-1"
>
Medium
</Button>
<Button
variant="outlined"
size="large"
color="secondary"
className="m-1"
>
Large
</Button>
2020-02-13 19:43:20 -03:00
</div>
2020-03-12 13:23:05 -03:00
</div>
2020-02-13 19:43:20 -03:00
</Playground>
## Buttons with icons
<Playground>
2020-03-12 13:23:05 -03:00
<div className="p-4 flex">
2020-03-10 16:11:12 -03:00
<Button
2020-02-13 19:43:20 -03:00
variant="contained"
color="primary"
className="m-1"
2020-03-10 16:11:12 -03:00
startIcon={<Icon name="settings" />}
2020-02-13 19:43:20 -03:00
>
2020-03-10 16:11:12 -03:00
Settings
2020-02-13 19:43:20 -03:00
</Button>
2020-03-10 16:11:12 -03:00
<Button
2020-02-13 19:43:20 -03:00
variant="contained"
color="primary"
className="m-1"
2020-03-10 16:11:12 -03:00
endIcon={<Icon name="settings" />}
>
Download
</Button>
<Button
variant="outlined"
rounded="full"
color="default"
className="m-1"
endIcon={<Icon name="settings" />}
>
Download
</Button>
</div>
2020-02-13 19:43:20 -03:00
</Playground>
2020-03-03 19:36:45 -03:00
## Icon Buttons
Icon buttons are generally used in toolbars.
```javascript
2020-03-23 17:50:58 -03:00
import { IconButton } from '@ohif/ui';
2020-03-03 19:36:45 -03:00
```
<Playground>
2020-03-12 13:23:05 -03:00
<div className="p-4 flex flex-col items-center">
2020-03-10 16:11:12 -03:00
<div className="">
<IconButton className="m-2">
<Icon name="settings" />
</IconButton>
<IconButton className="m-2" variant="text">
<Icon name="settings" />
</IconButton>
<IconButton className="m-2" variant="outlined" >
<Icon name="settings" />
</IconButton>
</div>
<div>
<IconButton className="m-2" color="primary">
<Icon name="launch-arrow" />
</IconButton>
<IconButton className="m-2" color="primary" variant="text">
<Icon name="launch-arrow" />
</IconButton>
<IconButton className="m-2" color="primary" variant="outlined">
<Icon name="launch-arrow" />
</IconButton>
</div>
<div>
<IconButton className="m-2" color="secondary">
<Icon name="cancel" />
</IconButton>
<IconButton className="m-2" color="secondary" variant="text">
<Icon name="cancel" />
</IconButton>
<IconButton className="m-2" color="secondary" variant="outlined">
<Icon name="cancel" />
</IconButton>
</div>
<div>
<IconButton className="m-2" color="white">
<Icon name="settings" />
</IconButton>
<IconButton className="m-2" variant="text" color="white">
<Icon name="launch-arrow" />
</IconButton>
<IconButton className="m-2" variant="outlined" color="white">
<Icon name="cancel" />
</IconButton>
</div>
</div>
</Playground>
<Playground>
2020-03-12 13:23:05 -03:00
<div className="p-4">
2020-03-10 16:11:12 -03:00
<div className="">
<IconButton className="m-2">
<Icon name="settings" />
</IconButton>
<IconButton className="m-2" variant="outlined" >
<Icon name="settings" />
</IconButton>
<IconButton className="m-2" variant="text">
<Icon name="settings" />
</IconButton>
</div>
<div>
<IconButton className="m-2" color="primary">
<Icon name="launch-arrow" />
</IconButton>
<IconButton className="m-2" color="primary" variant="text">
<Icon name="launch-arrow" />
</IconButton>
<IconButton className="m-2" color="primary" variant="outlined">
<Icon name="launch-arrow" />
</IconButton>
</div>
<div>
<IconButton className="m-2" color="secondary">
<Icon name="cancel" />
</IconButton>
<IconButton className="m-2" color="secondary" variant="text">
<Icon name="cancel" />
</IconButton>
<IconButton className="m-2" color="secondary" variant="outlined">
<Icon name="cancel" />
</IconButton>
</div>
<div>
<IconButton className="m-2" color="white">
<Icon name="settings" />
</IconButton>
<IconButton className="m-2" variant="text" color="white">
<Icon name="launch-arrow" />
</IconButton>
<IconButton className="m-2" variant="outlined" color="white">
<Icon name="cancel" />
</IconButton>
</div>
</div>
2020-03-03 19:36:45 -03:00
</Playground>
2020-03-06 17:31:25 -03:00
## Properties
<Props of={Button} />