/promethewz-rematrix

A lightweight matrix animation component

Primary LanguageTypeScriptMIT LicenseMIT

Re-Matrix

matrix

A lightweight matrix animation component

NPM version NPM downloads Issues Forks Stars License: MIT

🎉 Features

  • Zero Dependency on other any plugins
  • Supports all React-based Project
  • Lightweight (1.5Kb)

📦 Installation

npm install @promethewz/rematrix
yarn add @promethewz/rematrix

🔨 Usage

import ReMatrix from "@promethewz/rematrix";
const App = () => (
  <>
    <ReMatrix color={"indigo"} />
  </>
);

Props

Name Type e.g.
fps number fps={45}
fontSize number fontSize={26}
color string color={"lightblue"}
bgColor string bgColor={"rgba(255,255,255,0.65)"}
characters string characters={"anyRandomCharacterString"}
width number width={500}
height number height={600}

... and any canvas element props :)

TypeScript

@promethewz/rematrix is written in TypeScript with complete definitions :)

⌨️ Development

Clone locally:

$ git clone git@github.com:IshmamR/promethewz-rematrix.git
$ cd promethewz-rematrix

If you are using npm

$ npm install
$ npm start

Else if you are using yarn

$ yarn
$ yarn start

🤝 Contributing PRs Welcome

All contributions are welcomed. You can submit any ideas as pull requests or as GitHub issues.

Let's fund issues in this repository