pen-tool
v1.0.6
Published
a pen plugin based canvas for drawing path
Downloads
10
Readme
pen-tool
English | 简体中文
Overview
This project is a canvas-based path drawing tool.
Background: In the h5 editors that are often encountered, there are always a variety of components, but most h5 editors have not found a satisfactory lightweight path drawing tool. So we decided to develop one according to the existing ideas. Considering the advantages of typescript over javascript, this project is built with typescript. If there are any imperfections or new features need to be added, please actively mention the issue.
Directory
|-- pen-tool
|-- lib typescript declaration dir
| |-- constant.d.ts
| |-- cursorConfig.d.ts
| |-- penTool.d.ts
|-- output typescript compiles outDir
| |-- constant.js
| |-- cursorConfig.js
| |-- penTool.js
|-- src source files
| |-- classes.ts
| |-- constant.ts
| |-- cursorConfig.ts
| |-- interface.ts
| |-- penTool.ts
|-- static
| |-- demo.js
| |-- example.png
| |-- rose.png
|-- demo.js js for demo
|-- gulpfile.js
|-- index.html index for demo
|-- index.esm.js
|-- index.umd.js
|-- package-lock.json
|-- package.json
|-- README.md
|-- README-zh.md
|-- tsconfig.jsonDevelopment
- compile
> tsc- build
> gulpUsage
cdn
...
<head>
<script type="text/javascript" src="index.umd.js"></script>
</head>
<body>
<button id="btn">EnablePen</button>
<canvas id="canvas" width="600" height="400"></canvas>
</body>
...
<script>
let pen = new PenTool("canvas");
document.getElementById("btn").addEventListener("click", function() {
pen.enablePen();
})
</script>npm
npm install pen-tool- index.html
<body>
<button id="btn">EnablePen</button>
<canvas id="canvas" width="600" height="400"></canvas>
</body>- index.js
import PenTool from 'pen-tool'
let pen = new PenTool("canvas", {
pathFillColor: 'red',
isFillPath: true
// ...
});
document.getElementById("btn").addEventListener("click", function() {
pen.enablePen();
})Demo
Open index.html after starting server to see the demo. index.html and demo.js in the root directory are the example files.
Or see the Demo
Parameters
In general, the curve is essential when drawing a path, but the Bezier curve drawn by hand cannot be in one step. In response to this problem, we give an adjustment handle to the curve, and control the drawing of the curve through the handle.
initial penTool
var pen = new Pen(canvasId, options);- canvasId:
stringCanvas to draw the path. Make sure that the dom already exists when initializing - options:
IPenOptionsoptional- circle:
PenCirclekeyPoint configuration of path- radius:
numberkeyPoint radius - stroke:
String | CanvasGradient | CanvasPatternkeyPoint circle strokeStyle - fill:
String | CanvasGradient | CanvasPatternfillStyle
- radius:
- line:
PebLinecurve control auxLine configuration- stroke:
String | CanvasGradient | CanvasPattern - fill:
String | CanvasGradient | CanvasPattern
- stroke:
- pathColor:
stringpath strokeStyle - pathFillColor:
stringpath fillStyle - isFillPath:
booleanWhether fill the path.falsefor default
- circle:
more information lib/penTool.d.ts
Exit drawing
Exit
When the pen tool is turned on, press
ESCfor the first time to enter the path editing mode. At this time, you can modify the drawing shape by moving the key points of the path; pressESCfor the second time or click the blank space in the path editing mode, Quit drawing.Edit
If you want to re-edit the path after have exited drawing, just double-click the path area to enter the editing mode. For the determination of the path area, please refer to isPointInPath
Line-Curve
Change path type
In path editing mode: double-click the key point. If the current key point is a straight line type, the key point becomes a curve type. The straight line connecting the two key points before and after the current key point is a curve, and vice versa.
Curve controller
For the controllers of curve, moving the position of the handle can change the Bezier function of the curve, but the movement of the controller affects the path at both ends of the key points of the curve. Press the
Altkey while moving the handle, you can only control the curve of the handle end.
Future features
The current project is only a simple way to draw and edit paths, and it is not powerful. We will continue to improve in the future. Current goals:
- [ ] Support path to move in canvas
- [ ] Multi-path drawing