@idraw/renderer - npm Package Compare versions

Comparing version 0.2.0-alpha.22 to 0.2.0-alpha.23

package.json

 {
   "name": "@idraw/renderer",
-  "version": "0.2.0-alpha.22",
+  "version": "0.2.0-alpha.23",
   "description": "",
@@ -27,6 +27,6 @@ "main": "dist/index.cjs.js",
   "devDependencies": {
-    "@idraw/types": "^0.2.0-alpha.22"
+    "@idraw/types": "^0.2.0-alpha.23"
   },
   "dependencies": {
-    "@idraw/util": "^0.2.0-alpha.22"
+    "@idraw/util": "^0.2.0-alpha.23"
   },
@@ -36,3 +36,3 @@ "publishConfig": {
   },
-  "gitHead": "884153bfe050aee75f4d132316db3bb750371375"
+  "gitHead": "aa224a92b784315735075c8fefcf1222d228ebc8"
 }

README.md

 # @idraw/renderer
 
-[![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)
+[![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)
+
+
+## Usage
+
+### Quick Start
+
+```sh
+npm i @idraw/renderer
+```
+
+```js
+import Renderer from '@idraw/renderer';
+
+const renderer = new Renderer({
+  width: 600,
+  height: 400,
+  contextWidth: 600,
+  contextHeight: 400,
+  devicePixelRatio: 1,
+});
+
+const canvas = document.querySelector('canvas');
+renderer.render(canvas, {
+  elements: [
+    {
+      name: "rect-001",
+      x: 10,
+      y: 10,
+      w: 200,
+      h: 100,
+      type: "rect",
+      desc: {
+        bgColor: "#f0f0f0",
+        borderRadius: 20,
+        borderWidth: 10,
+        borderColor: "#bd0b64",
+      },
+    },
+  ]
+})
+
+```
+
+### Events
+
+```js
+renderer.on('load', (e) => {
+  // ...
+})
+renderer.on('loadComplete', (e) => {
+  // ...
+})
+
+renderer.on('drawFrame', (e) => {
+  // ...
+})
+renderer.on('drawFrameComplete', (e) => {
+  // ...
+})
+```
+
+## Documents
+
+- [Documents](https://idraw.js.org/docs/en/) | [中文文档](https://idraw.js.org/docs/zh/) 
+- [Online Playground](https://idraw.js.org/playground/) | [在线API示例](https://idraw.js.org/playground/)

Fixed alerts

Deprecated

Maintenance

The maintainer of the package marked it as deprecated. This could indicate that a single version should not be used, or that the package is no longer maintained and any new vulnerabilities will not be fixed.

Found 1 instance in 1 package

Improved metrics

Total package byte prevSize

218463

increased by0.47%

Number of medium maintenance alerts

0

decreased by-100%

Number of lines in readme file

68

increased by2166.67%

Dependency changes

• Updated@idraw/util@^0.2.0-alpha.23