Ecosyste.ms: Awesome

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

Awesome Lists | Featured Topics | Projects

https://github.com/component/spin

Higher level spinner api built on component/spinner - positions and scales automatically within target element
https://github.com/component/spin

Last synced: 30 days ago
JSON representation

Higher level spinner api built on component/spinner - positions and scales automatically within target element

Awesome Lists containing this project

README

        

# spin

Higher level spinner API auto positioning and scaling
to fit within the target element. Built on [component/spinner](https://github.com/component/spinner).

![javascript spinner](http://i.cloudup.com/7F5SguoUkoB+e4r.png)

## Installation

$ component install component/spin

## API

### spin(el, [options])

Add a spinner to `el` with options, and return
the `Spinner` instance.

- `size` defaulting to 1/5th the element width
- `delay` default to 300ms

```js
var s = spin(document.querySelector('.one'));
```

### Spinner#update()

Augments the `Spinner` returned with an `.update()` method,
which updates the size and position of the spinner.

### Spinner#remove()

Augments the `Spinner` returned with a `.remove()` method,
which when removes the spinner or cancels delayed spinners.

## License

MIT