Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/moff/angular2-ladda

Angular 2 Ladda module
https://github.com/moff/angular2-ladda

Last synced: 9 days ago
JSON representation

Angular 2 Ladda module

Awesome Lists containing this project

README

        

# Angular Ladda module

[![npm version](https://img.shields.io/npm/v/angular2-ladda.svg)](https://www.npmjs.org/package/angular2-ladda)
[![npm downloads](https://img.shields.io/npm/dt/angular2-ladda.svg)](https://www.npmjs.org/package/angular2-ladda)
[![license](https://img.shields.io/github/license/mashape/apistatus.svg?maxAge=2592000)](http://opensource.org/licenses/MIT)

This is a module for Angular 2+ that implements [Ladda](https://github.com/hakimel/Ladda).

Check out Ladda's demo

## Installation

- Run `npm install ladda angular2-ladda`

- Add "node_modules/ladda/dist/ladda.min.css" or
"node_modules/ladda/dist/ladda-themeless.min.css" to the "styles"
array in your angular.json file. If you aren't using the Angular CLI,
link to the appropriate CSS file in your document instead. For example:

```html

```

- Import `LaddaModule` in your app's main module `app.module.ts`, e.g.:

```typescript
// other imports
// ...
import { LaddaModule } from 'angular2-ladda';
// ...

@NgModule({
imports: [
// other imports
// ...
LaddaModule,
// ...
]
});
```

Ladda defaults can be configured as follows:

```typescript
// other imports
// ...
import { LaddaModule } from 'angular2-ladda';
// ...

@NgModule({
imports: [
// other imports
// ...
LaddaModule.forRoot({
style: "contract",
spinnerSize: 40,
spinnerColor: "red",
spinnerLines: 12
}),
// ...
]
});
```

## Usage

Add `[ladda]="isLoading"` to a button tag in your template, e.g.:

```html
Save
```

In the component the value of `isLoading` can be changed to show/hide Ladda's spinner:

```typescript
import { Component } from '@angular/core';

@Component({
template: `

Home Component


Toggle Ladda in button below


Save
`
})
export class HomeComponent {
// trigger-variable for Ladda
isLoading: boolean = false;

toggleLoading() {
this.isLoading = !this.isLoading;
}
}
```

Buttons accept the following attributes:

- data-style: one of the button styles, full list in [demo](http://lab.hakim.se/ladda/)
- data-spinner-size: pixel dimensions of spinner, defaults to dynamic size based on the button height
- data-spinner-color: hex code or any named CSS color
- data-spinner-lines: the number of lines for the spinner, defaults to 12

### Progress

Loading progress can be shown by setting the bound value to a number (between 0 and 1) rather than `true`.

For example:

```typescript
import { Component } from '@angular/core';

@Component({
template: `

Home Component


Click to show progress
`
})
export class HomeComponent {
progress: boolean | number = false;

startLoading() {
this.progress = 0; // starts spinner

setTimeout(() => {
this.progress = 0.5; // sets progress bar to 50%

setTimeout(() => {
this.progress = 1; // sets progress bar to 100%

setTimeout(() => {
this.progress = false; // stops spinner
}, 200);
}, 500);
}, 400);
}
}
```

## Feedback

Please [leave your feedback](https://github.com/moff/angular2-ladda/issues) if you notice any issues or have a feature request.

## License

The repository code is open-source software licensed under the [MIT license](http://opensource.org/licenses/MIT).