Ecosyste.ms: Awesome

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

Awesome Lists | Featured Topics | Projects

https://github.com/taenykim/interactive-pixelator

πŸŒ‡ πŸŒƒ upload image and make interactive pixel art πŸ•Ή
https://github.com/taenykim/interactive-pixelator

art canvas image image-processing interactive javascript pixel pixelator typescript

Last synced: 2 months ago
JSON representation

πŸŒ‡ πŸŒƒ upload image and make interactive pixel art πŸ•Ή

Awesome Lists containing this project

README

        

# Interactive pixelator

![npm](https://img.shields.io/npm/v/interactive-pixelator)
![GitHub](https://img.shields.io/github/license/taenykim/interactive-pixelator)
![dependencies](https://img.shields.io/badge/dependencies-none-brightengreen)
![typed](https://badgen.net/badge/icon/Typed?icon=typescript&label&labelColor=555555&color=blue)

πŸŒ‡ πŸŒƒ upload image and make interactive pixel art πŸ•Ή

**[Demo page](https://interactive-pixelator.vercel.app) / [NPM page](https://www.npmjs.com/package/interactive-pixelator)**

## 🌟 Feature

Original Image
Change Pixel size

Change Pixel type
Change Grid size

Change Grid color
Draw freely

Change filter
coming soon

## 🌈 How to use

### 1. NPM install

```BASH
$ npm i interactive-pixelator
```

### 2. Create DOM container

> πŸ”₯ Set width and height on the DOM element.

```html


```

### 3. And make Interactive Pixel Art!

> If necessary, Add a controller, download button, etc. (reference : **[Demo page](https://interactive-pixelator.vercel.app)**)

```typescript
import { Pixelator } from "interactive-pixelator";

new Pixelator("DOM-element-id", "image URL", {
// options
pixelSize: number, // 1~ (default:100)
gridSize: number, // 0~ (default:10)
gridColor: string, // #000000 (default:#ffffff)
pixelType: string, // [square(default), roundsquare, circle, original]
filterType: string // [none(default), grayscale, invert]
});

//prettier-ignore
```

## 🏎 Demo play

> I used create-react-app ! ☺️ [source code](https://github.com/taenykim/interactive-pixelator/tree/master/examples/demo-cra)

```BASH
$ git clone https://github.com/taenykim/interactive-pixelator.git
$ cd example/demo-cra
$ npm install
$ npm start
```

## ✏️ And..

**This project is in progress.**

**please give me a lot of advice and support.**