Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/vadimdemedes/ink-spinner
Spinner component for Ink
https://github.com/vadimdemedes/ink-spinner
Last synced: 20 days ago
JSON representation
Spinner component for Ink
- Host: GitHub
- URL: https://github.com/vadimdemedes/ink-spinner
- Owner: vadimdemedes
- License: mit
- Created: 2017-07-15T19:02:09.000Z (almost 7 years ago)
- Default Branch: master
- Last Pushed: 2023-03-07T09:57:15.000Z (over 1 year ago)
- Last Synced: 2024-04-14T14:49:52.017Z (2 months ago)
- Language: TypeScript
- Size: 129 KB
- Stars: 159
- Watchers: 3
- Forks: 22
- Open Issues: 2
-
Metadata Files:
- Readme: readme.md
- License: license
Lists
- awesome-stars - vadimdemedes/ink-spinner - Spinner component for Ink (TypeScript)
- awesome-stars - ink-spinner
README
# 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.
Looking for a version compatible with Ink 2.x? Check out [this release](https://github.com/vadimdemedes/ink-spinner/tree/v3.1.0).
## Install
```
$ npm install ink-spinner
```
## Usage
```jsx
import React from 'react';
import { render, Text } from 'ink';
import Spinner from 'ink-spinner';
render(
{' Loading'}
);
```
## Props
### type
Type: `string`
Defaults: `dots`
Type of a spinner. See [cli-spinners](https://github.com/sindresorhus/cli-spinners) for available spinners.