Mixins / foldkit-mixins-ui

QrCodeView

interface · packages/mixins-ui/src/qrCode.ts:171

interface QrCodeView<Message> {
  readonly id: string
  readonly value: string
  readonly label?: string | undefined
  readonly level?: Level | undefined
  readonly quietZone?: number | undefined
  readonly overlay?: Html | undefined
  readonly tooLong?: string | undefined
  readonly style?: NamedStyle<typeof QrCodeSlots> | undefined
  readonly mixins?: MixinList<Message> | undefined
}

Members

QrCodeView.id

property · packages/mixins-ui/src/qrCode.ts:173

readonly id: string

Prefixes the ids the code draws, unique on the page; Download finds the code by it.

QrCodeView.value

property · packages/mixins-ui/src/qrCode.ts:175

readonly value: string

The text encoded: a URL, a contact, any string.

QrCodeView.label

property · packages/mixins-ui/src/qrCode.ts:177

readonly label?: string | undefined

What the code holds, said aloud; default QR code: and the value.

QrCodeView.level

property · packages/mixins-ui/src/qrCode.ts:179

readonly level?: Level | undefined

The error correction; default M, and H when there is an overlay to cover.

QrCodeView.quietZone

property · packages/mixins-ui/src/qrCode.ts:181

readonly quietZone?: number | undefined

The light margin around the code, in modules; default the standard's 4.

QrCodeView.overlay

property · packages/mixins-ui/src/qrCode.ts:183

readonly overlay?: Html | undefined

Drawn over the centre, such as a logo.

QrCodeView.tooLong

property · packages/mixins-ui/src/qrCode.ts:185

readonly tooLong?: string | undefined

Said in place of the code when the value is too long; default Too long for a QR code.

QrCodeView.style

property · packages/mixins-ui/src/qrCode.ts:187

readonly style?: NamedStyle<typeof QrCodeSlots> | undefined

A style of QrCodeSlots, for the look.

QrCodeView.mixins

property · packages/mixins-ui/src/qrCode.ts:189

readonly mixins?: MixinList<Message> | undefined

Mixins beside the style.