# textticker

> A scrolling text ticker

Latest version **0.0.4** (published 2017-04-05) · MIT license · 0 weekly downloads

## Install

```sh
npm install textticker
pnpm add textticker
yarn add textticker
bun add textticker
```

## Health

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

Positive: no vulnerabilities.

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

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 0.0.4 |
| Published | 2017-04-05 |
| First published | 2015-02-13 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | none |
| Module format | CommonJS |
| Dependencies | 0 |
| Known vulnerabilities | 0 |
| Install scripts | no |
| GitHub stars | 4 |
| Author | Miguel Mota |
| Maintainers | miguelmota |
| Keywords | text, ticker, scroll |

## Links

- npm: https://www.npmjs.com/package/textticker
- Repository: https://github.com/miguelmota/textticker
- Issues: https://github.com/miguelmota/textticker/issues
- npm.io page: https://npm.io/package/textticker

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

- 0.0.4 (latest) — 2017-04-05
- 0.0.3 — 2017-04-05
- 0.0.2 — 2017-04-05
- 0.0.1 — 2015-02-13

## README

# TextTicker

> A scrolling text ticker

## Demo

<img src="https://raw.githubusercontent.com/miguelmota/textticker/master/screenshot.gif" />

[http://lab.moogs.io/textticker](http://lab.moogs.io/textticker)

## Install

```bash
npm install textticker
```

## Usage

```javascript
var sayings = [
  'yippy yo',
  'badabing',
  'blahblah'
];

var index = 0;

var ticker = new TextTicker(document.querySelector('.text'), {
  text: sayings[0], // defaults to element text
  duration: 50, // default: 50
  leadChar: '_', // default: _
  leadCharKeep: true, // keep or remove lead character after done ticking. default: true
  leadCharBlink: 1000, // default: 1000
  leadCharBlink: 1000, // default: 1000
  leadCharMaxBlinks: Infinity, // default: Infinity
  startImediately: true, // default: true, if false then you must call ticker.start()
  onDone: function(text) {
    setTimeout(function() {
      var nextSaying = index <= 1 ? (index += 1, sayings[index]) : (index = 0, sayings[index]);
      ticker.setText(nextSaying);
      ticker.reload();
    }, 4000);
  }
});

ticker.destroy(); // stop ticking and set static text
```

## Resources

There is a terminal version available, [terminal-textticker](https://github.com/miguelmota/terminal-textticker).

# License

MIT

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