QR Code Scanner

A QR code scanner that works on both iOS and Android by natively embedding the platform view within Flutter. The integration with Flutter is seamless, much better than jumping into a native Activity or a ViewController to perform the scan.

Screenshots

Android

iOS

Get Scanned QR Code

When a QR code is recognized, the text identified will be set in 'qrText'.

class _QRViewExampleState extends State<QRViewExample> {
  final GlobalKey qrKey = GlobalKey(debugLabel: 'QR');
  var qrText = "";
  QRViewController controller;
  StreamController<bool> permissionController = StreamController<bool>();

  @override
  void initState() {
    super.initState();
    permissionController.stream.listen((isPermissionGrantedEvent) {
        setState(() {
          final isPermissionGranted = isPermissionGrantedEvent;
        });
    });
  }

  @override
  Widget build(BuildContext context) {
    return Scaffold(
      body: Column(
        children: <Widget>[
          Expanded(
            flex: 5,
            child: QRView(
              key: qrKey,
              onQRViewCreated: _onQRViewCreated,
              permissionStreamSink: permissionController.sink,
            ),
          ),
          Expanded(
            flex: 1,
            child: Center(
              child: Text('Scan result: $qrText'),
            ),
          )
        ],
      ),
    );
  }

  void _onQRViewCreated(QRViewController controller) {
    this.controller = controller;
    controller.scannedDataStream.listen((scanData) {
      setState(() {
        qrText = scanData;
      });
    });
  }

  @override
  void dispose() {
    controller?.dispose();
    super.dispose();
  }
}

iOS Integration

In order to use this plugin, add the following to your Info.plist file:

<key>io.flutter.embedded_views_preview</key>
<true/>

Flip Camera (Back/Front)

The default camera is the back camera.

controller.flipCamera();

Flash (Off/On)

By default, flash is OFF.

controller.toggleFlash();

Resume/Pause

Pause camera stream and scanner.

controller.pause();

Resume camera stream and scanner.

controller.resume();

Open application permission settings (only for Android)

Pause camera stream and scanner.

controller.openPermissionSettings();

Extra camera permission check

Subscribe on permissionStream to get know if permission is still granted

permissionController.stream.listen((isPermissionGrantedEvent) {
      setState(() {
        final isPermissionGranted = isPermissionGrantedEvent;
        //todo react on camera permission changes
      });
    });

TODO'S:

iOS Native embedding is written to match what is supported in the framework as of the date of publication of this package. It needs to be improved as the framework support improves.
In future, options will be provided for default states.
Finally, I welcome PR's to make it better :), thanks

Credits

Android: https://github.com/zxing/zxing
iOS: https://github.com/mikebuss/MTBBarcodeScanner
Special Thanks To: LeonDevLifeLog for his contributions towards improving this package.

Windmill-hq / qr_code_scanner