Create a gist now

Instantly share code, notes, and snippets.

What would you like to do?
Aurelia Command (Promise) Binding

A Command custom attribute that handles click triggers that return a promise, disabling the element while the promise runs, and does basic progress reporting with Toastr.

Example usage:

<button command.call="submit()">Save</button>
import { autoinject, inject } from 'aurelia-framework'
import * as toastr from 'toastr'
const LogErrors = true
@inject(Element) // Element cannot be autoinjected
export class CommandCustomAttribute {
value: () => Promise<any>
private promise: Promise<any>
private commandName: string
constructor(private element: Element) {
this.commandName = this.element.getAttribute('title') || this.element.textContent || 'Command'
}
bind() {
this.element.addEventListener('click', this.doAction.bind(this))
}
unbind() {
this.element.removeEventListener('click', this.doAction.bind(this))
}
busyElement() {
this.element.setAttribute('disabled', 'disabled')
// TODO: Spinner?
}
unbusyElement() {
this.element.removeAttribute('disabled')
}
doAction() {
if (this.value && !this.promise) {
this.busyElement()
this.promise = this.value()
.then(() => {
this.promise = null
this.unbusyElement()
toastr.success(`${this.commandName} completed`)
})
.catch((err: any) => {
this.promise = null
this.unbusyElement()
toastr.error(`Error in ${this.commandName}`)
if (LogErrors) console.error(err)
})
}
}
}

The MIT License (MIT)

Copyright (c) 2016 Max Battcher

Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment