Code Monkey home page Code Monkey logo

angular-promise-buttons's Introduction

Stories in Ready Stories in progress Build Status Coverage Status

angular-promise-buttons

Chilled Buttons for AngularJS

There are cool loading buttons out there for angular. Only thing which annoys me, is that you (most of the times) have to manually trigger their loading state via a boolean which leads to a bit of repetition, declaring those again and again. angular-promise-buttons exists to take away some of that, by handling the loading state directly by passing the promise. Saves you at least two lines of code every time. Check out the DEMO!

Also you can play with the code on Plnkr.

Bug-reports or feature request as well as any other kind of feedback is highly welcome!

getting started

Install it via bower

bower install angular-promise-buttons -S

and add angularPromiseButtons as dependency in your main module:

angular.module('yourApp',[
  'angularPromiseButtons'
]);

Using the buttons is easy. Just return the promise in question in your service caller and you're good to go: You can also directly return the promise via the function passed to ng-click:

<button ng-click="yourServiceCaller()"
        promise-btn>Click me to spin!</button>
// inside some controller
$scope.yourServiceCaller = function ()
{
  return fakeFactory.method().then(...);
};

using it for forms

For using the promise buttons with ng-submit you need to apply them to the form directive and add `type="submit" to the buttons you want to show a loader for:

<form ng-submit="yourServiceCaller()"
      promise-btn>
  <button type="submit">MyBtn</button>
</form>
// inside some controller
$scope.yourServiceCaller = function ()
{
  return fakeFactory.method().then(...);
};

alternative syntax

There is also an alternative syntax, which allows you to share promises between buttons (and possibly other directives):

<button ng-click="yourServiceCaller()"
        promise-btn="yourPromise">MyBtn</button>

Now you just have to assign a promise to yourPromise:

// inside some controller
$scope.yourServiceCaller = function ()
{
  $scope.yourPromise = fakeFactory.method().then(...);
};

styling the button

The base-styles might not be overwhelmingly sexy, but it is easy to fix that! There are lots of free css-spinners out there. Just find one of your liking and add the css.

Ressources:

configuration

There are also some defaults for you to set, if you like. You can do this by using the angularPromiseButtonsProvider:

angular.module('exampleApp', [
  'angularPromiseButtons'
])
.config(function (angularPromiseButtonsProvider)
{
  angularPromiseButtonsProvider.extendConfig({
    spinnerTpl: '<span class="btn-spinner"></span>',
    disableBtn: true,
    btnLoadingClass: 'is-loading',
    addClassToCurrentBtnOnly: false,
    disableCurrentBtnOnly: false,
    minDuration: false,
    CLICK_EVENT: 'click',
    CLICK_ATTR: 'ngClick',
    SUBMIT_EVENT: 'submit',
    SUBMIT_ATTR: 'ngSubmit'
  });
});

change options via promise-btn-options

You can also change all the options (but not the spinner template) by specifying the options via promise-btn-options:

<button class="btn"
        ng-click="yourServiceCaller()"
        promise-btn-options="options"
        promise-btn="yourPromise">MyBtn <span>Look I'm nested content</span>
</button>

Now you just have to assign a promise to yourPromise:

// inside some controller
$scope.options = {
  disableBtn: false,
  btnLoadingClass: 'is-spinning'
};
$scope.yourServiceCaller = function ()
{
  $scope.yourPromise = fakeFactory.method().then(...);
};

Thats all the logic there is (for now). Adjusting the look and feel of the spinner can be done using your own styles.

❤ contribute ❤

I'm happy for any issue or feature request, you might encounter or want to have. Even a one liner is better, than no feedback at all. Pull requests are also highly welcome. Just fork the repository, clone it and run grunt serve for development. Another important factor is the number of developers using and thus testing angular-promise-buttons. Tell your fellow programmers, say that you use it on ng-modules, tweet or even blog about it.

angular-promise-buttons is published under the The GNU Lesser General Public License V2.1.

(possible) promising future features

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    🖖 Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. 📊📈🎉

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google ❤️ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.