# QR Code

URL: https://ark-ui.com/docs/components/qr-code
Source: https://raw.githubusercontent.com/chakra-ui/ark/refs/heads/main/website/src/content/pages/components/qr-code.mdx

A component that generates a QR code based on the provided data.

---

<ComponentPreview id="QrCode" />

## Anatomy

<Anatomy id="qr-code" />

```tsx
<QrCode.Root>
  <QrCode.Frame>
    <QrCode.Pattern />
  </QrCode.Frame>
  <QrCode.Overlay />
  <QrCode.DownloadTrigger />
</QrCode.Root>
```

## Examples

**Example: basic**

```ripple
import { QrCode } from 'ark-ripple/qr-code';
import styles from 'styles/qr-code.module.css';

export component Basic() {
  <QrCode.Root class={styles.Root} defaultValue="http://ark-ui.com">
    <QrCode.Frame class={styles.Frame}>
      <QrCode.Pattern class={styles.Pattern} />
    </QrCode.Frame>
  </QrCode.Root>
}

```

### With Overlay

You can also add a logo or overlay to the QR code. This is useful when you want to brand the QR code.

**Example: overlay**

```ripple
import { QrCode } from 'ark-ripple/qr-code';
import styles from 'styles/qr-code.module.css';

export component Overlay() {
  <QrCode.Root class={styles.Root} defaultValue="http://ark-ui.com" encoding={{ ecc: 'H' }}>
    <QrCode.Frame class={styles.Frame}>
      <QrCode.Pattern class={styles.Pattern} />
    </QrCode.Frame>
    <QrCode.Overlay class={styles.Overlay}>
      <img src="https://ark-ui.com/icon-192.png" alt="Ark UI Logo" />
    </QrCode.Overlay>
  </QrCode.Root>
}

```

### Error Correction

In cases where the link is too long or the logo overlay covers a significant area, the error correction level can be
increased.

Use the `encoding.ecc` or `encoding.boostEcc` property to set the error correction level:

- `L`: Allows recovery of up to 7% data loss (default)
- `M`: Allows recovery of up to 15% data loss
- `Q`: Allows recovery of up to 25% data loss
- `H`: Allows recovery of up to 30% data loss

**Example: error-correction**

```ripple
import { QrCode } from 'ark-ripple/qr-code';
import { RadioGroup } from 'ark-ripple/radio-group';
import { track } from 'ripple';
import styles from 'styles/qr-code.module.css';
import radio from 'styles/radio-group.module.css';

export component ErrorCorrection() {
  let errorLevel = track('L');

  <div class="stack">
    <QrCode.Root
      class={styles.Root}
      defaultValue="http://ark-ui.com"
      encoding={{ ecc: errorLevel }}
    >
      <QrCode.Frame class={styles.Frame}>
        <QrCode.Pattern class={styles.Pattern} />
      </QrCode.Frame>
    </QrCode.Root>
    <RadioGroup.Root
      class={radio.Root}
      defaultValue="L"
      orientation="horizontal"
      onValueChange={(e) => {
        @errorLevel = e.value;
      }}
    >
      <div class="hstack">
        for (const level of ['L', 'M', 'Q', 'H']; key level) {
          <RadioGroup.Item class={radio.Item} value={level}>
            <RadioGroup.ItemControl class={radio.ItemControl} />
            <RadioGroup.ItemText class={radio.ItemText}>{level}</RadioGroup.ItemText>
            <RadioGroup.ItemHiddenInput />
          </RadioGroup.Item>
        }
      </div>
    </RadioGroup.Root>
  </div>
}

```

### Root Provider

An alternative way to control the QR code is to use the `RootProvider` component and the `useQrCode` hook. This way you
can access the state and methods from outside the component.

**Example: root-provider**

```ripple
import { QrCode, useQrCode } from 'ark-ripple/qr-code';
import styles from 'styles/qr-code.module.css';

export component RootProvider() {
  const qrCode = useQrCode({ value: 'http://ark-ui.com' });

  <div class="stack">
    <QrCode.RootProvider class={styles.Root} value={qrCode}>
      <QrCode.Frame class={styles.Frame}>
        <QrCode.Pattern class={styles.Pattern} />
      </QrCode.Frame>
    </QrCode.RootProvider>
    <output>{@qrCode.value}</output>
  </div>
}

```

### Download

Use the `QrCode.DownloadTrigger` component to allow users to download the QR code as an image. Specify the `fileName`
and `mimeType` props for the downloaded file.

**Example: download**

```ripple
import { QrCode } from 'ark-ripple/qr-code';
import button from 'styles/button.module.css';
import styles from 'styles/qr-code.module.css';

export component Download() {
  <QrCode.Root class={styles.Root} defaultValue="http://ark-ui.com">
    <QrCode.Frame class={styles.Frame}>
      <QrCode.Pattern class={styles.Pattern} />
    </QrCode.Frame>
    <QrCode.DownloadTrigger class={button.Root} fileName="qr-code.png" mimeType="image/png">
      {'Download'}
    </QrCode.DownloadTrigger>
  </QrCode.Root>
}

```

## API Reference

### Props

**Component API Reference**

**Root Props:**

| Prop | Type | Required | Description |
|------|------|----------|-------------|
| `asChild` | `boolean` | No | Use the provided child element as the default rendered element, combining their props and behavior. |
| `defaultValue` | `string` | No | The initial value to encode when rendered.
Use when you don't need to control the value of the qr code. |
| `encoding` | `QrCodeGenerateOptions` | No | The qr code encoding options. |
| `id` | `string` | No | The unique identifier of the machine. |
| `ids` | `Partial<{ root: string; frame: string }>` | No | The element ids. |
| `onValueChange` | `(details: ValueChangeDetails) => void` | No | Callback fired when the value changes. |
| `pixelSize` | `number` | No | The pixel size of the qr code. |
| `value` | `string` | No | The controlled value to encode. |


**Root CSS Variables:**

| Variable | Description |
|----------|-------------|
| `--qrcode-pixel-size` | The size of the Root |
| `--qrcode-width` | The width of the Root |
| `--qrcode-height` | The height of the Root |


**DownloadTrigger Props:**

| Prop | Type | Required | Description |
|------|------|----------|-------------|
| `fileName` | `string` | Yes | The name of the file. |
| `mimeType` | `DataUrlType` | Yes | The mime type of the image. |
| `asChild` | `boolean` | No | Use the provided child element as the default rendered element, combining their props and behavior. |
| `quality` | `number` | No | The quality of the image. |


**Frame Props:**

| Prop | Type | Required | Description |
|------|------|----------|-------------|
| `asChild` | `boolean` | No | Use the provided child element as the default rendered element, combining their props and behavior. |


**Overlay Props:**

| Prop | Type | Required | Description |
|------|------|----------|-------------|
| `asChild` | `boolean` | No | Use the provided child element as the default rendered element, combining their props and behavior. |


**Pattern Props:**

| Prop | Type | Required | Description |
|------|------|----------|-------------|
| `asChild` | `boolean` | No | Use the provided child element as the default rendered element, combining their props and behavior. |


**RootProvider Props:**

| Prop | Type | Required | Description |
|------|------|----------|-------------|
| `value` | `UseQrCodeReturn` | Yes |  |
| `asChild` | `boolean` | No | Use the provided child element as the default rendered element, combining their props and behavior. |


### Context

**API:**

| Property | Type | Description |
|----------|------|-------------|
| `value` | `string` | The value to encode. |
| `setValue` | `(value: string) => void` | Set the value to encode. |
| `getDataUrl` | `(type: DataUrlType, quality?: number) => Promise<string>` | Returns the data URL of the qr code. |