For AI agents: the complete documentation index is available at /next/llms.txt, the full documentation bundle is available at /next/llms-full.txt, and this page is available as Markdown at /next/api/packages/qrcode-rsbuild-plugin/interfaces/PluginQRCodeOptions.md.
Lynx
  • English
  • Interface: PluginQRCodeOptions

    The options for pluginQRCode.

    Properties

    fullscreen?

    optional fullscreen?: boolean

    Opt in to the fullscreen variant of the Lynx bundle URL (appends ?fullscreen=true, opening the bundle in LynxExplorer with the in-app navigation chrome stripped).

    When enabled, the plugin:

    • Appends a fullscreen entry to the schema rotation — the QR keeps opening on your default schema; press a in the dev console to switch to the fullscreen variant.
    • Appends an ∟ Fullscreen URL line under each Lynx bundle URL printed by the dev server.

    Default Value

    false


    schema?

    optional schema?: CustomizedSchemaFn

    Customize the generated schema.

    Examples

    import { pluginQRCode } from '@lynx-js/qrcode-rsbuild-plugin'
    import { pluginReactLynx } from '@lynx-js/react-rsbuild-plugin'
    import { defineConfig } from '@rsbuild/core'
    
    export default defineConfig({
      plugins: [
        pluginReactLynx(),
        pluginQRCode({
          schema(url) {
            return `lynx://${url}?dev=1`
          },
        }),
      ],
    })
    • Use multiple schemas:

    You may press a in the terminal to switch between schemas.

    import { pluginQRCode } from '@lynx-js/qrcode-rsbuild-plugin'
    import { pluginReactLynx } from '@lynx-js/react-rsbuild-plugin'
    import { defineConfig } from '@rsbuild/core'
    
    export default defineConfig({
      plugins: [
        pluginReactLynx(),
        pluginQRCode({
          schema(url) {
            return {
              http: url,
              foo: `foo://lynx?url=${encodeURIComponent(url)}&dev=1`,
              bar: `bar://lynx?url=${encodeURIComponent(url)}`,
            }
          },
        }),
      ],
    })
    Except as otherwise noted, this work is licensed under a Creative Commons Attribution 4.0 International License, and code samples are licensed under the Apache License 2.0.