ebs_qrcode 0.2.1

A customizable, cross-platform QR / barcode scanner widget for Flutter with a modern viewfinder, flash, camera flip, scan-from-gallery, and a configurable branding footer.

ebs_qrcode

A highly customisable, cross-platform QR & barcode scanner widget for Flutter.
Modern viewfinder · flash · camera flip · scan-from-gallery · configurable branding footer.

---

✨ Why ebs_qrcode?

Drop a beautiful, full-screen scanner into your app in one line — then customise every pixel when you need to. Built on the battle-tested mobile_scanner, with a modern overlay, animated scan line, and a branding footer, all out of the box.

• 📷 QR & barcodes — scan QR codes and 1D/2D barcodes (EAN, UPC, Code128, and more).
• 🎨 Highly customisable — colours, cut-out size/shape/position, scan line, labels, and control icons.
• 🖼️ Scan from gallery — decode a code from an existing image.
• 🔦 Flash, flip & gallery controls — swap the icon or replace the whole widget while keeping the action wired.
• 🏷️ Branding footer — app logo + name and a "Powered by …" line, with logos in any format (SVG / PNG / JPEG / network / custom widget).
• ⚡ Lightweight & fast — a thin, well-documented layer with sensible defaults.

📱 Platforms

Android	iOS	macOS	Web
✅	✅	✅	✅

Camera + gallery availability follows the underlying mobile_scanner / image_picker support for each platform.

🚀 Getting started

Add the dependency:

dependencies:
  ebs_qrcode: ^0.2.0

flutter pub add ebs_qrcode

Permissions

• iOS — add to Info.plist:
  • NSCameraUsageDescription — "Used to scan QR codes and barcodes."
  • NSPhotoLibraryUsageDescription — "Used to scan a code from a photo." (gallery scanning)
• Android — the plugins declare the CAMERA permission via manifest merge; use minSdkVersion 21+.

⚡ Quick start

Push the scanner and await the decoded value:

import 'package:ebs_qrcode/ebs_qrcode.dart';

final code = await EbsQrScanner.scan(context);
if (code != null) {
  debugPrint('Scanned: $code');
}

Customise it:

final code = await EbsQrScanner.scan(
  context,
  config: const EbsQrConfig(
    title: 'Scan to sign in',
    accentColor: Color(0xFF3BBCE5),
    formats: [BarcodeFormat.qrCode],
    showFlip: false,
  ),
);

Embed it and control navigation yourself:

EbsQrScanner(
  config: const EbsQrConfig(instruction: 'Point at a barcode'),
  onDetect: (value) => debugPrint('Scanned: $value'),
);

🏷️ Branding footer

Add a polished branding line — your app logo + name on the left and a "Powered by …" on the right — with EbsBrandingFooter:

EbsQrConfig(
  footer: EbsBrandingFooter(
    appLogo: EbsBrandAsset.asset('assets/logo/app_logo.svg'), // any format
    appName: 'CodeBook',
    // The "Powered by" side is a sensible default; override to re-brand:
    // companyName: 'Acme Inc',
    // companyLogo: EbsBrandAsset.asset('assets/acme.png'),
    // showPoweredBy: false, // …or hide it entirely
  ),
);

EbsBrandAsset renders a logo from any source, at any size:

EbsBrandAsset.asset('assets/logo.svg', height: 20);   // auto-detects SVG/raster
EbsBrandAsset.asset('assets/logo.png', height: 20, color: Colors.white);
EbsBrandAsset.networkAuto('https://example.com/logo.svg');
EbsBrandAsset.custom(const FlutterLogo());

SVG rendering is powered by flutter_svg.

🎛️ Custom controls (flash / gallery / flip)

Swap just the icon — the quickest option:

EbsQrConfig(
  flashOnIcon: Icons.flashlight_on_rounded,
  flashOffIcon: Icons.flashlight_off_rounded,
  galleryIcon: Icons.image_outlined,
  flipIcon: Icons.cameraswitch_outlined,
);

Replace the whole widget — supply your own button; the scanner keeps wiring the action:

EbsQrConfig(
  // Flash builder receives the live on/off state + a toggle callback.
  flashButtonBuilder: (context, isOn, toggle) => IconButton.filled(
    onPressed: toggle,
    icon: Icon(isOn ? Icons.flash_on : Icons.flash_off),
  ),
  // Gallery / flip builders receive just the action callback.
  galleryButtonBuilder: (context, onTap) =>
      TextButton(onPressed: onTap, child: const Text('Upload')),
  flipButtonBuilder: (context, onTap) => FloatingActionButton.small(
    onPressed: onTap,
    child: const Icon(Icons.cameraswitch),
  ),
);

🔧 Configuration reference (EbsQrConfig)

Group	Fields
Text	title, instruction, galleryLabel, noCodeFoundMessage, imageErrorMessage
Colours	accentColor, scrimColor, borderColor, backgroundColor, foregroundColor
Cut-out	cutOutSizeFactor, cutOutMinSize, cutOutMaxSize, cutOutRadius, cutOutCenterYFactor
Toggles	showFlash, showGallery, showFlip, showScanLine
Control icons	flashOnIcon, flashOffIcon, galleryIcon, flipIcon
Control widgets	flashButtonBuilder, galleryButtonBuilder, flipButtonBuilder
Branding	footer (see EbsBrandingFooter)
Scanning	formats, initialCameraFacing

Every field has a sensible default — const EbsQrConfig() gives a polished scanner out of the box.

🧑‍💻 Full example

See a fully-customised scanner (theming, cut-out geometry, format restriction, re-branded footer, and all three control builders) in example/lib/fully_custom.dart, and a minimal one in example/lib/main.dart.

🗺️ Roadmap

• ❌ Haptic / sound feedback on detect
• ❌ Pinch-to-zoom & tap-to-focus
• ❌ Multi-code detection callback
• ❌ Built-in result sheet with copy / share

Have an idea? Open an issue 💬

🤝 Contributing & collaboration

Contributions of every size are welcome and appreciated — this package grows with its community.

• 🐛 Found a bug? Open an issue with steps to reproduce.
• 💡 Have an idea? Start a discussion or open a feature-request issue.
• 🔧 Want to code? Fork the repo, create a branch, and send a PR — see below.
• ⭐ Like it? A pub.dev like and a GitHub star help others find it.

git clone https://github.com/ashiq-kodali/ebs_qrcode.git
cd ebs_qrcode
flutter pub get
flutter analyze && dart format --set-exit-if-changed .

Please keep PRs focused, run the analyzer/formatter, and update the CHANGELOG.md. Looking for a maintainer or co-author? I'm actively open to collaboration — reach out below. 🙌

👋 Author's note

Hi, I'm Ashiq Kodali — I built ebs_qrcode while working on real production apps at Ebsor Infosystem, because every project seemed to re-implement the same scanner UI from scratch. The goal here is a scanner that looks great by default, yet bends to your brand without fighting the framework.

If this package saved you time, I'd love to hear about it — and if you'd like to help shape where it goes next, let's build it together.

• 📧 Email: [e-mail]
• 🐙 GitHub: @ashiq-kodali
• 🏢 Ebsor Infosystem

📄 License

Released under the MIT License — free for personal and commercial use.

_{Made with 💙 for the Flutter community by Ebsor Infosystem.}