Ember CLI Async Button

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..."}}

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.

Ember.Controller.extend({
  actions: {
    save: function(callback) {
      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.

`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

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 gem. Please see our Contribution Guidelines on how to properly submit issues and pull requests.

Legal

@dockyard

Licensed under the MIT license

pixelhandler / ember-cli-async-button Goto Github PK