Skip to content

Commit b6c14c4

Browse files
committed
fix: Fixed TypeScript type export error.
1 parent a064346 commit b6c14c4

File tree

5 files changed

+42
-3
lines changed

5 files changed

+42
-3
lines changed

CHANGELOG.md

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,9 @@
1+
## [3.4.1] - 2023-08-05
2+
3+
### BUGFIX
4+
5+
- Fixed TypeScript type export error.
6+
17
## [3.4.0] - 2023-04-15
28

39
### Performance

README-zh_cn.md

Lines changed: 16 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -67,6 +67,22 @@ createApp({
6767
</script>
6868
```
6969

70+
在 Vue 3 中配合 `TypeScript` 使用:
71+
72+
```html
73+
<template>
74+
<qrcode-vue :value="value" :level="level" :render-as="renderAs" />
75+
</template>
76+
77+
<script setup lang="ts">
78+
import { ref } from 'vue'
79+
import QrcodeVue, { Level, RenderAs } from 'qrcode.vue'
80+
81+
const value = ref<String>('qrcode')
82+
const level = ref<Level>('M')
83+
const renderAs = ref<RenderAs>('svg')
84+
</script>
85+
7086
## Component props
7187

7288
### `value`

README.md

Lines changed: 16 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -69,6 +69,22 @@ Or single-file components with a `*.vue` extension:
6969
</script>
7070
```
7171

72+
When you use the component with Vue 3 with `TypeScript`:
73+
74+
```html
75+
<template>
76+
<qrcode-vue :value="value" :level="level" :render-as="renderAs" />
77+
</template>
78+
<script setup lang="ts">
79+
import { ref } from 'vue'
80+
import QrcodeVue, { Level, RenderAs } from 'qrcode.vue'
81+
82+
const value = ref('qrcode')
83+
const level = ref<Level>('M')
84+
const renderAs = ref<RenderAs>('svg')
85+
</script>
86+
```
87+
7288
## Component props
7389

7490
### `value`

package.json

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
{
22
"name": "qrcode.vue",
3-
"version": "3.4.0",
3+
"version": "3.4.1",
44
"description": "A Vue.js component to generate QRCode.",
55
"type": "module",
66
"main": "./dist/qrcode.vue.cjs.js",

src/index.ts

Lines changed: 3 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,8 @@ import { defineComponent, h, onMounted, onUpdated, PropType, ref } from 'vue'
22
import QR from './qrcodegen'
33

44
type Modules = ReturnType<QR.QrCode['getModules']>
5-
type Level = 'L' | 'M' | 'Q' | 'H'
5+
export type Level = 'L' | 'M' | 'Q' | 'H'
6+
export type RenderAs = 'canvas' | 'svg'
67

78
const defaultErrorCorrectLevel = 'H'
89

@@ -104,7 +105,7 @@ const QRCodeProps = {
104105
const QRCodeVueProps = {
105106
...QRCodeProps,
106107
renderAs: {
107-
type: String as PropType<'canvas' | 'svg'>,
108+
type: String as PropType<RenderAs>,
108109
required: false,
109110
default: 'canvas',
110111
validator: (as: any) => ['canvas', 'svg'].indexOf(as) > -1,

0 commit comments

Comments
 (0)