# rainbow-text-gradient

> A JavaScript function to color a string with a rainbow gradient and add it to the body of the HTML document.

Latest version **1.0.1** (published 2023-07-03) · MIT license · 0 weekly downloads

## Install

```sh
npm install rainbow-text-gradient
pnpm add rainbow-text-gradient
yarn add rainbow-text-gradient
bun add rainbow-text-gradient
```

## 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.1 |
| Published | 2023-07-03 |
| First published | 2023-07-03 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | none |
| Module format | CommonJS |
| Dependencies | 0 |
| Unpacked size | 2.1 KB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| GitHub stars | 0 |
| Author | Walter Williams |
| Maintainers | lolerwaffles |
| Keywords | rainbow, text, gradient, color |

## Links

- npm: https://www.npmjs.com/package/rainbow-text-gradient
- Repository: https://github.com/lolerwaffles/rainbowtext
- Homepage: https://github.com/lolerwaffles/rainbowtext#readme
- Issues: https://github.com/lolerwaffles/rainbowtext/issues
- npm.io page: https://npm.io/package/rainbow-text-gradient

## Alternatives

- [postcss-color-hex-alpha](https://npm.io/package/postcss-color-hex-alpha.md) — 6.4M weekly downloads
- [randomcolor](https://npm.io/package/randomcolor.md) — 348.0K weekly downloads
- [bows](https://npm.io/package/bows.md) — 1.3K weekly downloads
- [ep_prefer_color_scheme](https://npm.io/package/ep_prefer_color_scheme.md) — 260 weekly downloads
- [coc-yank](https://npm.io/package/coc-yank.md) — 61 weekly downloads

## Recent versions

- 1.0.1 (latest) — 2023-07-03
- 1.0.0 — 2023-07-03

## README

# rainbowText 

A JavaScript function to color a string with a rainbow gradient and add it to the body of the HTML document. 

## Installation

```bash
npm install rainbow-text-gradient
```
## Usage

rainbowText(text, saturation, lightness, repetitionsPerString);

### Parameters
* text (required): The string you want to color with the rainbow gradient.
* saturation (optional, default = 100): The saturation of the colors in the rainbow gradient. It's a percentage, and 100% is the full color.
* lightness (optional, default = 50): The lightness of the colors in the rainbow gradient. It's a percentage; 0% is black, 100% is white.
* repetitionsPerString (optional, default = 1): The number of times the gradient should restart across the string.

### Example

rainbowText("Hello, world!", 100, 50, 2);

This will add the text "Hello, world!" to the body of your HTML document. The text will be colored with a rainbow gradient that repeats twice across the string.

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