rounded_qr

An easy to use package for creating QR codes that can be rounded, and can have an image in the center.

This package uses the actively maintained qr package under the hood.

Usage

Default

By default the modules in the QR code will have rounded corners with a radius of 4.0.

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

void main() => runApp(MyApp());

class MyApp extends StatelessWidget {
  @override
  Widget build(BuildContext context) {
    return MaterialApp(
      home: Scaffold(
        body: Center(
          child: RoundedQR(
            data: 'https://flutter.dev',
          ),
        ),
      ),
    );
  }
}

Squared

The radius of the modules is variable and can be removed completely by setting the moduleRadius and backgroundRadius parameters to 0.0.

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

void main() => runApp(MyApp());

class MyApp extends StatelessWidget {
  @override
  Widget build(BuildContext context) {
    return MaterialApp(
      home: Scaffold(
        body: Center(
          child: RoundedQR(
            data: 'https://flutter.dev',
            moduleRadius: 0.0,
            backgroundRadius: 0.0,
          ),
        ),
      ),
    );
  }
}

With image

Adding an image to the center can be done by simply passing an AssetImage to the image parameter.

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

void main() => runApp(MyApp());

class MyApp extends StatelessWidget {
  @override
  Widget build(BuildContext context) {
    return MaterialApp(
      home: Scaffold(
        body: Center(
          child: RoundedQR(
            data: 'https://flutter.dev',
            image: AssetImage('assets/images/flutter.png'),
          ),
        ),
      ),
    );
  }
}

Custom colors

Both the module color and the background color can be changed by setting the moduleColor and backgroundColor parameters respectively.

Note that the module color needs to be darker then the background colors to work with most QR code scanners.

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

void main() => runApp(MyApp());

class MyApp extends StatelessWidget {
  @override
  Widget build(BuildContext context) {
    return MaterialApp(
      home: Scaffold(
        body: Center(
          child: RoundedQR(
            data: 'https://flutter.dev',
            moduleColor: Colors.blue,
            backgroundColor: Colors.grey,
          ),
        ),
      ),
    );
  }
}

QR version

The version can be changed to allow for more storage just by setting the typeNumber to the desired version (1 to 40.)

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

void main() => runApp(MyApp());

class MyApp extends StatelessWidget {
  @override
  Widget build(BuildContext context) {
    return MaterialApp(
      home: Scaffold(
        body: Center(
          child: RoundedQR(
            data: 'https://flutter.dev',
            typeNumber: 17,
          ),
        ),
      ),
    );
  }
}

Error correction

The error correction level can be changed to allow more data bytes to be restored by setting the errorCorrectLevel to the desired level.

  • Level L (Low) - 7% of data bytes can be restored.
  • Level M (Medium) - 15% of data bytes can be restored.
  • Level Q (Quartile) - 25% of data bytes can be restored.
  • Level H (High) - 30% of data bytes can be restored.
import 'package:flutter/material.dart';
import 'package:qr/qr.dart'; // we will import the [QrErrorCorrectLevel] from the qr package
import 'package:rounded_qr/rounded_qr.dart';

void main() => runApp(MyApp());

class MyApp extends StatelessWidget {
  @override
  Widget build(BuildContext context) {
    return MaterialApp(
      home: Scaffold(
        body: Center(
          child: RoundedQR(
            data: 'https://flutter.dev',
            errorCorrectLevel: QrErrorCorrectLevel.H,
          ),
        ),
      ),
    );
  }
}

Licence

This Flutter package is made available under a MIT license.

Libraries

rounded_qr