Giter VIP home page Giter VIP logo

twitch-channel-status's Introduction

Twitch Channel Status

A simple library for adding stream status images to your website.

Demo

An extremely minimilistic demo can be found at http://fugiman.com/Twitch-Channel-Status/

Usage

Add the following anywhere on your webpage to include the library:

<script src="https://code.jquery.com/jquery-1.11.1.min.js"></script>
<script src="https://cdn.rawgit.com/Fugiman/Twitch-Channel-Status/1d74252edf89110507cbf3088f9c3eaa38fac9d3/twitch-channel-status.min.js"></script>

Then create image tags on your webpage to display if a channel is online or offline:

<img data-twitch-channel="riotgames">

Configuration

When loading the library, you can add additional arguments to the script tag to customize it's behavior.

data-attribute :
Instead of using data-twitch-channel to identify which images to overwrite, it uses the value of this attribue.
data-interval :
By default the library will only fetch channel status on page load, but if this attribute is provided it'll refresh the status based on the number provided (in seconds).
data-online-image :
The image used if a channel is online. By default this is a green circle.
data-offline-image :
The image used if a channel is offline. By default this is a red circle.

Additionally, each individual image can also specify data-online-image and data-offline-image.

License

Twitch Channel Stuatus is (c) 2014 Christopher Gamble and is made available under the MIT license.

twitch-channel-status's People

Contributors

fugitech avatar twitchchrisgamble avatar

Watchers

 avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.