# ngmat-overlay-spinner

> Angular Material service that shows and hides a spinner on a overlay blocking user interactions as long as it is displayed.

Latest version **1.0.1** (published 2018-11-23) · MIT license · 0 weekly downloads

## Install

```sh
npm install ngmat-overlay-spinner
pnpm add ngmat-overlay-spinner
yarn add ngmat-overlay-spinner
bun add ngmat-overlay-spinner
```

## Health

**Score 25/100 (F)** — status: abandoned.

Positive: has types; esm support; no vulnerabilities.

Warnings: low downloads.

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 1.0.1 |
| Published | 2018-11-23 |
| First published | 2018-11-08 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | bundled |
| Module format | ESM + CommonJS |
| Dependencies | 1 |
| Unpacked size | 146.3 KB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| GitHub stars | 0 |
| Author | Jonas Andreasson |
| Maintainers | crusaider |
| Keywords | angular, material, angular material, spinner, service, overlay |

## Links

- npm: https://www.npmjs.com/package/ngmat-overlay-spinner
- Repository: https://github.com/crusaider/angular-material-utils
- Homepage: https://github.com/crusaider/angular-material-utils#readme
- Issues: https://github.com/crusaider/angular-material-utils/issues
- npm.io page: https://npm.io/package/ngmat-overlay-spinner

## Dependencies (1)

- [tslib](https://npm.io/package/tslib.md) ^1.9.0

## Alternatives

- [react-native-root-siblings](https://npm.io/package/react-native-root-siblings.md) — 102.9K weekly downloads
- [@praxisui/dialog](https://npm.io/package/@praxisui/dialog.md) — 2.0K weekly downloads
- [easy-toggle-state](https://npm.io/package/easy-toggle-state.md) — 350 weekly downloads
- [ngx-lightbox-evp](https://npm.io/package/ngx-lightbox-evp.md) — 19 weekly downloads
- [react-native-modal-translucent-axton](https://npm.io/package/react-native-modal-translucent-axton.md) — 4 weekly downloads

## Recent versions

- 1.0.1 (latest) — 2018-11-23
- 1.0.0 — 2018-11-08

## README

# ngmat-overlay-spinner

A service that shows and hides a spinner on a overlay blocking user interactions as long as it is displayed.

[Demo](https://crusaider.github.io/angular-material-utils/overlay-spinner)

## Installation

`npm install --save ngmat-overlay-spinner`

## API

`import { OverlaySpinnerModule } from 'ngmat-overlay-spinner';`

### Services

#### `OverlaySpinnerService`

A service that shows and hides a spinner on a overlay blocking user interactions as long as it is displayed.

##### Methods

| `open`                     |                                                                   |
| -------------------------- | ----------------------------------------------------------------- |
| Shows a overlay spinner.   |                                                                   |
| **Parameters**             |                                                                   |
| `options?: SpinnerOptions` | Optional configuration object controlling the spinner appearance. |
| **Returns**                |                                                                   |
| `SpinnerRef`               | A reference to the opened spinner overlay                         |

### Classes

#### `SpinnerRef`

A reference to a opened overlay spinner.

#### Methods

| `dismiss`                                    |     |
| -------------------------------------------- | --- |
| Hides removes the spinner overlay from view. |     |

### Interfaces

#### `SpinnerOptions`

Configuration settings for the spinner appearance. Any properties not supplied will use the default value of the `mat-progress-spinner` component.

##### Properties

| Name                         | Description                                                                                                                                             |
| ---------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------- |
| `color?: ThemePalette`       | Theme color palette for the component. [See.](https://material.angular.io/components/progress-spinner/api#MatSpinner)                                   |
| `diameter?: number`          | The diameter of the progress spinner (will set width and height of svg). [See.](https://material.angular.io/components/progress-spinner/api#MatSpinner) |
| `strokeWidth?: number`       | Stroke width of the progress spinner. [See.](https://material.angular.io/components/progress-spinner/api#MatSpinner)                                    |
| `mode?: ProgressSpinnerMode` | Mode of the progress circle. [See.](https://material.angular.io/components/progress-spinner/api#MatSpinner)                                             |
| `value?: Observable<number>` | Value of the progress circle. Only relevant if the mode is `'determinate'`. The spinner will be updated for every emit of the obervable.                |

---
_Source: https://npm.io/package/ngmat-overlay-spinner · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._