npm package discovery and stats viewer.

Discover Tips

  • General search

    [free text search, go nuts!]

  • Package details

    pkg:[package-name]

  • User packages

    @[username]

Sponsor

Optimize Toolset

I’ve always been into building performant and accessible sites, but lately I’ve been taking it extremely seriously. So much so that I’ve been building a tool to help me optimize and monitor the sites that I build to make sure that I’m making an attempt to offer the best experience to those who visit them. If you’re into performant, accessible and SEO friendly sites, you might like it too! You can check it out at Optimize Toolset.

About

Hi, 👋, I’m Ryan Hefner  and I built this site for me, and you! The goal of this site was to provide an easy way for me to check the stats on my npm packages, both for prioritizing issues and updates, and to give me a little kick in the pants to keep up on stuff.

As I was building it, I realized that I was actually using the tool to build the tool, and figured I might as well put this out there and hopefully others will find it to be a fast and useful way to search and browse npm packages as I have.

If you’re interested in other things I’m working on, follow me on Twitter or check out the open source projects I’ve been publishing on GitHub.

I am also working on a Twitter bot for this site to tweet the most popular, newest, random packages from npm. Please follow that account now and it will start sending out packages soon–ish.

Open Software & Tools

This site wouldn’t be possible without the immense generosity and tireless efforts from the people who make contributions to the world and share their work via open source initiatives. Thank you 🙏

© 2024 – Pkg Stats / Ryan Hefner

ng2-stateful-button

v0.0.9

Published

An implementation of stateful buttons for angular2+ including loading, progress,success and failure state.

Downloads

12

Readme

Angular2 Stateful Button

Codeship Status for interfacewerk/ng2-stateful-button

Demo

An implementation of stateful buttons for angular2+ including loading, progress,success and failure state.

Installation

yarn add ng2-stateful-button 

or

npm install ng2-stateful-button --save

Setup

// app.module.ts
import {NgModule} from '@angular/core';
import {BrowserModule} from '@angular/platform-browser';
import {StatefulButtonModule} from 'ng2-stateful-button'; // <-- import the module
import {MyComponent} from './my.component';

@NgModule({
    imports: [BrowserModule, StatefulButtonModule], // <-- include it in your app module
    declarations: [MyComponent],
    bootstrap: [MyComponent]
})
export class MyAppModule {}

Usage

Behaviour

ng2-stateful-button provides one component stateful-button that you can use to wrap a button:

<stateful-button [buttonState]="myButtonState">
  <button (click)="do()">
    <sb-label-idle>Save</sb-label-idle>
    <sb-label-doing>Saving</sb-label-doing>
    <sb-label-success>Saved</sb-label-success>
    <sb-label-failure>Save failed!</sb-label-failure>
  </button>
</stateful-button>

The stateful-button component takes one input buttonState, which is the state of your button.

You can still set the attributes (disabled, click, type etc.) you want, just like you would do with a normal button. We use the standard ng-content to project the content and provide basic functionnality of state handling and a nice state declaration.

There are four states which are defined in an enum ButtonState. Your component controls the state of the button.

import { ButtonState } from 'ng2-stateful-button';

@Component(…)
export class MyComponent {
  …
  myButtonState: ButtonState = ButtonState.IDLE;
  …

  do() {
    this.myButtonState = ButtonState.DOING;
    // http requests, timeout, etc.
    this.myButtonState = ButtonState.SUCCESS;
  }
}

Use the sb-label-idle/doing/failure/success components to define what will be shown for each state of the button. That's it!

IMPORTANT: put the sb-label-XY into the <button>.

Style

ng2-stateful-button comes with inline component styles. They are completely customizable. Each state (IDLE, DOING, SUCCESS, FAILURE) is represented as a CSS class on the stateful-button element. No magic here. You can customize the sb-label-XY as well. For your information, the generated HTML looks like:

<stateful-button class="stateful-button stateful-button--doing">
  <button>
    <sb-label-idle>Save</sb-label-idle>
    <sb-label-doing>Saving</sb-label-doing>
    <sb-label-success>Saved</sb-label-success>
    <sb-label-failure>Save failed!</sb-label-failure>
  </button>
</stateful-button>

As an exemple, you could do the following (in SASS/LESS):

stateful-button {
  &.stateful-button--doing button {
    background-color: grey;
    color: white;
    box-shadow: none;
    cursor: wait;
  }

  &.stateful-button--success button {
    background-color: #2ECC40;
    color: white;
    box-shadow: none;
    cursor: default;
  }

  &.stateful-button--failure button {
    background-color: #FF4136;
    color: white;
    box-shadow: none;
    cursor: default;
  }
}

The default CSS properties of sb-label-XY are:

height: 30px;
line-height: 30px;
margin-top: -30px;
text-align: center;
display: block;

and the sb-label-idle has a special:

margin-top: 0;

This CSS magic makes sure that the button takes the maximum width of all the states! sb-label-XYs are hidden with opacity: 0.

Develop

Link your development folder of ng2-stateful-button:

yarn link

and then go to a project you want to use the stateful buttons in and do

yarn link "ng2-stateful-button"

to use it there.

License

MIT