• Stars
    star
    173
  • Rank 220,124 (Top 5 %)
  • Language
    JavaScript
  • License
    MIT License
  • Created over 10 years ago
  • Updated about 6 years ago

Reviews

There are no reviews yet. Be the first to send feedback to the community and the maintainers!

Repository Details

Async Button Component for Ember CLI apps

DEPRECATED

This project has been deprecated.

This addon is no longer actively developed. But we'll still keep it here.

Why is it being deprecated?

After three years of use, it has become apparent that this is better used as a pattern and not extracted to its own addon. The JS community has evolved and writing logic based on promises is common practice.

How can I do this myself?

You can view this twiddle for an example of how you can easily control button state based on the state of a promise. The button is disabled while saving, indicating when it is pending and tells you when it was successful or fails. All this is done without an addon. Simply save your promise to a property on your controller or component, then you can update your button:

<button type="submit" disabled={{cannotSubmit}}>
  {{#if activePromise.isPending}}
    Saving...
  {{else if activePromise.isFulfilled}}
    Saved!
  {{else if activePromise.isRejected}}
    Submission failed
  {{else}}
    Submit
  {{/if}}
</button>

Where activePromise is the promise you set and cannotSubmit is a boolean you can create to disable the button.

Ember Async Button

See a demo

Build Status npm version Ember Observer Score

ember-async-button is built and maintained by DockYard, contact us for expert Ember.js consulting.

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

ember install ember-async-button

Usage

In a template use the async-button helper

{{async-button action=(action "save" model) default="Save" pending="Saving..."}}

With a block

The component can also take a block:

{{#async-button action=(action "save") as |component state|}}
  {{#if state.isDefault}}
    Click here to save
  {{/if}}
  {{#if state.isPending}}
    Please wait...
  {{/if}}
  {{#if state.isFulfilled}}
    Everything went well, congrats!
  {{/if}}
  {{#if state.isRejected}}
    Ooops, something went wrong.
  {{/if}}
{{/async-button}}

The closure action passed should return a promise:

import Ember from 'ember';

const { Component } = Ember;

export default Component.extend({
  actions: {
    save(model) {
      return model.save();
    }
  }
});

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

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

More Repositories

1

ember-composable-helpers

Composable helpers for declarative templating in Ember
JavaScript
636
star
2

elixir-mail

Build composable mail messages
Elixir
386
star
3

ember-route-action-helper

Bubble closure actions in routes
JavaScript
330
star
4

ember-in-viewport

Detect if an Ember View or Component is in the viewport @ 60FPS
JavaScript
246
star
5

ember-admin

Admin backend for ember-cli projects
JavaScript
241
star
6

ember-service-worker

A pluggable approach to Service Workers for Ember.js
JavaScript
238
star
7

flame_on

Flame Graph LiveView Component and LiveDashboard plugin
Elixir
228
star
8

ember-router-scroll

🗔 Scroll to top with preserved browser history scroll position.
JavaScript
204
star
9

inquisitor

Composable query builder for Ecto
Elixir
170
star
10

ecto_fixtures

Fixtures for Elixir apps
Elixir
168
star
11

openid_connect

Elixir
66
star
12

eslint-plugin-ember-suave

DockYard's ESLint plugin for Ember apps
JavaScript
53
star
13

courier

Elixir
53
star
14

ember-cart

Shopping cart primitives for Ember
JavaScript
53
star
15

valid_field

Elixir
48
star
16

rein

Reinforcement Learning tooling built with Nx
Elixir
42
star
17

json_api_assert

Composable assertions for JSON API payload
Elixir
38
star
18

live_view_demo

Forkable repo for entries in Phoenix Phrenzy (https://phoenixphrenzy.com/)
Elixir
35
star
19

ember-service-worker-asset-cache

JavaScript
28
star
20

svelte-inline-compile

JavaScript
27
star
21

ember-cli-custom-assertions

Add custom QUnit assertions to your ember-cli test suite
JavaScript
26
star
22

ember-app-shell

JavaScript
24
star
23

easing

Elixir
22
star
24

design-sprints

HTML
22
star
25

ember-i18n-to-intl-migrator

Migrate ember-i18n to ember-intl
JavaScript
21
star
26

ember-service-worker-index

An Ember Service Worker plugin that caches the index.html file
JavaScript
20
star
27

ember-cli-deploy-compress

Compress your assets automatically choosing the best compression available for your browser targets
JavaScript
18
star
28

laptop-install

Shell
17
star
29

narwin-pack

Package of PostCSS plugins DockYard utilizes for PostCSS based projects!
JavaScript
16
star
30

ember-maybe-in-element

Conditionally render content elsewhere using #-in-element on ember apps
JavaScript
15
star
31

ember-service-worker-cache-fallback

JavaScript
15
star
32

inquisitor_jsonapi

JSON API Matchers for Inquisitor
Elixir
14
star
33

ember-one-way-select

JavaScript
10
star
34

svelte-inline-component

Utility and vite plugin to allow to create your own inline svelte components in tests
JavaScript
9
star
35

live_view_events

A simple library to unify sending and receiving messages in LiveView components
JavaScript
8
star
36

disklavier

Elixir
8
star
37

canon

All the must-read articles and must-watch videos for the DockYard engineering team.
8
star
38

plausible_proxy

An Elixir Plug to proxy calls to Plausible through your server
Elixir
7
star
39

netcdf

Elixir NetCDF Bindings
Rust
7
star
40

ember-service-worker-cache-first

JavaScript
7
star
41

qunit-notifications

Web Notifications support for QUnit in-browser test suites
JavaScript
6
star
42

auth_test_support

Authentication and authorization test functions
Elixir
4
star
43

broccoli-json-concat

JavaScript
3
star
44

boat-tracker

Elixir
3
star
45

ember-load-css

Ember CLI wrapper for loadCSS
JavaScript
3
star
46

drive-in-privacy-policy

2
star
47

boston_elixir

LiveView Native Workshop for Boston Elixir
Elixir
2
star
48

ketch

Simple proof-of-concept web application built with Next.js, Storybook, and Firebase.
JavaScript
1
star
49

courier_web

JavaScript
1
star
50

stylelint-config-narwin

DockYard stylelint configuration
JavaScript
1
star
51

liveview_tailwind_demo

Demo showing TailWind 3 integration in a Phoenix LiveView project
Elixir
1
star
52

ember-qunit-notifications

tomster-ified qunit-notifications
1
star
53

formation

Example of Phoenix LiveView Form logic
Elixir
1
star