---
title: QRCode
description: Displays a scannable QR code representing data such as URLs or text. Use to let users quickly access information by scanning with a smartphone or other device.
api_version: 2025-10
api_name: checkout-ui-extensions
source_url:
  html: https://shopify.dev/docs/api/checkout-ui-extensions/latest/polaris-web-components/other/qrcode
  md: https://shopify.dev/docs/api/checkout-ui-extensions/latest/polaris-web-components/other/qrcode.md
---

# QRCode

Displays a scannable QR code representing data such as URLs or text. Use to let users quickly access information by scanning with a smartphone or other device.

## Properties

* accessibilityLabel

  string

  Default: 'QR code' (translated to the user's locale)

  A label that describes the purpose or contents of the QR code. When set, it will be announced to users using assistive technologies and will provide more context about what the QR code may do when scanned.

* border

  'base' | 'none'

  Default: 'base'

  Set the border of the QR code.

  `base`: applies border that is appropriate for the element. `none`: removes the border from the element.

* content

  string

  The content to be encoded in the QR code, which can be any string such as a URL, email address, plain text, etc. Specific string formatting can trigger actions on the user's device when scanned, like opening geolocation coordinates on a map, opening a preferred app or app store entry, preparing an email, text message, and more.

* id

  string

  A unique identifier for the element.

* logo

  string

  URL of an image to be displayed in the center of the QR code. This is useful for branding or to indicate to the user what scanning the QR code will do. By default, no image is displayed.

* onError

  (event: Event) => void

  Invoked when the conversion of `content` to a QR code fails. If an error occurs, the QR code and its child elements will not be displayed.

* size

  'base' | 'fill'

  Default: 'base'

  The displayed size of the QR code.

  `fill`: the QR code will takes up 100% of the available inline-size and maintain a 1:1 aspect ratio. `base`: the QR code will be displayed at its default size.

## Events

* error

  ((event: CallbackEventListener\<typeof tagName>) => void) | null

  Invoked when the conversion of `content` to a QR code fails. If an error occurs, the QR code and its child elements will not be displayed.

### CallbackEventListener

```ts
(EventListener & {
    (event: CallbackEvent<TTagName, TEvent>): void;
}) | null
```

### CallbackEvent

```ts
TEvent & {
    currentTarget: HTMLElementTagNameMap[TTagName];
}
```

### Examples

* #### Code

  ##### Default

  ```html
  <s-qr-code content="https://shopify.com"></s-qr-code>
  <s-paragraph>
    Scan to visit <s-link href="https://shopify.com">Shopify.com</s-link>
  </s-paragraph>
  ```

## Preview

![](https://shopify.dev/images/templated-apis-screenshots/checkout-ui-extensions/2025-10/qr-code-default.png)

## Best Practices

* Always test that the QR code is scannable from a smartphone.
* Include a square logo if that’s what your customers are familiar with.
* Increase usability by adding a text description of what the QR code does.
* Always provide an alternate method for customers to access the content of the QR code.
* If the content is a URL, provide a [`s-link`](https://shopify.dev/docs/api/checkout-ui-extensions/components/link) nearby.
* If the content is data, provide a [`s-button`](https://shopify.dev/docs/api/checkout-ui-extensions/components/button) to copy the data to the clipboard, or show the data in a readonly [`s-text-field`](https://shopify.dev/docs/api/checkout-ui-extensions/components/textfield).