@idraw/renderer 0.2.0-alpha.22 → 0.2.0-alpha.23

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (2) hide show
  1. package/README.md +66 -1
  2. package/package.json +4 -4
package/README.md CHANGED
@@ -1,3 +1,68 @@
1
1
  # @idraw/renderer
2
2
 
3
- [![Node.js CI](https://github.com/idrawjs/idraw/actions/workflows/node.js.yml/badge.svg?branch=main)](https://github.com/idrawjs/idraw/actions/workflows/node.js.yml)
3
+ [![Node.js CI](https://github.com/idrawjs/idraw/actions/workflows/node.js.yml/badge.svg?branch=main)](https://github.com/idrawjs/idraw/actions/workflows/node.js.yml)
4
+
5
+
6
+ ## Usage
7
+
8
+ ### Quick Start
9
+
10
+ ```sh
11
+ npm i @idraw/renderer
12
+ ```
13
+
14
+ ```js
15
+ import Renderer from '@idraw/renderer';
16
+
17
+ const renderer = new Renderer({
18
+ width: 600,
19
+ height: 400,
20
+ contextWidth: 600,
21
+ contextHeight: 400,
22
+ devicePixelRatio: 1,
23
+ });
24
+
25
+ const canvas = document.querySelector('canvas');
26
+ renderer.render(canvas, {
27
+ elements: [
28
+ {
29
+ name: "rect-001",
30
+ x: 10,
31
+ y: 10,
32
+ w: 200,
33
+ h: 100,
34
+ type: "rect",
35
+ desc: {
36
+ bgColor: "#f0f0f0",
37
+ borderRadius: 20,
38
+ borderWidth: 10,
39
+ borderColor: "#bd0b64",
40
+ },
41
+ },
42
+ ]
43
+ })
44
+
45
+ ```
46
+
47
+ ### Events
48
+
49
+ ```js
50
+ renderer.on('load', (e) => {
51
+ // ...
52
+ })
53
+ renderer.on('loadComplete', (e) => {
54
+ // ...
55
+ })
56
+
57
+ renderer.on('drawFrame', (e) => {
58
+ // ...
59
+ })
60
+ renderer.on('drawFrameComplete', (e) => {
61
+ // ...
62
+ })
63
+ ```
64
+
65
+ ## Documents
66
+
67
+ - [Documents](https://idraw.js.org/docs/en/) | [中文文档](https://idraw.js.org/docs/zh/)
68
+ - [Online Playground](https://idraw.js.org/playground/) | [在线API示例](https://idraw.js.org/playground/)
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@idraw/renderer",
3
- "version": "0.2.0-alpha.22",
3
+ "version": "0.2.0-alpha.23",
4
4
  "description": "",
5
5
  "main": "dist/index.cjs.js",
6
6
  "module": "dist/index.es.js",
@@ -24,13 +24,13 @@
24
24
  "author": "chenshenhai",
25
25
  "license": "MIT",
26
26
  "devDependencies": {
27
- "@idraw/types": "^0.2.0-alpha.22"
27
+ "@idraw/types": "^0.2.0-alpha.23"
28
28
  },
29
29
  "dependencies": {
30
- "@idraw/util": "^0.2.0-alpha.22"
30
+ "@idraw/util": "^0.2.0-alpha.23"
31
31
  },
32
32
  "publishConfig": {
33
33
  "access": "public"
34
34
  },
35
- "gitHead": "884153bfe050aee75f4d132316db3bb750371375"
35
+ "gitHead": "aa224a92b784315735075c8fefcf1222d228ebc8"
36
36
  }