# 386-animation

> Page screen loading animation inspired from the DOS 386 terminal.

Latest version **1.0.6** (published 2021-05-16) · MIT license · 0 weekly downloads

## Install

```sh
npm install 386-animation
pnpm add 386-animation
yarn add 386-animation
bun add 386-animation
```

## 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.6 |
| Published | 2021-05-16 |
| First published | 2019-11-13 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | none |
| Module format | CommonJS |
| Dependencies | 0 |
| Unpacked size | 5.2 KB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| GitHub stars | 3 |
| Author | Wesley Moses, Chris McKenzie |
| Maintainers | wes337 |
| Keywords | 386, DOS, retro, terminal, vintage, animation, animate, screen load |

## Links

- npm: https://www.npmjs.com/package/386-animation
- Repository: https://github.com/wes337/386-animation
- Homepage: https://github.com/wes337/386-animation#readme
- Issues: https://github.com/wes337/386-animation/issues
- npm.io page: https://npm.io/package/386-animation

## Alternatives

- [@luma.gl/experimental](https://npm.io/package/@luma.gl/experimental.md) — 77.1K weekly downloads
- [persona-harness](https://npm.io/package/persona-harness.md) — 4.7K weekly downloads
- [@tsparticles/effect-bubble](https://npm.io/package/@tsparticles/effect-bubble.md) — 4.6K weekly downloads
- [f3d](https://npm.io/package/f3d.md) — 730 weekly downloads
- [spark-html-motion](https://npm.io/package/spark-html-motion.md) — 298 weekly downloads

## Recent versions

- 1.0.6 (latest) — 2021-05-16
- 1.0.5 — 2021-05-16
- 1.0.4 — 2021-05-16
- 1.0.3 — 2021-05-16
- 1.0.2 — 2019-11-13
- 1.0.1 — 2019-11-13
- 1.0.0 — 2019-11-13

## README

# DOS/386 Loading Animation

![Demo](https://i.imgur.com/u8EcsBt.gif "Demo")

Based off of [BOOTSTRA.386](https://github.com/kristopolous/BOOTSTRA.386), a Bootstrap theme by [Chris McKenzie](https://github.com/kristopolous). I thought that the screen loading animation was cool and wanted to make a seperate lightweight version.

## Getting Started

Install using your package manager.

```
yarn add 386-animation
npm install 386-animation
```

Import the package and styles into wherever your code creates HTML and run the `init386()` function.

```javascript
import init386 from "386-animation";
import "386-animation/386.css";
```

or

```javascript
var init386 = require("386-animation");
require("386-animation/386.css");
```

Then initialize it!

```javascript
// Inside your code
init386();
```

### Configuration

The function also takes an object of options as a parameter.

```javascript
// Default options
init386({
  onePass: false, // will skip the second pass of the cursor if true
  fastLoad: false, // will skip the animation.
  speedFactor: 1, // the speed of the loading animation.
  background: "#000084", // CSS value for the body background before loading animation has completed
  cursorColor: "#FAFAFA", // The colour of the terminal cursor/bar.
});
```

## Authors

- **Chris McKenzie** - _Initial work_ - [kristopolous](https://github.com/kristopolous)

- **Wesley Moses** [wes337](https://github.com/wes337)

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