|
| 1 | +# Changelog |
| 2 | + |
| 3 | +## 7.0.0-next.0 |
| 4 | + |
| 5 | +### Major Changes |
| 6 | + |
| 7 | +- - Add option to use Windows surface pen button as eraser |
| 8 | + - Memoize functions to reduce re-rendering |
| 9 | + |
| 10 | +# [6.1.0] |
| 11 | + |
| 12 | +### Added |
| 13 | + |
| 14 | +- Added optional id props to uniquely identify a sketch canvas |
| 15 | +- Upgraded dependencies |
| 16 | + |
| 17 | +### Changed |
| 18 | + |
| 19 | +- Updated tests to use the id props |
| 20 | + |
| 21 | +### Fixed |
| 22 | + |
| 23 | +- Fix multiple ReactSketchCanvas in one page causes issues due to id="background" #52 |
| 24 | +- Fix ReactSketchCanvas doesn't work on safari. #53 |
| 25 | + |
| 26 | +## [6.0.3] |
| 27 | + |
| 28 | +### Fixed |
| 29 | + |
| 30 | +- Fix Package cannot be installed via npm #51 |
| 31 | +- update contributing.md |
| 32 | +- update github actions |
| 33 | + |
| 34 | +## [6.0.2] |
| 35 | + |
| 36 | +### Added |
| 37 | + |
| 38 | +- Added cypress tests for all props and events |
| 39 | +- Added `onStroke` prop to get last stroke on pointer up |
| 40 | +- Adds a point on click (without moving) #45 |
| 41 | + |
| 42 | +### Changed |
| 43 | + |
| 44 | +- Upgraded all dependencies |
| 45 | +- Moved to DTS (tsdx fork) instead of nx |
| 46 | +- Switched codebase to hook based implementation (support react >= 16.8) |
| 47 | +- Removed immer dependency |
| 48 | + |
| 49 | +### Fixed |
| 50 | + |
| 51 | +- Changed React import to \* from React #40 |
| 52 | +- Export image fails when the background is not an image [beta] #46 |
| 53 | +- Fix partial transparent erase (eraser stroke color changed to black for masking, add maskUnits) #44 |
| 54 | + |
| 55 | +### Breaking changes |
| 56 | + |
| 57 | +- Renamed `onUpdate` to `onChange` |
| 58 | + |
| 59 | +## [6.0.1-beta] |
| 60 | + |
| 61 | +### Added |
| 62 | + |
| 63 | +- Upgraded all dependencies |
| 64 | +- Updated directory structure |
| 65 | +- Added background image rendering directly in SVG |
| 66 | +- Added option to export background image while exporting the canvas as image or SVG |
| 67 | +- Added background image aspect ratio control |
| 68 | +- Updated erase option to use mask instead of canvas color |
| 69 | +- Add github action for deployment of storybook and package |
| 70 | + |
| 71 | +### Breaking changes |
| 72 | + |
| 73 | +- Removed background option to set background image using CSS-in-JS (instead check feature-filled backgroundImage prop) |
| 74 | + |
| 75 | +## [5.3.5] |
| 76 | + |
| 77 | +## Changed |
| 78 | + |
| 79 | +- Changed import react as `import * as React from 'react'` |
| 80 | + |
| 81 | +## [5.3.4] |
| 82 | + |
| 83 | +### Added |
| 84 | + |
| 85 | +- Switched to Nx |
| 86 | +- Updated documentation |
| 87 | + |
| 88 | +### Changed |
| 89 | + |
| 90 | +- Removed pepjs. Can be polyfilled by the web app directly instead |
| 91 | + |
| 92 | +## [5.3.3] |
| 93 | + |
| 94 | +### Fixed |
| 95 | + |
| 96 | +- add support any version above react 16.4 |
| 97 | + |
| 98 | +## [5.3.2] |
| 99 | + |
| 100 | +### Fixed |
| 101 | + |
| 102 | +- Bump dependency versions |
| 103 | + |
| 104 | +## [5.3.1] |
| 105 | + |
| 106 | +### Fixed |
| 107 | + |
| 108 | +- Set default value of `allowOnlyPointerType` as `'all'` again |
| 109 | + |
| 110 | +## [5.3.0] |
| 111 | + |
| 112 | +### Added |
| 113 | + |
| 114 | +- Reset canvas option to reset internal state and clean undo/redo stack |
| 115 | + |
| 116 | +### Fixed |
| 117 | + |
| 118 | +- Fix exportImage function to export png in Firefox and Safari |
| 119 | + |
| 120 | +## [5.2.0] |
| 121 | + |
| 122 | +### Added |
| 123 | + |
| 124 | +- Add `withTimestamp` prop and `getSketchingTime` function to measure the sketching time of the user |
| 125 | + |
| 126 | +## [5.1.2] & [5.1.1] (Both are same - Sorry) |
| 127 | + |
| 128 | +### Added |
| 129 | + |
| 130 | +- Add index.d.ts to npm registry |
| 131 | +- Add Github as registry |
| 132 | +- Update example |
| 133 | + |
| 134 | +## [5.1.0] |
| 135 | + |
| 136 | +### Added |
| 137 | + |
| 138 | +- Added defaultProps to onUpdate in ReactSketchCanvas |
| 139 | +- Added touch-action="none" to allow pepjs polyfill pointer events |
| 140 | +- Update README.md |
| 141 | + |
| 142 | +### Fixed |
| 143 | + |
| 144 | +- Removed the annoying console.log from Canvas |
| 145 | + |
| 146 | +## [5.0.1] |
| 147 | + |
| 148 | +### Added |
| 149 | + |
| 150 | +Added README :) |
| 151 | + |
| 152 | +## [5.0.0] |
| 153 | + |
| 154 | +### Added |
| 155 | + |
| 156 | +- Rewrote codebase in typescript |
| 157 | +- Added pepjs to support more browsers |
| 158 | +- Added onUpdate feature to get current paths in `CanvasPath` type |
| 159 | + |
| 160 | +### Fixed |
| 161 | + |
| 162 | +- Fixed sketch offset issue when the canvas is scrolled |
| 163 | + |
| 164 | +### Changed |
| 165 | + |
| 166 | +- Updated undo/redo/reset strategy |
| 167 | +- Updated demo in storybook |
| 168 | + |
| 169 | +## [4.0.0] |
| 170 | + |
| 171 | +### Added |
| 172 | + |
| 173 | +- Renamed SvgSketchCanvas to ReactSketchCanvas to keep naming convention |
| 174 | +- Added className property to set class names for CSS selectors |
| 175 | + |
| 176 | +### Deprecated |
| 177 | + |
| 178 | +- Removed SvgSketchCanvas |
| 179 | + |
| 180 | +## [3.0.1] |
| 181 | + |
| 182 | +### Changed |
| 183 | + |
| 184 | +- Moved immutable dependency from Canvas file |
| 185 | + |
| 186 | +## [3.0.0] |
| 187 | + |
| 188 | +### Changed |
| 189 | + |
| 190 | +Removed onUpdate feature and made the system modular |
| 191 | + |
| 192 | +### Added |
| 193 | + |
| 194 | +- Made Canvas as a separate module. Now event handlers can be hooked with Canvas |
| 195 | + class to update paths from server. (For Collaboration use case) |
| 196 | + |
| 197 | +### Deprecated |
| 198 | + |
| 199 | +- Removed onUpdate feature and instead made Canvas module |
| 200 | + |
| 201 | +## [2.3.0] |
| 202 | + |
| 203 | +### Added |
| 204 | + |
| 205 | +- Added onUpdate property to get the current sketch paths after every update |
| 206 | + |
| 207 | +## [2.2.0] |
| 208 | + |
| 209 | +allowOnlyPointerType |
| 210 | + |
| 211 | +### Added |
| 212 | + |
| 213 | +- Added "allowOnlyPointerType" use-case. Now single pointer type can be targetted |
| 214 | + |
| 215 | +## [2.1.0] |
| 216 | + |
| 217 | +### Added |
| 218 | + |
| 219 | +- Switched to pointer events |
| 220 | + |
| 221 | +## [2.0.1] |
| 222 | + |
| 223 | +### Added |
| 224 | + |
| 225 | +- Add SVG background using CSS |
| 226 | + |
| 227 | +## [2.0.0] |
| 228 | + |
| 229 | +### Added |
| 230 | + |
| 231 | +- Export and load paths |
| 232 | +- Erase mode and eraser width |
| 233 | + |
| 234 | +### Changed |
| 235 | + |
| 236 | +- Rename exportAsImage() to exportImage() for naming consistency |
| 237 | + |
| 238 | +### Deprecated |
| 239 | + |
| 240 | +- Rename exportAsImage() |
0 commit comments