# QR Code (cf.cplace.qrCodeWidget)

## Overview

The QR Code app provides a widget that generates a QR code containing the URL of the embedding page. Users can scan this QR code with a mobile device to quickly access the page without manually typing the URL.

The widget uses the ZXing (Zebra Crossing) library for QR code generation with high error correction (Level H) to ensure readability even when a custom logo is overlaid.

## Dependencies

- **cf.cplace.platform** (cplace Basis) - Base platform, always installed

No additional apps are auto-installed with this app.

## Types Provided

This app does **not provide any types**. It is a widget-only app.

## Widgets Provided

| Widget | Widget Kind | Description | Use Case |
|--------|-------------|-------------|----------|
| QR Code | `cf.cplace.qrCodeWidget` | Creates a QR code from the URL of the embedding page | Mobile access, physical-digital integration, presentations |

### Widget Configuration: cf.cplace.qrCodeWidget

| Attribute | Type | Required | Description |
|-----------|------|----------|-------------|
| `title` | localizedString | No | Widget title |
| `height` | number | No | Widget height |
| `cf.cplace.qrCodeWidget.widgetConfig.showFrame` | boolean | Yes | Show widget frame |
| `cf.cplace.qrCodeWidget.widgetConfig.qrCodeSize` | number | Yes | Size of the QR code in pixels |
| `cf.cplace.qrCodeWidget.widgetConfig.color` | color | Yes | Color of the QR code |
| `cf.cplace.qrCodeWidget.widgetConfig.logo` | reference (default.file) | No | Logo file to display centered within the QR code |

## Use Cases

- **Mobile Access to Pages**: Enable quick access to cplace pages from mobile devices by scanning a QR code displayed on screen during presentations
- **Physical-Digital Integration**: Print QR codes for display in physical spaces (offices, warehouses, production floors) to link physical assets or locations to their corresponding digital pages
- **Meeting and Presentation Support**: Display QR codes during meetings so attendees can quickly access related pages without manually typing URLs
- **Asset and Inventory Tracking**: Generate QR codes for equipment, inventory items, or project assets; print and attach codes to physical items for quick lookups
- **Documentation and Reports**: Include QR codes in exported documents so readers can access the live, up-to-date page version

## Usage Notes

### When to Use
- URLs are long or difficult to type
- Users need mobile access to pages displayed on large screens
- Physical items need links to their digital records
- Quick touchless access is preferred

### Visual Customization
- **Size**: Adjustable for presentations (larger) or inline use (smaller)
- **Color**: Customizable for branding purposes
- **Logo**: Optional logo overlay for brand recognition
- **Frame**: Configurable widget frame display

### Error Correction
The widget uses Level H (highest) error correction, allowing approximately 30% data recovery. This ensures the QR code remains scannable even with:
- A centered logo overlay
- Partial damage
- Reduced print quality

## Investigation Details

- **Investigation Date**: 2026-02-02
- **Investigation Workspace**: `[App Investigation] cf.cplace.qrCodeWidget` (ID: 9ax8x8lcp8ylosy7n63joxsor)
- **Apps Installed After**: cf.cplace.platform, cf.cplace.qrCodeWidget
- **Types Added**: None (widget-only app)
