npm package discovery and stats viewer.

Discover Tips

  • General search

    [free text search, go nuts!]

  • Package details

    pkg:[package-name]

  • User packages

    @[username]

Sponsor

Optimize Toolset

I’ve always been into building performant and accessible sites, but lately I’ve been taking it extremely seriously. So much so that I’ve been building a tool to help me optimize and monitor the sites that I build to make sure that I’m making an attempt to offer the best experience to those who visit them. If you’re into performant, accessible and SEO friendly sites, you might like it too! You can check it out at Optimize Toolset.

About

Hi, 👋, I’m Ryan Hefner  and I built this site for me, and you! The goal of this site was to provide an easy way for me to check the stats on my npm packages, both for prioritizing issues and updates, and to give me a little kick in the pants to keep up on stuff.

As I was building it, I realized that I was actually using the tool to build the tool, and figured I might as well put this out there and hopefully others will find it to be a fast and useful way to search and browse npm packages as I have.

If you’re interested in other things I’m working on, follow me on Twitter or check out the open source projects I’ve been publishing on GitHub.

I am also working on a Twitter bot for this site to tweet the most popular, newest, random packages from npm. Please follow that account now and it will start sending out packages soon–ish.

Open Software & Tools

This site wouldn’t be possible without the immense generosity and tireless efforts from the people who make contributions to the world and share their work via open source initiatives. Thank you 🙏

© 2024 – Pkg Stats / Ryan Hefner

@oniti/react-sketch

v1.2.6

Published

Sketch Element for React based applications, backed-up by fabricjs as its core

Downloads

37

Readme

oniti-react-sketch

GitHub release NPM release NPM downloads Build status

A Sketch tool for React based applications, backed-up by FabricJS

Fork from [react-sketch] (https://github.com/tbolis/react-sketch)

idea-image Please note that this module is still in development! Feel free to send me enhancements and ideas :)

Installation

npm install @oniti/react-sketch --save

or with yarn

yarn add react-sketch

Source installation

In order to build from source, read the relevant instructions first.

Tested with node versions 6,7,8.

Usage

Import the relevant SketchField component and use it, you can find more on the examples folder of the project

import {SketchField, Tools} from 'react-sketch';

class SketchFieldDemo extends React.Component {
     render() {
        return (
            <SketchField width='1024px' 
                         height='768px' 
                         tool={Tools.Pencil} 
                         lineColor='black'
                         lineWidth={3}/>
        )
     }
}

Configuration Options

| Option | Type | Default | Description | |--- |--- |--- |--- | | tool | Enumeration (string) | pencil | The tool to use, can be select, pencil, circle, rectangle, pan | | lineColor | String | black | The color of the line | | lineWidth | Number | 1 | The width of the line | | fillColor | String | transparent | The fill color (hex format) of the shape when applicable (e.g. circle) | | backgroundColor | String | transparent | The the background color of the sketch in hex or rgba | | undoSteps | Number | 15 | number of undo/redo steps to maintain | | imageFormat | String | png | image format when calling toDataURL, can be png or jpeg | | width | Number | No Value(null)| Set/control the canvas width, if left empty the sketch will scale to parent element | | height | Number | 512 | Set/control the canvas height, if left empty the sketch will take a reasonable default height | | value | JSON | | Property to utilize and handle the sketch data as controlled component | | defaultValue | JSON | | Default initial data, to load. If value is set then value will be loaded instead | | widthCorrection | Number | 2 | Specify some width correction which will be applied on resize of canvas, this will help to correct some possible border on the canvas style | | heightCorrection | Number | 0 | Specify some height correction which will be applied on resize of canvas, this will help to correct some possible border on the canvas style |

Available tools

| Tool | Description | |--- |--- | | Pencil | Free drawing pencil | | Line | Gives you the ability to draw lines | | DasedLine | Gives you the ability to draw dashed lines | | Rectangle | Create rectangles | | Circle | Create circles | | Rectangle | Create Rectangles | | Select | Disables drawing and gives you the ability to modify existing elements in the canvas | | HorizontalLine | Create HorizontalLine| | VerticalLine | Create VerticalLine | | DoubleArrow | Create DoubleArrow | | Text | Create TextAera | | Pan | Disables drawing and gives you the ability to move the complete canvas at will, useful to adjust the canvas when zooming in or out (thank you wmaillard) |

Examples

The project includes a webpack server for running the examples, just run:

git clone https://github.com/tbolis/react-sketch.git
yarn install
npm start

and navigate to http://localhost:23000

You can as well check the live showcase here: http://tbolis.github.io/showcase/react-sketch/

Issues

See https://github.com/tbolis/react-sketch/issues

Changelog

See https://github.com/tbolis/react-sketch/blob/master/CHANGELOG.md

License

MIT, do remember to add a reference if you find it useful :)