# image-filter-component

> Image Filter Web Component

Latest version **0.0.2** (published 2022-02-28) · MIT license · 0 weekly downloads

## Install

```sh
npm install image-filter-component
pnpm add image-filter-component
yarn add image-filter-component
bun add image-filter-component
```

## Health

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

Positive: has types; esm support; no vulnerabilities; high quality score.

Warnings: low downloads; pre 1.0.

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 0.0.2 |
| Published | 2022-02-28 |
| First published | 2022-02-28 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | bundled |
| Module format | ESM + CommonJS |
| Dependencies | 1 |
| Unpacked size | 291.4 KB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| GitHub stars | 0 |
| Maintainers | niklus |

## Links

- npm: https://www.npmjs.com/package/image-filter-component
- Repository: https://github.com/Niklus/image-filter
- Homepage: https://github.com/Niklus/image-filter#readme
- Issues: https://github.com/Niklus/image-filter/issues
- npm.io page: https://npm.io/package/image-filter-component

## Dependencies (1)

- [@stencil/core](https://npm.io/package/@stencil/core.md) ^2.13.0

## Recent versions

- 0.0.2 (latest) — 2022-02-28
- 0.0.1 — 2022-02-28

## README

![Built With Stencil](https://img.shields.io/badge/-Built%20With%20Stencil-16161d.svg?logo=data%3Aimage%2Fsvg%2Bxml%3Bbase64%2CPD94bWwgdmVyc2lvbj0iMS4wIiBlbmNvZGluZz0idXRmLTgiPz4KPCEtLSBHZW5lcmF0b3I6IEFkb2JlIElsbHVzdHJhdG9yIDE5LjIuMSwgU1ZHIEV4cG9ydCBQbHVnLUluIC4gU1ZHIFZlcnNpb246IDYuMDAgQnVpbGQgMCkgIC0tPgo8c3ZnIHZlcnNpb249IjEuMSIgaWQ9IkxheWVyXzEiIHhtbG5zPSJodHRwOi8vd3d3LnczLm9yZy8yMDAwL3N2ZyIgeG1sbnM6eGxpbms9Imh0dHA6Ly93d3cudzMub3JnLzE5OTkveGxpbmsiIHg9IjBweCIgeT0iMHB4IgoJIHZpZXdCb3g9IjAgMCA1MTIgNTEyIiBzdHlsZT0iZW5hYmxlLWJhY2tncm91bmQ6bmV3IDAgMCA1MTIgNTEyOyIgeG1sOnNwYWNlPSJwcmVzZXJ2ZSI%2BCjxzdHlsZSB0eXBlPSJ0ZXh0L2NzcyI%2BCgkuc3Qwe2ZpbGw6I0ZGRkZGRjt9Cjwvc3R5bGU%2BCjxwYXRoIGNsYXNzPSJzdDAiIGQ9Ik00MjQuNywzNzMuOWMwLDM3LjYtNTUuMSw2OC42LTkyLjcsNjguNkgxODAuNGMtMzcuOSwwLTkyLjctMzAuNy05Mi43LTY4LjZ2LTMuNmgzMzYuOVYzNzMuOXoiLz4KPHBhdGggY2xhc3M9InN0MCIgZD0iTTQyNC43LDI5Mi4xSDE4MC40Yy0zNy42LDAtOTIuNy0zMS05Mi43LTY4LjZ2LTMuNkgzMzJjMzcuNiwwLDkyLjcsMzEsOTIuNyw2OC42VjI5Mi4xeiIvPgo8cGF0aCBjbGFzcz0ic3QwIiBkPSJNNDI0LjcsMTQxLjdIODcuN3YtMy42YzAtMzcuNiw1NC44LTY4LjYsOTIuNy02OC42SDMzMmMzNy45LDAsOTIuNywzMC43LDkyLjcsNjguNlYxNDEuN3oiLz4KPC9zdmc%2BCg%3D%3D&colorA=16161d&style=flat-square)

# image-filter web component

This is a web component for applying different filters to your image.

## Using this component

### Add the following script tag in the head of your .html page

```html
<script type="module" src="https://unpkg.com/image-filter-component@0.0.2/dist/image-filter/image-filter.esm.js"></script>
```

### Then in your html or jsx

<!-- prettier-ignore -->
```html
  <image-filter 
    src="beach-time.jpg" 
    alt="Children at the beach" 
    width="500" 
    filter="sepia"></image-filter>
```

## API

### image-filter properties

- src (string)
- alt (string)
- width (string)
- height (string)
- class (string) : allows you to apply your own styles
- filter (string) : supported values shown below

### Supported Filter Values

- sepia
- invert
- grayscale
- blur
- contrast
- saturate
- huerotate
- shadow
- opacity

### Demo

- Look at the [DEMO](https://niklus.github.io/image-filter-demo/) and see the different styles applied

### Script tag

- Put a script tag similar to this `<script type='module' src='https://unpkg.com/image-filter-component@0.0.2/dist/image-filter/image-filter.esm.js'></script>` in the head of your index.html
- Then you can use the element anywhere in your template, JSX, html etc
- Remember to add type="module" on your script tag as shown above

### Node Modules

- Run `npm install image-filter-component --save`
- Put a script tag similar to this `<script type='module' src='node_modules/image-filter-component/dist/image-filter/image-filter.esm.js'></script>` in the head of your index.html
- Then you can use the element anywhere in your template, JSX, html etc
- Remember to add type="module" on your script tag as shown above

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