v2-timer-component

1.0.1 • Public • Published

v2-timer-component

This is a simple countdown timer – a browser-native web component designed for seamless integration with any framework or standalone use. Whether you're enhancing a Kanban board with a thirty-minute task timer or adding a customizable countdown to your project, this component can help. Easily control the timer through buttons or events, adjust its duration, and personalize its appearance using CSS variables.

Timer

Installation

npm install v2-timer-component

Usage

<v2-timer-component></v2-timer-component>

Example

<!DOCTYPE html>
<html lang="en">
<head>
    <meta charset="UTF-8">
    <title>V2 Timer Component Example</title>

    <style>
        html, body {
            height: 100%;
        }
        .example {
            --color: white;
            --background-color: red;
            --button-color: white;
            --button-background-color: red;
            --width: 30vw;
            --height: 30vh;
            --border: none;
        }
        v2-timer-component {
            margin: 2rem;
        }
        button {
            margin: 2em;
            font-size: larger;
        }
    </style>
</head>
<body>
<v2-timer-component></v2-timer-component>
<v2-timer-component class="example" duration="15"></v2-timer-component>
<v2-timer-component small></v2-timer-component>
<v2-timer-component xsmall></v2-timer-component>

<button onclick="startAllTimers()">Start all timers</button>
<button onclick="stopAllTimers()">Stop all timers</button>

<script type="module">
    import "v2-timer-component"
</script>
<script>
    function startAllTimers() {
        document.dispatchEvent(new Event("v2-timer-start"));
    }
    function stopAllTimers() {
        document.dispatchEvent(new Event("v2-timer-stop"));
    }
</script>
</body>
</html>

Class

V2TimerComponent

CSS Variables

--color: black;
--background-color: white;
--button-color: black;
--button-background-color: white;
--width: 300px;
--height: 180px;
--border: 2px solid #000;

Properties

duration = 30;
small = false;
xsmall = false;

Methods

startTimer()
stopTimer()
pauseTimer()
resumeTimer()

Dispatches

The component dispatches events to publicize component state changes.

v2-timer-started
v2-timer-stopped
v2-timer-paused
v2-timer-resumed
v2-timer-completed

Listeners

The component registers listeners with the document in order to be controlled by external events.

document.addEventListener('v2-timer-start', this.startTimer);
document.addEventListener('v2-timer-stop', this.stopTimer);
document.addEventListener('v2-timer-pause', this.pauseTimer);
document.addEventListener('v2-timer-resume', this.resumeTimer);

License

This project is licensed under the MIT License.

Package Sidebar

Install

npm i v2-timer-component

Weekly Downloads

1

Version

1.0.1

License

MIT

Unpacked Size

56.4 kB

Total Files

5

Last publish

Collaborators

  • version2software