chore(deps): update doc and upgrade deps.

Author: scopewu

CHANGELOG.md

@@ -1,3 +1,50 @@
+## [3.5.0] - 2024-09-26
+
+### Feature
+
+- Support logo image for Qrcode.
+- Exports separate `QrcodeCanvas` and `QrcodeSvg` components
+
+Direct references to `QrcodeVue` in common.js and cdn now require the `default` field:
+
+```js
+const QrcodeVue = require('qrcode.vue').default
+const { default: QrcodeVue, QrcodeCanvas, QrcodeSvg } = require('qrcode.vue')
+```
+
+```html
+<!--With HTML-->
+<div id="root">
+  <p class="flex space-x">
+  <qrcode-vue :value="test" render-as="svg"></qrcode-vue>
+<qrcode-canvas :value="test"></qrcode-canvas>
+<qrcode-svg :value="test" :image-settings="imageSettings"></qrcode-svg>
+</p>
+<p><input v-model="test" /></p>
+</div>
+<script src="https://cdn.jsdelivr.net/npm/vue@3.5/dist/vue.global.prod.js"></script>
+<script src="https://cdn.jsdelivr.net/npm/qrcode.vue@3.5/dist/qrcode.vue.browser.min.js"></script>
+
+<script>
+Vue.createApp({
+  data() { return {
+    test: 'Hello World',
+    imageSettings: {
+      src: 'https://avatars.githubusercontent.com/u/15811268',
+      width: 30,
+      height: 30,
+      excavate: true,
+    },
+  }},
+  components: {
+    QrcodeVue: QrcodeVue.default,
+    QrcodeCanvas: QrcodeVue.QrcodeCanvas,
+    QrcodeSvg: QrcodeVue.QrcodeSvg,
+  },
+}).mount('#root')
+</script>
+```
+
 ## [3.4.1] - 2023-08-05
 
 ### BUGFIX

README-zh_cn.md

@@ -180,6 +180,49 @@ createApp({
 
 传递给二维码根元素的类名。
 
+## `QrcodeVue` 3.5+
+
+`QrcodeVue` 3.5+ 后导出独立的 `QrcodeCanvas` 和 `QrcodeSvg` 组件，为此修改了 rollup 的配置：
+
+```
+// rollup.config.js
+
+-    exports: 'default',
++    exports: 'named',
+```
+
+
+现在在 common.js 和 cdn 直接引用 `QrcodeVue` 需要使用 `default` 字段：
+
+```js
+const QrcodeVue = require('qrcode.vue').default
+const { default: QrcodeVue, QrcodeCanvas, QrcodeSvg } = require('qrcode.vue')
+```
+```html
+<!--With HTML-->
+<div id="root">
+  <p class="flex space-x">
+  <qrcode-vue :value="test" render-as="svg"></qrcode-vue>
+<qrcode-canvas :value="test"></qrcode-canvas>
+</p>
+<p><input v-model="test" /></p>
+</div>
+<script src="https://cdn.jsdelivr.net/npm/vue@3.5/dist/vue.global.prod.js"></script>
+<script src="https://cdn.jsdelivr.net/npm/qrcode.vue@3.5/dist/qrcode.vue.browser.min.js"></script>
+
+<script>
+Vue.createApp({
+  data() { return {
+    test: 'Hello World',
+  }},
+  components: {
+    QrcodeVue: QrcodeVue.default,
+    QrcodeCanvas: QrcodeVue.QrcodeCanvas,
+  },
+}).mount('#root')
+</script>
+```
+
 ## 软件许可
 
 copyright &copy; 2021 scopewu, license by [MIT](https://github.com/scopewu/qrcode.vue/blob/main/LICENSE)

README.md

@@ -183,6 +183,48 @@ The settings to support qrcode image logo.
 
 The class name of qrcode element.
 
+## `QrcodeVue` 3.5+
+
+`QrcodeVue` 3.5+ exports separate `QrcodeCanvas` and `QrcodeSvg` components, for which the rollup configuration has been modified:
+
+```
+// rollup.config.js
+
+-    exports: 'default',
++    exports: 'named',
+```
+
+Direct references to `QrcodeVue` in common.js and cdn now require the `default` field:
+
+```js
+const QrcodeVue = require('qrcode.vue').default
+const { default: QrcodeVue, QrcodeCanvas, QrcodeSvg } = require('qrcode.vue')
+```
+```html
+<!--With HTML-->
+<div id="root">
+  <p class="flex space-x">
+  <qrcode-vue :value="test" render-as="svg"></qrcode-vue>
+<qrcode-canvas :value="test"></qrcode-canvas>
+</p>
+<p><input v-model="test" /></p>
+</div>
+<script src="https://cdn.jsdelivr.net/npm/vue@3.5/dist/vue.global.prod.js"></script>
+<script src="https://cdn.jsdelivr.net/npm/qrcode.vue@3.5/dist/qrcode.vue.browser.min.js"></script>
+
+<script>
+Vue.createApp({
+  data() { return {
+    test: 'Hello World',
+  }},
+  components: {
+    QrcodeVue: QrcodeVue.default,
+    QrcodeCanvas: QrcodeVue.QrcodeCanvas,
+  },
+}).mount('#root')
+</script>
+```
+
 ## License
 
 copyright &copy; 2021 @scopewu, license by [MIT](https://github.com/scopewu/qrcode.vue/blob/main/LICENSE)

package.json

@@ -21,13 +21,10 @@
     "dev": "rsbuild dev",
     "build": "rollup -c"
   },
-  "repository": {
-    "type": "git",
-    "url": "git+https://github.com/scopewu/qrcode.vue.git"
-  },
+  "repository": "https://github.com/scopewu/qrcode.vue.git",
   "keywords": [
     "vue",
-    "vue-component",
+    "vue qrcode",
     "component",
     "code",
     "qrcode",
@@ -51,10 +48,10 @@
   "dependencies": {},
   "devDependencies": {
     "@rollup/plugin-terser": "^0.4.4",
-    "@rsbuild/core": "^1.0.7",
-    "rollup": "^4.22.4",
+    "@rsbuild/core": "^1.0.14",
+    "rollup": "^4.24.0",
     "rollup-plugin-typescript2": "^0.36.0",
-    "typescript": "^5.6.2",
-    "vue": "^3.5.8"
+    "typescript": "^5.6.3",
+    "vue": "^3.5.12"
   }
 }