Skip to content

A custom implementation of a generic progress bar widget for use on the StreamElements live streaming platform.

License

Notifications You must be signed in to change notification settings

JasonDiBabbo/SE-CountdownBarWidget

Repository files navigation

Countdown Bar Widget

This is a custom implementation of a countdown bar widget for use on the StreamElements platform. Streamers can use this widget to display countdown information to their viewers.

If you're new to the StreamElements platform and/or have any questions about custom widgets, check out this blog post.

Using the widget with StreamElements

To use the widget on your StreamElements overlay, copy the content of the widget.html|css|js|json files in the dist folder to a custom widget defined in your overlay.

Building the widget

This widget is built using TypeScript instead of vanilla JavaScript. Because the StreamElements custom widget interface requires the JavaScript to be submitted in a single file, the transpiled code will need to be bundled. This is achieved using Rollup.js.

If you want to fork the project or clone it and make any changes, building is really simple. Make sure you have the latest version of Node.js installed and install all of the development packages. The table below describes the different NPM scripts you can use. The NPM scripts execute gulp tasks that can be viewed in the gulpfile.js file.

Name Description
build Transpiles TypeScript code and bundles the widget into widget.html|css|js|json files in the dist folder.
build:watch Runs the build script in watch mode. This will rerun the transpile/bundle process whenever changes are detected.
lint Lints the project to report on best practice patterns in TypeScript code.

Contact

If you have questions about this widget or anything about streaming, feel free to drop by my stream or send me a DM on Twitter.

About

A custom implementation of a generic progress bar widget for use on the StreamElements live streaming platform.

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published