Flutter手写签名插件signature_kit的使用

本文档描述了如何在Flutter项目中使用signature_kit插件。此插件允许用户绘制平滑的手写签名，并且可以轻松导出图像数据。

开始使用

首先，在项目的pubspec.yaml文件中添加signature_kit依赖项：

dependencies:
  signature_kit: ^1.0.1

然后运行flutter pub get以安装依赖项。

使用方法

以下是一个简单的示例，演示如何使用signature_kit插件来创建一个带有签名功能的页面。

示例代码

import 'dart:ui';

import 'package:flutter/foundation.dart';
import 'package:flutter/material.dart';
import 'package:signature_kit/signature_kit.dart';

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

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

  @override
  Widget build(BuildContext context) {
    return MaterialApp(
      title: 'Signature_kit 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> {
  // 初始化签名控制器
  SignatureController controller = SignatureController(
    backgroundColor: Colors.black,   // 设置背景颜色为黑色
    color: Colors.white,             // 设置线条颜色为白色
    strokeWidth: 3,                  // 设置线条宽度为3
  );

  // 存储导出的PNG数据
  Uint8List? pngData;

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

  @override
  Widget build(BuildContext context) {
    return Scaffold(
      appBar: AppBar(
        title: const Text('Signature_kit Example'),
        centerTitle: true,
      ),
      body: Column(
        mainAxisAlignment: MainAxisAlignment.start,
        crossAxisAlignment: CrossAxisAlignment.center,
        children: [
          const SizedBox(height: 20),
          Row(
            mainAxisAlignment: MainAxisAlignment.center,
            crossAxisAlignment: CrossAxisAlignment.center,
            children: [
              // 导出按钮
              ElevatedButton(
                onPressed: () async {
                  // 将签名导出为PNG格式
                  pngData = await controller.toImage(
                    pixelRatio: MediaQuery.of(context).devicePixelRatio,
                    format: ImageByteFormat.png,
                  );
                  // 更新UI
                  setState(() {});
                },
                child: const Text('导出'),
              ),
              const SizedBox(width: 20),
              // 清除按钮
              ElevatedButton(
                onPressed: () {
                  // 清除签名
                  controller.clear();
                  pngData = null;
                  // 更新UI
                  setState(() {});
                },
                child: const Text('清除'),
              ),
            ],
          ),
          const SizedBox(height: 20),
          // 显示签名区域
          SizedBox(
            height: 260,
            child: Signature(controller: controller),
          ),
          const SizedBox(height: 30),
          // 如果有导出的数据，则显示图像
          pngData != null ? Image.memory(pngData!) : const SizedBox(),
        ],
      ),
    );
  }
}

说明

• 初始化签名控制器：

  SignatureController controller = SignatureController(
    backgroundColor: Colors.black,
    color: Colors.white,
    strokeWidth: 3,
  );
  

  这里设置了签名的背景颜色为黑色，线条颜色为白色，线条宽度为3。

• 导出签名：

  pngData = await controller.toImage(
    pixelRatio: MediaQuery.of(context).devicePixelRatio,
    format: ImageByteFormat.png,
  );
  

  使用toImage方法将签名导出为PNG格式，并将其保存到pngData变量中。

• 清除签名：

  controller.clear();
  pngData = null;