# simple-text-spinner

> This module was created to allow create easy animations with text in node.

Latest version **1.0.16** (published 2017-08-07) · MIT license · 0 weekly downloads

## Install

```sh
npm install simple-text-spinner
pnpm add simple-text-spinner
yarn add simple-text-spinner
bun add simple-text-spinner
```

## Health

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

Positive: no vulnerabilities.

Warnings: low downloads; no types; no esm support.

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 1.0.16 |
| Published | 2017-08-07 |
| First published | 2017-06-06 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | none |
| Module format | CommonJS |
| Dependencies | 0 |
| Known vulnerabilities | 0 |
| Install scripts | no |
| GitHub stars | 0 |
| Author | pagoru |
| Maintainers | pagoru |
| Keywords | spin, spinner, spinning, progress, indicator, text |

## Links

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

## Alternatives

- [ext-list](https://npm.io/package/ext-list.md) — 6.3M weekly downloads
- [@lexical/selection](https://npm.io/package/@lexical/selection.md) — 3.8M weekly downloads
- [@lexical/text](https://npm.io/package/@lexical/text.md) — 3.6M weekly downloads
- [@lexical/clipboard](https://npm.io/package/@lexical/clipboard.md) — 3.0M weekly downloads
- [@tiptap/extension-mention](https://npm.io/package/@tiptap/extension-mention.md) — 3.0M weekly downloads

## Recent versions

- 1.0.16 (latest) — 2017-08-07
- 1.0.15 — 2017-07-18
- 1.0.14 — 2017-06-08
- 1.0.13 — 2017-06-06
- 1.0.12 — 2017-06-06
- 1.0.11 — 2017-06-06
- 1.0.10 — 2017-06-06
- 1.0.9 — 2017-06-06
- 1.0.8 — 2017-06-06
- 1.0.7 — 2017-06-06
- 1.0.6 — 2017-06-06

## README

This module was created to allow create easy animations with text in node.

[![npm version](https://badge.fury.io/js/simple-text-spinner.svg)](https://www.npmjs.com/package/simple-text-spinner) [![License: MIT](https://img.shields.io/badge/License-MIT-yellow.svg)](https://opensource.org/licenses/MIT)

## Installation

```sh
npm install -S simple-text-spinner
```

## Usage
```js
const SimpleTextSpinner = require('simple-text-spinner');

let spinner = new SimpleTextSpinner({options});

//Plays the current animation
spinner.play();
//Stops the current animation
spinner.pause();
//Inverts the animation
spinner.invert();

//Returns the current animation text
spinner.getText();
//Returns the percentatge amount of the animation
spinner.getPercentage();

//Sets the label that will affect the animation, can be undefined.
//Works like jquery ('.class', '#id', 'div')
spinner.setTag(str);
//Sets the interval between every frame of the animation
spinner.setInterval(int);

//Returns if the animations is paused
spinner.isPaused();

//Prints in console the current text
spinner.print();
```

### Options
```js
new SimpleTextSpinner({
  tag: undefined,
  interval: 100,
  paused: false,
  defaultPosition: 0,
  pattern: ['⠇', '⠋', '⠙', '⠸', '⠴', '⠦'],
  inverse: false
});
```

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