4a3ce4cc1d
Add comprehensive reference documentation for: - Vitest: environments, projects/workspaces, type testing, vi utilities - Pinia: HMR, Nuxt integration, SSR setup - Vue: built-in components (Transition, Teleport, Suspense, KeepAlive) and advanced directives
54 lines
959 B
Markdown
54 lines
959 B
Markdown
---
|
|
category: '@Integrations'
|
|
---
|
|
|
|
# useQRCode
|
|
|
|
Wrapper for [`qrcode`](https://github.com/soldair/node-qrcode).
|
|
|
|
## Install
|
|
|
|
```bash
|
|
npm i qrcode@^1
|
|
```
|
|
|
|
## Usage
|
|
|
|
```ts
|
|
import { useQRCode } from '@vueuse/integrations/useQRCode'
|
|
|
|
// `qrcode` will be a ref of data URL
|
|
const qrcode = useQRCode('text-to-encode')
|
|
```
|
|
|
|
or passing a `ref` to it, the returned data URL ref will change along with the source ref's changes.
|
|
|
|
```ts
|
|
import { useQRCode } from '@vueuse/integrations/useQRCode'
|
|
import { shallowRef } from 'vue'
|
|
|
|
const text = shallowRef('text-to-encode')
|
|
const qrcode = useQRCode(text)
|
|
```
|
|
|
|
```html
|
|
<input v-model="text" type="text" />
|
|
<img :src="qrcode" alt="QR Code" />
|
|
```
|
|
|
|
## Type Declarations
|
|
|
|
```ts
|
|
/**
|
|
* Wrapper for qrcode.
|
|
*
|
|
* @see https://vueuse.org/useQRCode
|
|
* @param text
|
|
* @param options
|
|
*/
|
|
export declare function useQRCode(
|
|
text: MaybeRefOrGetter<string>,
|
|
options?: QRCode.QRCodeToDataURLOptions,
|
|
): ShallowRef<string, string>
|
|
```
|