Skip to content

Commit 74ddf26

Browse files
author
Andreas Riepl
committed
feat(scroll-on-touch): adds docu
1 parent 494aa59 commit 74ddf26

File tree

1 file changed

+2
-1
lines changed

1 file changed

+2
-1
lines changed

README.md

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -121,7 +121,7 @@ const Canvas = class extends React.Component {
121121
## List of Props
122122

123123
| Props | Expected datatype | Default value | Description |
124-
| ---------------------------------- | ----------------- | --------------------- | --------------------------------------------------------------------------------------------------- |
124+
|------------------------------------|-------------------| --------------------- |-----------------------------------------------------------------------------------------------------|
125125
| width | PropTypes.string | 100% | canvas width (em/rem/px) |
126126
| height | PropTypes.string | 100% | canvas width (em/rem/px) |
127127
| id | PropTypes.string | "react-sketch-canvas" | ID field to uniquely identify a SVG canvas (Supports multiple canvases in a single page) |
@@ -136,6 +136,7 @@ const Canvas = class extends React.Component {
136136
| allowOnlyPointerType | PropTypes.string | all | allow pointer type ("all"/"mouse"/"pen"/"touch") |
137137
| onChange | PropTypes.func | | Returns the current sketch path in `CanvasPath` type on every path change |
138138
| onStroke | PropTypes.func | | Returns the the last stroke path and whether it is an eraser stroke on every pointer up event |
139+
| scrollOnTouch | PropTypes.bool | false | Scroll overflowing component instead of sketching if pointerType === touch |
139140
| style | PropTypes.object | false | Add CSS styling as CSS-in-JS object |
140141
| svgStyle | PropTypes.object | {} | Add CSS styling as CSS-in-JS object for the SVG |
141142
| withTimestamp | PropTypes.bool | false | Add timestamp to individual strokes for measuring sketching time |

0 commit comments

Comments
 (0)