❤
npm
Sign UpSign In

minitron.js

1.0.0 • Public • Published

Minitron.js

A dot-matrix display-like javascript plugin.

demo

Table of Contents

Installation

Clone the repository
git clone https://github.com/achillesrasquinha/Minitron.git
Install using npm
npm install minitron.js
Install using bower
bower install minitron.js

In your HTML file

<!DOCTYPE html>
<html>
  <head>
    ...
  </head>
  <body>
    ...
    <script src="/path/to/minitron.js"></script> 
  </body>
</html>

Usage

A template declaration would be as follows

Minitron.make("<your_message>", { /*<your_options>*/ });

Methods

Return Method Description
Minitron setMessage(message) Initializes/Updates the message to-be displayed.
Minitron setOptions(option) Pass your options to settings to change them any time.

Options

Minitron.make("<your_message_string>", {
    color: '#00FFFF' /*default*/ | "<your_hex_string>",
    speed: 50        /*default*/ | /*<your_speed> higher the speed value, slower to render*/
});

License

Code released under the MIT License.

Readme

Keywords

Package Sidebar

Install

npm i minitron.js

Repository

github.com/achillesrasquinha/Minitron.js

Homepage

achillesrasquinha.github.io/Minitron.js

Weekly Downloads

2

Version

1.0.0

License

MIT

Last publish

Collaborators

  • achillesrasquinha
Try on RunKit
Report malware