@angular-cool/loading-button
TypeScript icon, indicating that this package has built-in type declarations

15.0.0 • Public • Published

@angular-cool/loading-button NPM version Downloads Total Downloads

Cool button with loading indicator for angular

Install

npm install --save @angular-cool/loading-button

Setup

import { NgModule } from '@angular/core';
import { CoolLoadingButtonModule } from '@angular-cool/loading-button';

@NgModule({
    imports: [CoolLoadingButtonModule]
})
export class MyAppModule {}

Usage

async myAsyncFunction(parameters: any): Promise<any> {
  // Do something async
}
<cool-loading-button [clickHandler]="myAsyncFunction.bind(this)"
                     [clickParameters]="{ parametersPassToTheFunction: 'test' }">
  Click me
</cool-loading-button>

API

Inputs

  • [clickHandler]

    • Type: (parameters: any) => Promise | any
    • Async function to run when the button is clicked
    • Note: Don't forget the .bind(this) part when binding this parameter
  • [clickParameters]

    • Type: any
    • Parameter to be passed when invoking the clickHandler function
  • [color]

    • Type: ThemePalette
    • Color of the Material Button
  • [spinnerColor]

    • Type: ThemePalette
    • Color of the MatSpinner in the button
  • [disabled]

    • Type: boolean
    • Whether the button is disabled

Outputs

  • (loadingChanged)

    • Type: boolean
    • Called when the loading state has changed
  • (loadingFinished)

    • Type: void
    • Called when the loading has finished / stopped

License

The MIT License (MIT)

Copyright (c) 2020 Hacklone https://github.com/Hacklone

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.

Package Sidebar

Install

npm i @angular-cool/loading-button

Weekly Downloads

3

Version

15.0.0

License

MIT

Unpacked Size

46.3 kB

Total Files

15

Last publish

Collaborators

  • hacklone