@roo-ui/components
Version:
42 lines (28 loc) • 1.16 kB
Markdown
# Link
<!-- STORY -->
## Installation
```shell
$ yarn add @roo-ui/components
```
## Example
```js
import { Link } from '@roo-ui/components';
export default (
<Link>Hello world</Link>
);
```
### With [React Router](https://reacttraining.com/react-router/)
```js
import { Link as RouterLink } from 'react-router-dom';
import { Link } from '@roo-ui/components';
export default (
<Link is={RouterLink}>Hello world</Link>
);
```
## Properties
| Name | Description | Type | Default | Required? |
|:---------|:-------------------|:-------|:--------|:----------|
| `hidden` | visually hidden | `bool` | false | - |
| `inline` | inherit font color | `bool` | false | - |
## Customization
This component can be customized with [styled-system](https://github.com/jxnblk/styled-system) by passing props for [color](https://github.com/jxnblk/styled-system/blob/v2.2.5/README.md#color-responsive), [space](https://github.com/jxnblk/styled-system, [hover](https://github.com/jxnblk/styled-system/blob/v2.2.5/README.md#hover), or [font weight](https://github.com/jxnblk/styled-system/blob/v2.2.5/README.md#typography).