1.0.2 • Published 2 years ago

@promethewz/rematrix v1.0.2

Weekly downloads
-
License
MIT
Repository
github
Last release
2 years ago

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

NameTypee.g.
fpsnumberfps={45}
fontSizenumberfontSize={26}
colorstringcolor={"lightblue"}
bgColorstringbgColor={"rgba(255,255,255,0.65)"}
charactersstringcharacters={"anyRandomCharacterString"}
widthnumberwidth={500}
heightnumberheight={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