/delay.js

A little library for slowing down your interface.

Primary LanguageHTML

#Delay.js A little library for slowing down your interface.

##What it Does Delay gives users some time to undo their actions before they take effect. It's useful for background tasks where the user won't see the result immediately anyway. For instance, you could stop showing a record immediately, but not delete it from the database until the user has had a few seconds to change their mind.

Here's a demo.

##Usage

  • Include the delay.js file (in the js folder)
  • Add the delay-button class to your button
  • Listen for the delay-confirmed event instead of the click event

##Customization ###Time Set the amount of time to wait before confirmation (in milliseconds) with the data-delay-time attribute. Defaults to 5000.

###Success Set the button's success text, which prompts a user for an undo, with the data-delay-success attribute. Defaults to "Undo".

###Default Set the button's default text, for when the user's action is over, with the data-delay-default attribute. Defaults to whatever it said when the page loaded.

##Hooks ###Delay-started event Fires when the user takes an action.

###Delay-confirmed event Fires when the action confirms, after a set interval.

###Delay-undone event Fires when the user undoes an action.