Git Product home page Git Product logo

shindig's Introduction

Shindig.js

A simple javscript eventing library.

Methods

Shindig.get(key)

Get a property.

  • key (String) - Name of property

Example

var name = Shindig.get('name');

Shindig.set(key, value, silent)

Set a property and fire corresponding mutation event.

  • key (String) - Name of property
  • value (mixed) - Value of property
  • silent (Boolean) - Bypass the mutation event

Example

Shindig.on('create:name', function (value) {
	console.log(value); // Tony Starks
});

Shindig.on('change:name', function (values) {
	console.log(value.old) // Tony Starks
	console.log(value.new) // Iron Man
});

Shindig.set('name', 'Tony Starks');
Shindig.set('name', 'Iron Man');

Shindig.unset(key, silent)

Set a property and fire corresponding mutation event.

  • key (String) - Name of property
  • silent (Boolean) - Bypass the mutation event

Example

Shindig.on('delete:name', function (value) {
	console.log(value); // Tony Starks
});

Shindig.unset('name', true); // Will not fire event

Shindig.fire(evt, data)

Fire an event

  • evt (String) - Name of event
  • data (mixed) - Data to pass to listener

Example

Shindig.fire('welcome', {
	first: 'Tony',
	last: 'Stark'
});

Shindig.on(evt, callback, context)

Listen for an event.

  • evt (String) - Name of event
  • callback (Function) - Function to fire when event is called.
  • context (mixed) - Context that should be used when calling callback

Example

Shindig.on('welcome', function (name) {
	console.log('Welcome ' + name.first); // Welcome Tony
});

Shindig.off(evt)

Remove event listener

  • evt (String) - Name of event

Example

Shindig.off('welcome');

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.