ember-cli-async-button

Ember CLI Async Button

NOTE!

This package has been renamed to ember-async-button. Please install that version.

See a demo

About

When running async actions ensuring disabling of the button, re-enabling, and handling promise rejections is pretty boilerplate. This component packages up that behavior.

Install

npm install ember-cli-async-button --save-dev

Usage

In a template use the async-button helper

{{async-button action="save" default="Save" pending="Saving..."}}
{{! or if you have arguments to be passed to the action}}
{{async-button model "another argument" ... action="save" default="Save" pending="Saving..."}}

The component can also take a block:

{{#async-button action="save"}}
  Template content.
{{/async-button}}

In the controller for the template, you must create an action that matches the name given in the helper. If you passed the helper arguments, they will follow the callback argument.

Ember.Controller.extend({
  actions: {
    save: function(callback) {
      var promise = this.get('model').save();

      callback(promise);

      promise.then(function() {
        ...
      });
    }
    // If you passed async-button arguments
    save: function(callback, firstArg, secondArg, ...) {
      var promise = this.get('model').save();

      callback(promise);

      promise.then(function() {
        ...
      });
    }
  }
});

Make special note of callback(promise); In order for async-button to work correctly the promise in the action must be passed back to the callback function that is passed in.

Options

The async-button helper has other options to customize the states.

action

This is the action name used by the button.

default

The default text used for the button.

pending

Special text used while the promise is running. If not provided will use the default value.

resolved

Deprecated! Use fulfilled

Special text used if the promise is resolved. If not provided will use the default value.

fulfilled

Special text used if the promise is fulfilled. If not provided will use the default value.

rejected

Special text used if the promise is rejected. If not provided will use the default value.

disableWhen

Boolean value that will allow for disabling the button when in a state other than pending

reset

Flag telling the button to reset to the default state once resolved or rejected. A typical use case is to bind this attribute with ember-data isDirty flag.

Styling

A class of async-button is assigned to the button. An additional dynamic class is assigned during one of the four states:

• default
• pending
• fulfilled
• rejected

The href attribute of the a tag

You can adjust the button's tag by passing the tagName option:

{{async-button tagName="a" action="save" default="Save" pending="Saving..."}}

When you set tagName to a, the element will obtain an empty href attribute. This is necessary to enable the link behavior of the element, i. e. color, underlining and hover effect.

You can of course override href if you need it for some reason:

{{async-button tagName="a" href="custom" action="save" default="Save" pending="Saving..."}}

If you don't want a href attribute on your a button, set it to false:

{{async-button tagName="a" href=false action="save" default="Save" pending="Saving..."}}

Authors

• Brian Cardarella

We are very thankful for the many contributors

Versioning

This library follows Semantic Versioning

Want to help?

Please do! We are always looking to improve this addon. Please see our Contribution Guidelines on how to properly submit issues and pull requests.

Legal

DockYard, Inc © 2014

@dockyard

Licensed under the MIT license