# svg-filtered

> A plugin that allows for generated filters on images using svg filters

Latest version **0.3.3** (published 2014-11-16) · MIT license · 0 weekly downloads

## Install

```sh
npm install svg-filtered
pnpm add svg-filtered
yarn add svg-filtered
bun add svg-filtered
```

## Health

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

Positive: no vulnerabilities.

Warnings: low downloads; no types; no esm support; pre 1.0.

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 0.3.3 |
| Published | 2014-11-16 |
| First published | 2014-11-16 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | none |
| Module format | CommonJS |
| Dependencies | 1 |
| Known vulnerabilities | 0 |
| Install scripts | no |
| GitHub stars | 4 |
| Author | Jacob Lowe |
| Maintainers | jcblw |
| Keywords | filter, svg, client, browserify, image, video, effects, blur, sepia |

## Links

- npm: https://www.npmjs.com/package/svg-filtered
- Repository: https://github.com/jcblw/svg-filtered
- Issues: https://github.com/jcblw/svg-filtered/issues
- npm.io page: https://npm.io/package/svg-filtered

## Dependencies (1)

- [vsvg](https://npm.io/package/vsvg.md) ^1.0.0

## Alternatives

- [launchdarkly-js-client-sdk](https://npm.io/package/launchdarkly-js-client-sdk.md) — 2.5M weekly downloads
- [@elastic/elasticsearch](https://npm.io/package/@elastic/elasticsearch.md) — 2.1M weekly downloads
- [@c8y/client](https://npm.io/package/@c8y/client.md) — 15.3K weekly downloads
- [@signaldb/maverickjs](https://npm.io/package/@signaldb/maverickjs.md) — 1.7K weekly downloads
- [@bbc/http-transport-cache](https://npm.io/package/@bbc/http-transport-cache.md) — 1.2K weekly downloads

## Recent versions

- 0.3.3 (latest) — 2014-11-16
- 0.3.2 — 2014-11-16
- 0.3.1 — 2014-11-16
- 0.3.0 — 2014-11-16

## README

# SVG Filtered

Filter html elements by using svg filters on them.

![filterify](https://raw.githubusercontent.com/jcblw/svg-filtered/master/examples/before-after.png)

## Installation

    $ npm install svg-filtered

Also you can just use the file `dist/filtered.js` and it will export out a global filtered variable.

## Usage

`filtered[ {name-of-filter} ]( selector[, options ]);`

```html
<img class="inversed-image" src="/cat.gif" alt="cats foo" />
<script src="path-to/filtered.js"></script>
<script>
    filtered.inverse( '.inversed-image' );
</script>
```

Right now there is only three filters ( more coming soon ), or help build one its easy!

- inverse
- blur - you can set the `deviation`
- colorFlood - you can set the `color` to use

This works with [browserify](http://browserify.org)

```
var filtered = require( 'filtered' );

filtered.colorFlood( '.color-me', {
    color: 'tomato'
});
```

## Current Browser Support

- Chrome latest
- Firefox latest
- Chrome for Android

### looking to support

- IE 10,11
- Safari 6
- Safari IOS

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