# react-typist-cycle

> A simple cycler for queuing react-typist elements

Latest version **0.1.2** (published 2017-03-30) · MIT license · 0 weekly downloads

## Install

```sh
npm install react-typist-cycle
pnpm add react-typist-cycle
yarn add react-typist-cycle
bun add react-typist-cycle
```

## 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.1.2 |
| Published | 2017-03-30 |
| First published | 2017-03-30 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | none |
| Module format | CommonJS |
| Dependencies | 1 |
| Known vulnerabilities | 0 |
| Install scripts | no |
| Author | Rorz |
| Maintainers | rorz |
| Keywords | react-typist, typist, repeat |

## Links

- npm: https://www.npmjs.com/package/react-typist-cycle
- npm.io page: https://npm.io/package/react-typist-cycle

## Dependencies (1)

- [react-typist](https://npm.io/package/react-typist.md) ^1.1.0

## Recent versions

- 0.1.2 (latest) — 2017-03-30
- 0.1.1 — 2017-03-30
- 0.1.0 — 2017-03-30

## README

# React Typist Cycle
A React Component for 'cycling' through [React-Typist](https://github.com/jstejada/react-typist) elements.

## Install
```shell
npm install react-typist-cycle
```
## Example Usage
![example of the element in use](https://raw.githubusercontent.com/rorz/react-typist-cycle/master/demo.gif)

```jsx
<TypistCycle
  content={[
    'First typist *line*', 
    'Second line', 
    'Third line :)'
  ]}
  numberOfCycles={-1} // loop indefinitely
  segmentDelay={0.8} // stop for 0.8s at end line
  className="my-class"
/>
```
## Options
### Inherited
React Typist Cycle inherits all of [React Typist's props](https://github.com/jstejada/react-typist/blob/master/README.md#options), with the exception of `onTypingDone` (this is reserved for cycling).

### New
React Typist Cycle comes with the following props...

#### content (**REQUIRED**)

An array of string objects representing each Typist element to display.


#### numberOfCycles
*Default:* `1`


How many times to cycle through the values.
A **negative value** will cause the component to cycle through its content infinitely.
NOTE: At the end of the specified cycle amount, the component will load the first line again and remain there.


#### segmentDelay
*Default:* `0.44`

The delay at the end of each line, in seconds.

## Licence
MIT

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