QR Code
Renders a scannable QR code from any string client-side with no npm dependency, themed via currentColor.
Preview
Controls
Device view renders in an isolated frame so real responsive breakpoints apply. Switch to Full for overflowing popovers.
Installation
php artisan ui:add qr-code
Behavior layer (Alpine)
This component installs a self-registering Alpine module to
resources/js/ui/qr-code.js. Import the behavior layer once
from your bundle so it loads (it hooks alpine:init):
import './qr-code.js';
Registry contract
Install confidence
php artisan ui:add qr-code
writes only the generated targets below. The CLI validates each file hash before writing and
prompts before replacing local changes unless --force is used.
- Version
- 1.0.1
- License
- open
- Stability
- stable
- Contract
- v2
- Foundation
- ≥ 1.0.0
| Type | Generated target |
|---|---|
| blade | resources/views/components/ui/qr-code.blade.php |
| js | resources/js/ui/qr-code.js |
Registry dependencies
None.
Package dependencies
composer: jml/brok:^1.0
npm: alpinejs
Guidance
Media selection and presentationSelect, preview, or compare visual media.
Use when
- Use when image or video selection, preview, or media-based comparison is part of the task. Do not require media-heavy interaction when a simpler text or list solution would be faster.
Avoid when
- Avoid using qr-code as a default simply because it is available in the library. Choose it only when its interaction cost, visibility, and behavior match the job to be done.
- Task length
- medium
- Interaction cost
- high
- Interruptiveness
- none
- Input precision
- none
- Mobile / touch risk
- high
- Accessibility risk
- high
- Needs background context
- No
- Comparison needed
- Yes
Preferred alternatives
- Text or list representation
Anti-patterns
- Requiring media-heavy interaction when text is faster
API
manifest knowledge + registry-derived coverageProps
| Prop | Type / values | Default | Description |
|---|---|---|---|
| value | string | Declared by @props in the registry Blade source. | |
| size | int | 160 | Declared by @props in the registry Blade source. |
| level | string | M | Declared by @props in the registry Blade source. |
| margin | int | 4 | Declared by @props in the registry Blade source. |
| fg | mixed|null | null | Declared by @props in the registry Blade source. |
| bg | mixed|null | null | Declared by @props in the registry Blade source. |
| label | string | QR code | Declared by @props in the registry Blade source. |
Slots
Components use the default Blade slot unless a documented subcomponent is installed by the registry item.
Data slots
qr-code
Capabilities
Behavior
- Uses server-rendered Blade and semantic HTML.
- Installs a JavaScript behavior module when the registry item includes resources/js/ui files.
- Declares registry capability flags: a11y, interactive, responsive, rtl, darkMode, localized.
Usage
<x-ui.qr-code value="https://brok.dev" :size="180" />
Accessibility & localization
data-slot
Keyboard focus-visible
Localized labels
- Accessibility target: wcag-2.2-aa-target.
- Uses semantic HTML and a stable
data-slotattribute for styling/scripting hooks. - Focus-visible rings use the
ringtoken so keyboard focus is always visible. - Disabled and invalid states are conveyed to assistive tech, not by color alone.
- Targets WCAG 2.2 AA; verify contrast in light, dark, admin and customer surfaces above.
- Labels go through
__()and the component uses logical properties (ms-*,text-start,start-*) so it mirrors correctly — flip the preview to RTL to confirm.
Source
The exact, editable file ui:add writes
into your app — copy it or own the whole thing. Previews
render this same code; there are no preview-only components.
Changelog
Current version: v1.0.1. See the site changelog for the full release history.