Skip to content

Commit

Permalink
New tool addition
Browse files Browse the repository at this point in the history
Adding some documentation
new version v0.3.2
  • Loading branch information
tbolis committed Mar 6, 2017
1 parent 83b0350 commit cbd56a3
Show file tree
Hide file tree
Showing 2 changed files with 15 additions and 2 deletions.
15 changes: 14 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -53,7 +53,7 @@ Configuration Options

| Option | Type | Default | Description |
|--- |--- |--- |--- |
| tool | Enumeration (string) | pencil | The tool to use, can be select,pencil,circle, rectangle,circle |
| 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) |
Expand All @@ -68,6 +68,19 @@ Configuration Options
| 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 |
| Circle | Create circles |
| Rectangle | Create Rectangles |
| Select | Disables drawing and gives you the ability to modify existing elements in the canvas |
| 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](https://github.com/wmaillard)) |


## Examples

The project includes a webpack server for running the examples, just run:
Expand Down
2 changes: 1 addition & 1 deletion package.json
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
{
"name": "react-sketch",
"version": "0.3.1",
"version": "0.3.2",
"description": "Sketch Element for React based applications, backed-up by fabricjs as its core",
"keywords": [
"react",
Expand Down

0 comments on commit cbd56a3

Please sign in to comment.