# ink-spinner

> Spinner component for Ink

Latest version **5.0.0** (published 2023-03-01) · MIT license · 0 weekly downloads

## Install

```sh
npm install ink-spinner
pnpm add ink-spinner
yarn add ink-spinner
bun add ink-spinner
```

## Health

**Score 28/100 (F)** — status: abandoned.

Positive: has types package; esm support; no vulnerabilities; high quality score.

Warnings: low downloads.

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 5.0.0 |
| Published | 2023-03-01 |
| First published | 2017-07-15 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | separate (@types/ink-spinner) |
| Module format | ESM |
| Node | >=14.16 |
| Dependencies | 1 |
| Unpacked size | 5.3 KB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| GitHub stars | 194 |
| Author | Vadim Demedes |
| Maintainers | vdemedes |
| Keywords | ink, progress, spinner, loader, loading, component, jsx, react |

## Links

- npm: https://www.npmjs.com/package/ink-spinner
- Repository: https://github.com/vadimdemedes/ink-spinner
- Homepage: https://github.com/vadimdemedes/ink-spinner#readme
- Issues: https://github.com/vadimdemedes/ink-spinner/issues
- npm.io page: https://npm.io/package/ink-spinner

## Dependencies (1)

- [cli-spinners](https://npm.io/package/cli-spinners.md) ^2.7.0

## Alternatives

- [mobx-react](https://npm.io/package/mobx-react.md) — 2.8M weekly downloads
- [rc-tree](https://npm.io/package/rc-tree.md) — 2.6M weekly downloads
- [@react-oauth/google](https://npm.io/package/@react-oauth/google.md) — 1.3M weekly downloads
- [@wagmi/connectors](https://npm.io/package/@wagmi/connectors.md) — 877.0K weekly downloads
- [vee-validate](https://npm.io/package/vee-validate.md) — 836.4K weekly downloads

## Recent versions

- 5.0.0 (latest) — 2023-03-01
- 4.0.0-0 (next) — 2020-06-23
- 4.0.3 — 2021-10-05
- 4.0.2 — 2021-05-07
- 4.0.1 — 2020-08-18
- 4.0.0 — 2020-07-26
- 3.1.0 — 2020-06-23
- 3.0.1 — 2019-04-15
- 3.0.0 — 2019-03-04
- 2.0.0 — 2018-05-20
- 1.0.0 — 2017-07-15

## README

# ink-spinner ![test](https://github.com/vadimdemedes/ink-spinner/workflows/test/badge.svg)

> 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(
	<Text>
		<Text color="green">
			<Spinner type="dots" />
		</Text>
		{' Loading'}
	</Text>
);
```

<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.

---
_Source: https://npm.io/package/ink-spinner · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._