flutter_plugin_qr_scanner 0.0.1

  • Readme
  • Changelog
  • Example
  • Installing
  • new62

flutter_plugin_qr_scanner #

A QR code scanner flutter plugin project. Support iOS, Android.

Getting Started #

import 'package:flutter_plugin_qr_scanner/qrscanner.dart';

Future<void> initCodeState() async {
  String code;
  // Platform messages may fail, so we use a try/catch PlatformException.
  try {
    code = await QrScanner.scan(
      title: "scanner",
      laserColor: Colors.white, //default #ffff55ff
      playBeep: true, //default false
      promptMessage: "Point the QR code to the frame to complete the scan.",
      errorMsg: "Oops, something went wrong. You may need to check your permission of camera or restart the device.",
      permissionDeniedText: "Your privacy settings seem to prevent us from accessing your camera for barcode scanning. You can fix it by doing this, touch the OK button below to open the Settings and then turn the Camera on.",
      messageConfirmText: "OK",
      messageCancelText: "Cancel",
    );
  } on PlatformException {
    code = 'Failed to get qr code.';
  }

  // If the widget was removed from the tree while the asynchronous platform
  // message was in flight, we want to discard the reply rather than calling
  // setState to update our non-existent appearance.
  if (!mounted) return;

  setState(() {
    _code = code;
  });
}

For IOS #

You will need provide the description of camera's permission to work properly, otherwise will crash your app.

  <key>NSCameraUsageDescription</key>
	<string>The purpose that you use the camera</string>

0.0.1 #

  • TODO: Describe initial release.

example/lib/main.dart

import 'package:flutter/material.dart';
import 'dart:async';

import 'package:flutter/services.dart';
import 'package:flutter_plugin_qr_scanner/flutter_plugin_qr_scanner.dart';

void main() {
  runApp(MyApp());
}

class MyApp extends StatefulWidget {
  @override
  _MyAppState createState() => _MyAppState();
}

class _MyAppState extends State<MyApp> {
  String _code = 'Unknown';

  @override
  void initState() {
    super.initState();
    initCodeState();
  }

  // Platform messages are asynchronous, so we initialize in an async method.
  Future<void> initCodeState() async {
    String code;
    // Platform messages may fail, so we use a try/catch PlatformException.
    try {
      code = await QrScanner.scan(
        title: "scanner",
        laserColor: Colors.white, //default #ffff55ff
        playBeep: true, //default false
        promptMessage: "Point the QR code to the frame to complete the scan.",
        errorMsg: "Oops, something went wrong. You may need to check your permission of camera or restart the device.",
        permissionDeniedText: "Your privacy settings seem to prevent us from accessing your camera for barcode scanning. You can fix it by doing this, touch the OK button below to open the Settings and then turn the Camera on.",
        messageConfirmText: "OK",
        messageCancelText: "Cancel",
      );
    } on PlatformException {
      code = 'Failed to get qr code.';
    }

    // If the widget was removed from the tree while the asynchronous platform
    // message was in flight, we want to discard the reply rather than calling
    // setState to update our non-existent appearance.
    if (!mounted) return;

    setState(() {
      _code = code;
    });
  }

  @override
  Widget build(BuildContext context) {
    return MaterialApp(
      home: Scaffold(
        appBar: AppBar(
          title: const Text('Plugin example app'),
        ),
        body: Center(
          child: Column(
            mainAxisAlignment: MainAxisAlignment.center,
            children: <Widget>[
              Text('qrcode: $_code\n'),
              OutlineButton(
                child: Text('Start Scan'),
                onPressed: (){
                  initCodeState();
                },
              )
            ],
          ),
        ),
      ),
    );
  }
}

Use this package as a library

1. Depend on it

Add this to your package's pubspec.yaml file:


dependencies:
  flutter_plugin_qr_scanner: ^0.0.1

2. Install it

You can install packages from the command line:

with Flutter:


$ flutter pub get

Alternatively, your editor might support flutter pub get. Check the docs for your editor to learn more.

3. Import it

Now in your Dart code, you can use:


import 'package:flutter_plugin_qr_scanner/flutter_plugin_qr_scanner.dart';
  
Popularity:
Describes how popular the package is relative to other packages. [more]
38
Health:
Code health derived from static analysis. [more]
99
Maintenance:
Reflects how tidy and up-to-date the package is. [more]
70
Overall:
Weighted score of the above. [more]
62
Learn more about scoring.

We analyzed this package on Jul 8, 2020, and provided a score, details, and suggestions below. Analysis was completed with status completed using:

  • Dart: 2.8.4
  • pana: 0.13.14
  • Flutter: 1.17.5

Analysis suggestions

Package does not support Flutter platform linux

Because:

  • package:flutter_plugin_qr_scanner/flutter_plugin_qr_scanner.dart that declares support for platforms: android, ios

Package does not support Flutter platform macos

Because:

  • package:flutter_plugin_qr_scanner/flutter_plugin_qr_scanner.dart that declares support for platforms: android, ios

Package does not support Flutter platform web

Because:

  • package:flutter_plugin_qr_scanner/flutter_plugin_qr_scanner.dart that declares support for platforms: android, ios

Package does not support Flutter platform windows

Because:

  • package:flutter_plugin_qr_scanner/flutter_plugin_qr_scanner.dart that declares support for platforms: android, ios

Package not compatible with SDK dart

Because:

  • flutter_plugin_qr_scanner that is a package requiring null.

Health issues and suggestions

Document public APIs. (-1 points)

14 out of 14 API elements have no dartdoc comment.Providing good documentation for libraries, classes, functions, and other API elements improves code readability and helps developers find and use your API.

Format lib/flutter_plugin_qr_scanner.dart.

Run flutter format to format lib/flutter_plugin_qr_scanner.dart.

Maintenance issues and suggestions

Homepage URL doesn't exist. (-20 points)

At the time of the analysis the homepage field https://github.com/alvagan/flutter_plugin_qr_scanner was unreachable.

Package is pre-v0.1 release. (-10 points)

While nothing is inherently wrong with versions of 0.0.*, it might mean that the author is still experimenting with the general direction of the API.

Dependencies

Package Constraint Resolved Available
Direct dependencies
Dart SDK >=2.7.0 <3.0.0
flutter 0.0.0
Transitive dependencies
collection 1.14.12 1.14.13
meta 1.1.8 1.2.1
sky_engine 0.0.99
typed_data 1.1.6 1.2.0
vector_math 2.0.8
Dev dependencies
flutter_test