Skip to content

Zero-dependency, customizable, and omnidirectional marquee library for vanilla javascript

License

Notifications You must be signed in to change notification settings

ryuuart/MANAWAVE

Repository files navigation

MANAWAVE

MANAWAVE Forum Signature

MANAWAVE is a zero-dependency, customizable, and omnidirectional marquee library for vanilla javascript.

Artistically, it's the website manawave.art that uses the MANAWAVE library. The website contains a lot of artistic and visual experimentation by ryuuart.

Getting Started

Edit MANAWAVE STARTER

Documentation

You can take a deep dive into using MANAWAVE on the documentation site.

Installation

You can install in two ways: using a CDN script or using npm.

CDN

Include this in the <head> portion of your HTML.

<script
  defer
  src="https://cdn.jsdelivr.net/npm/[email protected]/dist/manawave.min.js"
></script>

npm

You can use pnpm, yarn, or the others instead of npm if you want.

npm install manawave

Basic Example

<manawave-marquee speed="1.5" direction="35.5" autoplay>
  Content&nbsp;
</manawave-marquee>

Developing

This repo is an NX monorepo using pnpm workspaces with two packages:

You can find out more in those repos. There's also a Nix flake devshell if you want to use the included development configuration.

You can use it like this:

nix develop

Contributing

MANAWAVE started as a solo hobby project so there's definitely something that could be improved. Don't be afraid to create issues or PRs for the project. It's greatly appreciated!!

License

MIT License for everything!

About

Zero-dependency, customizable, and omnidirectional marquee library for vanilla javascript

Resources

License

Stars

Watchers

Forks

Packages

No packages published