BioPass ID Signature SDK Flutter

Quick Start Guide • Prerequisites • Installation • How to use • LicenseKey • SignatureConfig • Changelog • Support

Quick Start Guide #

First, you will need a license key to use the biopassid_signature_sdk. To get your license key contact us through our website BioPass ID. #

Check out our official documentation for more in depth information on BioPass ID.

1. Prerequisites: #

- License key
- Internet connection is required to verify the license

2. Installation #

First, add biopassid_signature_sdk as a dependency in your pubspec.yaml file.

Android #

Change the minimum Android sdk version to 21 (or higher) in your android/app/build.gradle file.

minSdkVersion 21

iOS #

Requires iOS 13.0 or higher.

Then go into your project's ios folder and run pod install.

# Go into ios folder
$ cd ios

# Install dependencies
$ pod install

3. How to use #

To call Signature in your Flutter project is as easy as follow:

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

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

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

  @override
  Widget build(BuildContext context) {
    return MaterialApp(
      title: 'Signature Demo',
      theme: ThemeData(
        primarySwatch: Colors.blue,
      ),
      home: const MyHomePage(),
    );
  }
}

class MyHomePage extends StatefulWidget {
  const MyHomePage({super.key});

  @override
  State<MyHomePage> createState() => _MyHomePageState();
}

class _MyHomePageState extends State<MyHomePage> {
  late SignatureController controller;

  @override
  void initState() {
    super.initState();
    final config = SignatureConfig(licenseKey: 'your-license-key');
    controller = SignatureController(config);
  }

  void takeSignature() async {
    final signature = await controller.takeSignature();
    print('Signature: ${signature[0]}');
  }

  @override
  Widget build(BuildContext context) {
    return Scaffold(
      appBar: AppBar(
        title: const Text('Signature Demo'),
      ),
      body: Center(
        child: ElevatedButton(
          onPressed: takeSignature,
          child: const Text('Capture Signature'),
        ),
      ),
    );
  }
}

4. LicenseKey #

First, you will need a license key to use the biopassid_signature_sdk. To get your license key contact us through our website BioPass ID. #

To use biopassid_signature_sdk you need a license key. To set the license key needed is simple as setting another attribute. Simply doing:

final config = SignatureConfig(licenseKey: 'your-license-key');

SignatureConfig #

You can also use pre-build configurations on your application, so you can automatically start using multiples features that better suit your application. You can instantiate each one and use it's default properties, or if you prefer you can change every config available. Here are the types that are supported right now:

SignatureConfig #

SignatureButtonOptions #

SignatureIconOptions #

SignatureTextOptions #

SignatureScreenOrientation (enum) #

How to change font family #

on Android side #

You can use the default font family or set one of your own. To set a font family, create a folder font under res directory in your android/app/src/main/res. Download the font which ever you want and paste it inside font folder. All font file names must be only: lowercase a-z, 0-9, or underscore. The structure should be some thing like below.

[]

on iOS side #

To add the font files to your Xcode project:

1. In Xcode, select the Project navigator.
2. Drag your fonts from a Finder window into your project. This copies the fonts to your project.
3. Select the font or folder with the fonts, and verify that the files show their target membership checked for your app’s targets.

[]

Then, add the "Fonts provided by application" key to your app’s Info.plist file. For the key’s value, provide an array of strings containing the relative paths to any added font files.

In the following example, the font file is inside the fonts directory, so you use fonts/roboto_mono_bold_italic.ttf as the string value in the Info.plist file.

[]

on Dart side #

Finally, just set the font family passing the name of the font file when instantiating SignatureConfig in your Flutter app.

final config = SignatureConfig(licenseKey: 'your-license-key');
config.fontFamily = 'roboto_mono_bold_italic';

How to change icon #

on Android side #

You can use the default icons or define one of your own. To set a icon, download the icon which ever you want and paste it inside drawable folder in your android/app/src/main/res. All icon file names must be only: lowercase a-z, 0-9, or underscore. The structure should be some thing like below.

[]

on iOS side #

To add icon files to your Xcode project:

1. In the Project navigator, select an asset catalog: a file with a .xcassets file extension.
2. Drag an image from the Finder to the outline view. A new image set appears in the outline view, and the image asset appears in a well in the detail area.

[]

on Dart side #

Finally, just set the icon passing the name of the icon file when instantiating SignatureConfig in your Flutter app.

final config = SignatureConfig(licenseKey: 'your-license-key');
// Changing back button icon
config.backButton.iconOptions.iconFile = 'ic_baseline_camera';
// Changing save button icon
config.saveButton.iconOptions.iconFile = 'ic_baseline_camera';
// Changing delete button icon
config.deleteButton.iconOptions.iconFile = 'ic_baseline_camera';
// Changing undo button icon
config.undoButton.iconOptions.iconFile = 'ic_baseline_camera';

Changelog #

v0.1.1 #

• Documentation update;
• Fixes and improvements.

v0.1.0 #

• Add documentation;
• Signature capture functionality;
• Customizable UI;
• Return of captured signature image.