A library to show numbers on an LED display.
$ npm install studioled --save
// to import a specific method
import {StudioLed} from "studioled";
const led = new StudioLed({
element: document.querySelector(".led"),
});
// using method
led.setValue(42);
const StudioLed = require("studioled");
const led = new StudioLed({
element: document.querySelector(".led"),
});
<!-- to import non-minified version -->
<script src="studioled.umd.js"></script>
<!-- to import minified version -->
<script src="studioled.umd.min.js"></script>
After that the library will be available to the Global as StudioLed
. Follow an
example:
const led = new StudioLed({
element: document.querySelector(".led"),
});
led.setValue(42);
You can also pass other settings to the class's constructor.
const led = new StudioLed({
element: document.querySelector(".led"),
width: 75,
height: 135,
initialValue: 42,
baseDigits: 3,
});
Argument | Type | Default | Description |
---|---|---|---|
element |
object | element where the LED display will be rendered | |
width |
number | 85 | width of the digit |
height |
number | 135 | height of the digit |
initialValue |
number | 0 | initial value to be displayed |
baseDigits |
number | 0 | how many digits the LED display have to show always. If the number to be displayed is less than baseDigits, the LED display will show zeros in the other segments. eg: If baseDigits value is '3' and the number to be displayed is '42', the LED display will show '042' |
Follow the methods that the library provides.
sets the value to be displayed on the LED display.
Arguments
Argument | Type | Description |
---|---|---|
value |
number | 'Any integer number' |
Example
led.setValue(42);
returns the value displayed on the LED display.
Example
led.getValue();
sets the status of the LED display.
Arguments
Argument | Type | Options | Description |
---|---|---|---|
status |
string | default | success | error | change the LED display color to black ('default'), green ('success') or red ('error') |
Example
led.setStatus("success");
sets the digit size at specific breakpoints.
Arguments
Argument | Type | Description |
---|---|---|
value |
number | min-width of the viewport for breakpoint |
width |
number | width of the digit in the specified breakpoint |
height |
number | height of the digit in the specified breakpoint |
Example
led.addBreakpoint(600, 200, 200);
renders the LED display.
Example
led.render();
Please read CONTRIBUTING.md for details on our code of conduct, and the process for submitting pull requests to us.
We use SemVer for versioning. For the versions available, see the tags on this repository.
Phillipe Martins |
See also the list of contributors who participated in this project.
This project is licensed under the MIT License - see the LICENSE.md file for details