@roo-ui/components
Version:
32 lines (21 loc) • 951 B
Markdown
# Image
<!-- STORY -->
## Installation
```shell
$ yarn add @roo-ui/components
```
## Example
```js
import { Image } from '@roo-ui/components';
export default (
<Image src="/example.jpg" />
);
```
## Properties
| Name | Description | Type | Default | Required? |
|:---------|:---------------|:---------|:--------|:----------|
| `src` | image url | `string` | - | ✔︎ |
| `inline` | display inline | `bool` | false | - |
## Customization
This component can be customized with [styled-system](https://github.com/jxnblk/styled-system) by passing props for [space](https://github.com/jxnblk/styled-system/blob/v2.2.5/README.md#space-responsive), [width](https://github.com/jxnblk/styled-system/blob/v2.2.5/README.md#width-responsive),
[height](https://github.com/jxnblk/styled-system/blob/v2.2.5/README.md#layout), or [size](https://github.com/jxnblk/styled-system/blob/v2.2.5/README.md#layout).