Skip to content

Latest commit

History

11 Commits

Folders and files

NameName
Last commit message
Last commit date

Repository files navigation

React Pixelify

This repository contains the source code and documentation of the pixelify component for React.

Currently, the package includes only the following component:

  • Pixelify

Demo

https://nikoferro.github.io/react-pixelify-demo/

Installing

Using npm:

$ npm install react-pixelify

Basic Usage

Importing the package

import{Pixelify}from"react-pixelify";

Usage

// Require your imageconstsrc=require("./image.jpg");// Basic setup<Pixelifysrc={src}pixelSize={20}/>

Properties

PropertyTypeDefault ValueDescriptionRequired
srcStringSource of the imageYes
pixelSizeInt1Size of the pixel in the new pixelated image. if no value is set, the original image is displayed with no pixelated effectNo
widthIntimage original widthYou can use this prop to override the original widthNo
heightIntimage original heightYou can use this prop to override the original heightNo
centeredBoolfalseIf true, the pixels grid will be centered vertically and horizontally. Example: You choose a pixelSize of 10, but your image width or height cant be divided by an exact grid of 10x10 pixels. Setting this prop as true will set an offset that keeps the grid centeredNo
fillTransparencyColorStringwhiteFor images with transparency, you can set a value for the places where the image is transparent. Think of it as a background color for your pixelated imageNo

About

React component to turn images into pixel-art

Resources

Stars

28 stars

Watchers

1 watching

Forks

Releases

Packages

Used by

Contributors

Languages