https://github.com/matt-d-rat/img-pulse
A web component that creates a Tinder-esque image pulse.
https://github.com/matt-d-rat/img-pulse
Last synced: about 2 months ago
JSON representation
A web component that creates a Tinder-esque image pulse.
- Host: GitHub
- URL: https://github.com/matt-d-rat/img-pulse
- Owner: matt-d-rat
- License: mit
- Created: 2015-09-03T04:46:26.000Z (almost 10 years ago)
- Default Branch: develop
- Last Pushed: 2015-09-04T00:24:47.000Z (over 9 years ago)
- Last Synced: 2025-03-16T23:07:08.364Z (3 months ago)
- Language: JavaScript
- Size: 273 KB
- Stars: 0
- Watchers: 1
- Forks: 1
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# <img-pulse>
> A web component that creates a Tinder-esque image pulse.
## Demo
[Check it live!](http://matt-d-rat.github.io/img-pulse)
## Install
Install the component using [Bower](http://bower.io/):
```sh
$ bower install img-pulse --save
```
Or [download as ZIP](https://github.com/matt-d-rat/img-pulse/archive/master.zip).
## Usage
1. Import polyfill:
```html
```
2. Import custom element:
```html
```
3. Start using it!
```html
```
## Options
Attribute | Options | Default | Description
--- | --- | --- | ---
`src` | *String* | none | The src of the image.
`size` | *Number* | `150` | The size of the image. Sets the height and width to the same size.
`pulse-color` | *String* | `#ff0000` | The color of the pulse.
## Development
In order to run it locally you'll need to fetch some dependencies and a basic server setup.
1. Install [bower](http://bower.io/) & [polyserve](https://npmjs.com/polyserve):
```sh
$ npm install -g bower polyserve
```
2. Install local dependencies:
```sh
$ bower install
```
3. Start development server and open `http://localhost:8080/components/my-repo/`.
```sh
$ polyserve
```
## History
For detailed changelog, check [Releases](https://github.com/matt-d-rat/img-pulse/releases).
## License
[MIT License](http://opensource.org/licenses/MIT)