# manawave

> It's not a marquee, it's more than that!

Latest version **0.12.0** (published 2023-09-26) · MIT license · 0 weekly downloads

## Install

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

## Health

**Score 40/100 (D)** — status: abandoned.

Positive: has types; esm support; no vulnerabilities; high quality score.

Warnings: low downloads; pre 1.0.

Negative: abandoned.

## Facts

| | |
|---|---|
| Version | 0.12.0 |
| Published | 2023-09-26 |
| First published | 2023-07-22 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | bundled |
| Module format | ESM + CommonJS |
| Dependencies | 0 |
| Unpacked size | 124 KB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| GitHub stars | 10 |
| Author | Long Nguyen |
| Maintainers | 18nguyenl |

## Links

- npm: https://www.npmjs.com/package/manawave
- Repository: https://github.com/ryuuart/manawave
- Homepage: https://manawave.long-nguyen.dev/
- Issues: https://github.com/ryuuart/manawave/issues
- npm.io page: https://npm.io/package/manawave

## Recent versions

- 0.12.0 (latest) — 2023-09-26
- 0.11.2 — 2023-09-07
- 0.11.1 — 2023-08-31
- 0.11.0 — 2023-08-27
- 0.10.1 — 2023-07-23
- 0.9.2 — 2023-07-22

## README

# MANAWAVE

This is the node package that contains the MANAWAVE library.

It uses [vite](https://vitejs.dev/) and [wdio](https://webdriver.io/) to develop, build, and test the library. Everything is written in Typescript.

## Getting Started

### Build

This will package and build MANAWAVE into `/dist`.

```sh
pnpm nx build manawave
```

### Development

This will launch the dev website and hot reload changes to the source code.

```sh
pnpm nx dev manawave
```

### Tests

This will test MANAWAVE across browsers.

```sh
pnpm nx test manawave
```

## Folder Structure

Generally, MANAWAVE tries to separate what's render and system logic. Render logic refers to anything that transforms system logic into visible DOM elements. System logic represent the "simulation" that moves all the stuff inside the marquee around. The "simulation" is done with numbers only. The "system" is the intersection of render and system logic.

The folder structure tries to accomodate for this process.

### `src/anim`

Contains code that control and manage the render loop used throughout the marquee.

> Might branch off into its own library

### `src/dom`

Code that work with anything relating to the DOM.

### `src/marquee`

Code that manage the marquee logic.

### `src/utils`

Contains utility functions.

### `/test`

[WDIO page objects](https://webdriver.io/docs/pageobjects/).

### `/example`

TODO: cleanup and organize

## Testing

Tests should all be in one file. This is to make sure wdio doesn't launch too many browsers in parallel.

## License

[MIT License](../LICENSE)

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