Ecosyste.ms: Awesome

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

Awesome Lists | Featured Topics | Projects

https://github.com/andrepolischuk/magnifier

Magnifier an image
https://github.com/andrepolischuk/magnifier

image lens loupe magnifier

Last synced: about 2 months ago
JSON representation

Magnifier an image

Awesome Lists containing this project

README

        

# magnifier [![Build Status][travis-image]][travis-url]

> Magnifier an image

![](screenshot.png)

## Install

```sh
npm install --save magnifier
```

## Usage

```js
import Magnifier from 'magnifier';

new Magnifier('.image');
```

## API

### new Magnifier(image)

Create a new `Magnifier` instance.

#### image

Type: `element`, `string`

Image for magnification.

### .height(h)

#### h

Type: `number`, `string`

Lens height.

### .width(h)

#### h

Type: `number`, `string`

Lens width.

### .backgroundColor(color)

#### color

Type: `string`

Lens background color.

### .borderColor(color)

#### color

Type: `string`

Lens border color.

### .borderRadius(r)

#### r

Type: `number`, `string`

Lens radius.

### .borderWidth(w)

#### w

Type: `number`, `string`

Lens border width.

### .className(name)

#### name

Type: `string`

Lens class name.

### .show()

Forced show lens.

### .hide()

Forced hide lens.

### .destroy()

Unbinds the event handlers and removes the lense.

## License

MIT

[travis-url]: https://travis-ci.org/andrepolischuk/magnifier
[travis-image]: https://travis-ci.org/andrepolischuk/magnifier.svg?branch=master