Flutter应用图标形状设置插件app_icon_shape的使用

插件简介

app_icon_shape 是一个用于获取平台应用程序启动器图标形状的 Flutter 插件。

平台支持

目前，iOS 的支持正在计划中，但尚未实现。

使用方法

要使用此插件，在 pubspec.yaml 文件中添加 app_icon_shape 作为依赖项。

示例代码

导入库

import 'package:app_icon_shape/app_icon_shape.dart';

获取应用图标遮罩

在 Dart 代码中，可以使用静态方法 getAppIconMask 来获取应用图标的遮罩。

Path? iconMask = await AppIconShape.getAppIconMask();

完整示例代码

以下是一个完整的示例代码，展示如何在应用中使用该插件。

import 'dart:async';
import 'dart:math' as math;
import 'dart:ui' as ui;

import 'package:app_icon_shape/app_icon_shape.dart';
import 'package:flutter/material.dart';
import 'package:flutter/services.dart';
import 'package:path_drawing/path_drawing.dart';

import 'filled_path_painter.dart';
import 'gen/assets.gen.dart';

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

class MyApp extends StatefulWidget {
  const MyApp({Key? key}) : super(key: key);

  [@override](/user/override)
  State<MyApp> createState() => _MyAppState();
}

class _MyAppState extends State<MyApp> {
  Path? _appMask;

  final shapes = {
    'Square': 'M50,0L100,0 100,100 0,100 0,0z',
    'Squircle': 'M50,0 C10,0 0,10 0,50 0,90 10,100 50,100 90,100 100,90 100,50 100,10 90,0 50,0 Z',
    'Circle': 'M50 0A50 50,0,1,1,50 100A50 50,0,1,1,50 0',
    'Teardrop': 'M50,0A50,50,0,0 1 100,50 L100,85 A15,15,0,0 1 85,100 L50,100 A50,50,0,0 1 50,0z',
  };

  [@override](/user/override)
  void initState() {
    super.initState();
    initPlatformState();
  }

  // 平台消息是异步的，因此我们初始化在一个异步方法中。
  Future<void> initPlatformState() async {
    Path? appMask;
    // 平台消息可能会失败，因此我们使用 try/catch 处理 PlatformException。
    // 我们还处理消息可能返回 null 的情况。
    try {
      appMask = await AppIconShape.getAppIconMask();
    } on PlatformException {
      log('Failed to get icon mask.');
    }

    // 如果小部件从树中被移除，而异步平台消息还在飞行中，
    // 我们想丢弃回复而不是调用 setState 来更新我们的不存在的外观。
    if (!mounted) return;

    setState(() {
      _appMask = appMask;
    });
  }

  Widget _getAdaptiveIcon(Path path, Image icon, double pixelRatio) {
    return Stack(
      children: [
        CustomPaint(
          size: Size.square(288 / pixelRatio),
          painter: FilledPathPainter(
            path: path,
            color: Colors.blue,
          ),
        ),
        Container(
          width: 288 / pixelRatio,
          height: 288 / pixelRatio,
          alignment: Alignment.center,
          child: SizedBox(
            width: 200 / pixelRatio,
            height: 200 / pixelRatio,
            child: icon,
          ),
        ),
      ],
    );
  }

  [@override](/user/override)
  Widget build(BuildContext context) {
    return MaterialApp(
      home: Scaffold(
        appBar: AppBar(
          title: const Text('Plugin example app'),
        ),
        body: LayoutBuilder(builder: (context, constraints) {
          final pixelRatio = MediaQuery.of(context).devicePixelRatio;
          return Column(
            children: [
              Flexible(
                child: GridView.count(
                  physics: const NeverScrollableScrollPhysics(),
                  crossAxisCount: 2,
                  children: [
                    Column(
                      mainAxisSize: MainAxisSize.min,
                      children: [
                        const Center(
                          child: Padding(
                            padding: EdgeInsets.all(8.0),
                            child: Text('Launcher icon shape:\n'),
                          ),
                        ),
                        if (_appMask != null)
                          Center(
                            child: CustomPaint(
                              size: Size.square(288 / pixelRatio),
                              painter: FilledPathPainter(
                                path: _appMask!,
                                color: Colors.blue,
                              ),
                            ),
                          ),
                      ],
                    ),
                    Column(
                      mainAxisSize: MainAxisSize.min,
                      children: [
                        const Center(
                          child: Padding(
                            padding: EdgeInsets.all(8.0),
                            child: Text('Adaptive icon example:\n'),
                          ),
                        ),
                        _getAdaptiveIcon(
                          _appMask!,
                          Assets.icons.iconFlutterSolid.image(),
                          pixelRatio,
                        ),
                      ],
                    ),
                    for (final shape in shapes.keys)
                      Center(
                        child: Column(
                          children: [
                            Center(
                              child: Padding(
                                padding: const EdgeInsets.all(8.0),
                                child: Text('$shape:\n'),
                              ),
                            ),
                            _getAdaptiveIcon(
                              parseSvgPathData(shapes[shape]!),
                              Assets.icons.iconFlutterSolid.image(),
                              pixelRatio,
                            ),
                          ],
                        ),
                      ),
                  ],
                ),
              ),
            ],
          );
        }),
      ),
    );
  }
}