hinata

KO | EN

gitlite — search

#python #java #python3 #arduino #golang #machine-learning #rust #html #flask #javascript #seismology #nodejs

★ 11 Open GitHub ↗

:traffic_light: Your cli spinner which like a marquee.

// repository documentation

Was this content helpful?

★ 0 (0 ratings)

# hinata [![NPM version](https://img.shields.io/npm/v/hinata.svg)](https://npmjs.com/package/hinata) [![NPM downloads](https://img.shields.io/npm/dm/hinata.svg)](https://npmjs.com/package/hinata) [![Build Status](https://img.shields.io/circleci/project/egoist/hinata/master.svg)](https://circleci.com/gh/egoist/hinata)

> Your cli spinner which like a marquee.

![gif](http://ooo.0o0.ooo/2016/03/03/56d90169c39f1.gif)

## Install

```js
$ npm install --save hinata
```

## Usage

```js
const Hinata = require('hinata')

const hinata = new Hinata({char: '❤', spacing: 2})

hinata.start()

setTimeout(() => {
  // update loading text
  hinata.text = 'loading something'
}, 2000)

setTimeout(() => {
  // update loading character
  hinata.char = '.'
  // update character spacing
  hinata.spacing = 0
}, 3000)

setTimeout(() => {
  hinata.stop()
}, 10000)
```

## API

### new Hinata([options])

#### options

**text**

default `''`

Placeholder for loading text, eg: `Loading` in `Loading ...`

**char**

default `.`

Loading character, eg: `❤` in `❤ ❤ ❤ loading webpack`

**length**

default `3`

How many time a loading character should repeat itself.

**color**

default `false`

If set to be true, spinner uses your color instead of a random color.

**spacing**

default `0`

How many spaces between each loading character.

**timeout**

default `100`

The timeout to update the spinner.

**prepend**

default `false`

Show loading text at the beginning of the spinner.

## Related

- [io-spin](https://github.com/egoist/io-spin): Cli spinner made simple.

## License

hinata

Explore Similar Repositories

Was this content helpful?

Recent Feedback

Download README