Skip to content

Add QR Code documentation and samples #541

Description

@simeonoff

Task type

  • New topic / component documentation
  • Update existing topic (new release, API change, new feature)
  • Add missing platform variant (Angular / React / WebComponents / Blazor)
  • Improve existing content (clarity, examples, structure)
  • Add or update code samples
  • Other

Platform(s)

  • Angular
  • React
  • WebComponents
  • Blazor
  • All platforms

Description

Add documentation and live samples for the new Ignite UI for Web Components QR Code, IgcQrCodeComponent / <igc-qr-code>, introduced in igniteui-webcomponents 7.3.0.

Create a platform topic under Data Entry & Display that covers:

  • installation, component registration, and generating a QR code from value;
  • automatic numeric, alphanumeric, and byte encoding;
  • automatic or explicit QR version and error-level configuration;
  • rendered size and quiet-zone margin;
  • optional branding with logo-src, logo-size, and logo-margin, including the automatic error-correction behavior;
  • dot-style and square-style customization;
  • accessible labeling;
  • styling with the QR Code CSS custom properties and exposed CSS parts.

Add corresponding runnable samples to IgniteUI/igniteui-wc-examples (et. al) and embed them in the topic. The sample set should include a basic QR Code plus focused examples for logos, shape options, sizing, and custom colors.

Acceptance criteria

  • A new QR Code overview topic is added to the xplat documentation with complete SEO/LLM frontmatter.
  • The topic is visible for all platforms in the Data Entry & Display navigation and is marked as new.
  • Getting Started shows installation, import/registration, and minimal <igc-qr-code> usage.
  • The topic documents encoding, version/error correction, size/margin, logos, shape options, accessible labeling, and styling.
  • Runnable platform samples are added to IgniteUI/igniteui-wc-examples (et. al), including basic, logo, shape/sizing, and custom-color scenarios.
  • Every embedded sample renders a scannable code, loads successfully in the Web Components docs, and exposes its source in the live editor.
  • API links/references resolve to IgcQrCodeComponent and the public QR Code types.
  • Web Components documentation generation/build, Markdown linting, spellcheck, and link checks pass.

Related resources

Activity

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Metadata

Metadata

Assignees

Type

Projects

No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions