https://github.com/vadimdemedes/ink-spinner

Spinner component for Ink
https://github.com/vadimdemedes/ink-spinner

Last synced: about 18 hours 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 (over 7 years ago)
• Default Branch: master
• Last Pushed: 2024-08-18T16:08:50.000Z (3 months ago)
• Last Synced: 2024-10-29T22:38:33.726Z (13 days ago)
• Language: TypeScript
• Size: 129 KB
• Stars: 163
• Watchers: 3
• Forks: 21
• Open Issues: 3
• Metadata Files:
  • Readme: readme.md
  • License: license

Awesome Lists containing this project

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(

	

		

			

		

		{' Loading'}

	

);

```



## Props

### type

Type: `string`


Defaults: `dots`

Type of a spinner. See [cli-spinners](https://github.com/sindresorhus/cli-spinners) for available spinners.