44 lines
867 B
Markdown
44 lines
867 B
Markdown
# ink-spinner [](https://travis-ci.org/vadimdemedes/ink-spinner)
|
|
|
|
> Spinner component for [Ink](https://github.com/vadimdemedes/ink). Uses [cli-spinners](https://github.com/sindresorhus/cli-spinners) for the collection of spinners.
|
|
|
|
|
|
## Install
|
|
|
|
```
|
|
$ npm install ink-spinner
|
|
```
|
|
|
|
|
|
## Usage
|
|
|
|
```js
|
|
import React, {Fragment} from 'react';
|
|
import {render, Color} from 'ink';
|
|
import Spinner from 'ink-spinner';
|
|
|
|
render(
|
|
<Fragment>
|
|
<Color green><Spinner type="dots"/></Color>
|
|
{' Loading'}
|
|
</Fragment>
|
|
);
|
|
```
|
|
|
|
<img src="media/demo.gif" width="482">
|
|
|
|
|
|
## Props
|
|
|
|
### type
|
|
|
|
Type: `string`<br>
|
|
Defaults: `dots`
|
|
|
|
Type of a spinner. See [cli-spinners](https://github.com/sindresorhus/cli-spinners) for available spinners.
|
|
|
|
|
|
## License
|
|
|
|
MIT © [Vadim Demedes](https://github.com/vadimdemedes)
|