# react-star-sky

> A simple, modifiable p5js based background element displaying a randomized and animated star sky.

Latest version **1.0.3** (published 2022-10-04) · MIT license · 0 weekly downloads

## Install

```sh
npm install react-star-sky
pnpm add react-star-sky
yarn add react-star-sky
bun add react-star-sky
```

## Health

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

Positive: esm support; no vulnerabilities.

Warnings: low downloads; no types.

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 1.0.3 |
| Published | 2022-10-04 |
| First published | 2021-06-21 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | none |
| Module format | ESM + CommonJS |
| Node | >=10 |
| Dependencies | 4 |
| Unpacked size | 230.2 KB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| GitHub stars | 3 |
| Author | ZJVieth |
| Maintainers | zjvieth |
| Keywords | react, background, stars, sky |

## Links

- npm: https://www.npmjs.com/package/react-star-sky
- Repository: https://github.com/ZJVieth/react-star-sky
- Homepage: https://github.com/ZJVieth/react-star-sky#readme
- Issues: https://github.com/ZJVieth/react-star-sky/issues
- npm.io page: https://npm.io/package/react-star-sky

## Dependencies (4)

- [p5](https://npm.io/package/p5.md) ^1.3.1
- [postcss-normalize](https://npm.io/package/postcss-normalize.md) ^10.0.1
- [postcss-preset-env](https://npm.io/package/postcss-preset-env.md) ^7.8.2
- [postcss-flexbugs-fixes](https://npm.io/package/postcss-flexbugs-fixes.md) ^5.0.2

## Alternatives

- [mobx-react](https://npm.io/package/mobx-react.md) — 2.8M weekly downloads
- [rc-tree](https://npm.io/package/rc-tree.md) — 2.6M weekly downloads
- [@react-oauth/google](https://npm.io/package/@react-oauth/google.md) — 1.3M weekly downloads
- [@wagmi/connectors](https://npm.io/package/@wagmi/connectors.md) — 877.0K weekly downloads
- [vee-validate](https://npm.io/package/vee-validate.md) — 836.4K weekly downloads

## Recent versions

- 1.0.3 (latest) — 2022-10-04
- 1.0.2 — 2022-09-19
- 1.0.1 — 2022-09-19
- 1.0.0 — 2021-06-21

## README

# react-star-sky

> A simple, modifiable p5js based background element displaying a randomized and animated star sky.

[![NPM](https://img.shields.io/npm/v/react-star-sky.svg)](https://www.npmjs.com/package/react-star-sky) [![JavaScript Style Guide](https://img.shields.io/badge/code_style-standard-brightgreen.svg)](https://standardjs.com)

## Install

```bash
npm install --save react-star-sky
```

## Usage

```jsx
import React, { Component } from "react";

import StarSky from "react-star-sky";
import "react-star-sky/dist/index.css";

class Example extends Component {
  render() {
    return <StarSky />;
  }
}
```

## Optional Properties

```jsx
<StarSky
  debugFps={true} // Default = false
  frameRate={30} // Default = 60
  style={{ opacity: 0.5 }} // applied to the div wrapper
  className={""} // applied to the div wrapper
  starColor={"rainbow"} // Default = 'white', options: 'rainbow', 'white/red/green/etc'[w3color], [r, g, b]
  skyColor={[20, 20, 100]} // Default = 'black', options: 'white/red/green/etc'[w3color], [r, g, b]
/>
```

## Potential Future Features

- Nebulas
- Planets
- Falling Stars
- Galaxies
- Star Constellations
- Star Shuffling Mechanic (position change over time)

## License

MIT © [ZJVieth](https://github.com/ZJVieth)

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