Flutter 🦅

Our CardScan Flutter widget makes it easy to add insurance card scanning to any Flutter application in 5 minutes or less.

Installation

Add the insurance_card_scanner package to your pubspec.yaml file.

dependencies:
  flutter:
    sdk: flutter
  insurance_card_scanner: ^0.3.0

Usage

Import the library widget into your project files:

import 'package:insurance_card_scanner/insurance_card_scanner.dart';

You can optionally add the API client for more custom applications.

import 'package:insurance_card_scanner/insurance_card_scanner_api.dart';

Basic Example

import 'package:insurance_card_scanner/insurance_card_scanner.dart';

class ScannerWidgetScreen extends StatelessWidget {
  const ScannerWidgetScreen({super.key});

  @override
  Widget build(BuildContext context) {
    return Scaffold(
      appBar: AppBar(
        title: const Text('Scanner widget'),
      ),
      body: CardScanner(
        properties: CardScanConfig(
          sessionToken: '<pass your token here>',
          onSuccess: (card) {
            print('Scan success');
          },
          onError: (message) {
            print(message ?? 'Unknown Scan error');
          },
          onCancel: () {
            Navigator.of(context).pop();
          },
        ),
      ),
    );
  }
}

Available Properties

Both CardScanner and CardScannerModal should be passed a CardScanConfig instance with properties for server connection, callback handling and UI customization.

CardScanConfig(
  // Required
  sessionToken: token,
  live: false,
  onSuccess: onSuccess,

  // Recommended
  onCancel: onCancel,
  onError: onError,

  // Optional
  backsideSupport: scanBackside,
  onRetry: onRetry,

  // UI Customization
  messages: messages,
  messageStyle: messagesStyle,
  autoSwitchActiveColor: autoSwitchActiveColor,
  autoSwitchInactiveColor: autoSwitchInactiveColor,
  progressBarColor: progressBarColor,
  widgetBackgroundColor: widgetBackgroundColor,
)

Main Props

Prop	Required	Type	Description
live	false	Boolean	Toggle the production or sandbox version. Default: false
sessionToken	true	String	A JWT token for the current user, see Authentication
onSuccess	true	Function	Called on successful scan. The first argument is the scanned card.
onCancel	false	Function	Triggered when the user cancels the CardScanner UI.
onError	false	Function	Called when an error is returned by the API or the CardScanner fails to initalize.
backsideSupport	false	Boolean	Enable scanning of the front and back side of the card. Default: false
onRetry	false	Function	Called when a failed scan triggers a retry.

UI/UX Customization Props

The flutter widget is designed to be customizable. Please see the #customization section of UI Components to adjust these elements to match your application's branding and theme:

Customization ⚙️

Note: All UI/UX Props are optional

Prop	Type	Description
messages	Object	Customize the text displayed by the UI.
messageStyle	TextStyle	Set the size, color and background color of the text displayed by the UI.
autoSwitchActiveColor	Color	Set the color of the auto scan switch
autoSwitchInactiveColor	Color	Set the color of the disabled auto scan switch
progressBarColor	Color	Set the color of the progress bars or bounding box that surrounds the card scanning area.
widgetBackgroundColor	Color	Set the main background color for the widget.

onSuccess Callback

The onSuccess callback allows you to execute a custom function when the card scanning process is completed successfully. This function receives the scanned card data as an argument.

Usage

To use the onSuccess callback, pass a function that receives the scanned card data:

void handleCardScanSuccess(Card card) {
  print('Card scanned successfully: $card');
}

CardScanner(
  sessionToken: token,
  onSuccess: handleCardScanSuccess,
)

In this example, the handleCardScanSuccess function logs the scanned card data to the console when the scanning process is completed successfully.

onError Callback

The onError callback allows you to execute a custom function when there's a failure during the card scanning process. This function receives an error object as an argument.

Usage

To use the onError callback, pass a function that receives the error object:

void handleCardScanError(CardScanError error) {
  print('Scanning failed: $error');
}

CardScanner(
  sessionToken: token,
  onSuccess: handleCardScanSuccess,
  onError: handleCardScanError,
)

In this example, the handleCardScanError function logs the error object to the console when a scanning failure occurs.

By using the onSuccess and onError callbacks, you can handle successful and failed scanning events, allowing you to implement custom actions or display appropriate messages to the user.

onCancel Callback

The onCancel callback enables you to execute a custom function when the user cancels the card scanning process. This can be useful for tracking user behavior, navigating to a different part of the application, or displaying an appropriate message.

Usage

To use the onCancel callback, pass a function that will be executed when the user cancels the scanning process:

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

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

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

class _MyAppState extends State<MyApp> {
  bool showCardScanWidget = true;

  void handleCardScanSuccess(Card card) {
    // Handle card scan success
  }

  void handleCardScanError(CardScanError error) {
    // Handle card scan error
  }

  @override
  Widget build(BuildContext context) {
    return MaterialApp(
      home: Scaffold(
        appBar: AppBar(
          title: Text('Insurance Card Scanner'),
        ),
        body: showCardScanWidget
            ? CardScanner(
                sessionToken: token,
                onSuccess: handleCardScanSuccess,
                onError: handleCardScanError,
                onCancel: () => setState(() => showCardScanWidget = false),
              )
            : Container(),
      ),
    );
  }
}

In this example, we initialize the showCardScanWidget state variable to true. Then, we conditionally render the CardScanner widget based on the value of showCardScanWidget. We then use the onCancel callback to set the showCardScanWidget state variable to false when the user cancels the scanning process.

onRetry Callback

The onRetry callback allows you to execute a custom function when a retry is triggered due to a scanning failure.

Usage

void handleRetry() {
  print('Retry triggered');
}

CardScanner(
  sessionToken: token,
  onSuccess: handleCardScanSuccess,
  onRetry: handleRetry,
)

In this example, the handleRetry function logs the retry event to the console when a retry is triggered.