easy_avatar 3.0.0

A plug-in that provides solutions to avatar-related problems in Flutter applications.

easy_avatar

A plug-in that provides solutions to avatar-related problems in Flutter applications. 在 Flutter 应用程序中提供头像相关问题的解决方案的插件。

Author: Jcak Lee Email: [e-mail] Homepage: http://thispage.tech:9680/jclee1995/flutter-easy-avatar repository: https://github.com/jacklee1995/flutter_easy_avatar issue_tracker: https://github.com/jacklee1995/flutter_easy_avatar/issues

---

Getting Started

The simplest example is to use the default avatar and default parameters: 最简单的例子是使用默认头像及默认参数：

const Avatar()

The effect of this code is as follows: 其运行效果如下：

你也可以指定一些头像参数，但是如果你指定一个错误的头像地址，将自动地使用默认头像，例如：

Avatar(
  size: 100,
  backgroundColor: Colors.indigo,
  borderRadius: 40,
  padding: EdgeInsets.all(20),
  image: 'https://example.com/avatar.jpg',
),

The effect of this code is as follows: 其运行效果如下：

如果要可以设置一个真实的网络图片URL作为头像，则它必须以http开头，例如：

const Avatar(
  size: 200,
  borderRadius: 100,
  image:
      'https://profile-avatar.csdnimg.cn/bb869bb0b79b48209c6206043890c985_qq_28550263.jpg',
),

The effect of this code is as follows: 其运行效果如下：

Oh, this is me. An active user of the open source community! 哦，这就是我了。一个开源社区的活跃用户！

Actually, you can also use animation, which doesn't matter: 其实你还可以使用动图，这没关系的：

const Avatar(
  size: 200,
  margin: EdgeInsets.all(6),
  borderRadius: 60,
  image:
      'https://github.githubassets.com/images/mona-loading-dimmed.gif',
),

The effect of this code is as follows: 其运行效果如下：

If the avatar itself has a transparent background, you can see the default background color or background picture. Also, you can add an outer border for your avatar, such as: 如果头像本身是透明背景的，可以看到默认背景色 或 背景图片。并且，你还可以为你的头像添加外边框，例如：

Avatar(
  size: 200,
  padding: const EdgeInsets.all(10),
  margin: const EdgeInsets.all(10),
  borderRadius: 80,
  backgroundColor: Colors.white, // 如不设置，则为灰色
  // 可以为你的头像添加边框
  border: Border.all(
    color: const Color.fromARGB(255, 0, 0, 0),
    width: 6.0,
    style: BorderStyle.solid,
    strokeAlign: BorderSide.strokeAlignInside,
  ),
  image:
      'https://gitee.com/jacklee1995/example-pictures/raw/master/asian/asian-girl-avatar.png',
),

The effect of this code is as follows: 其运行效果如下：

Next is an example of using a network picture as a background picture, which will cover the background color effect: 接下来是一个使用网络图片作为背景图的例子，这个网络图片将覆盖背景颜色效果：

const Avatar(
  size: 200,
  margin: EdgeInsets.all(10),
  borderRadius: 80,
  backgroundImage:
      'https://gitee.com/jacklee1995/example-pictures/raw/master/scenery/jonathanvasquez8950_scenery_2f6031d1-c4fe-41d7-8abf-d1c9c40d9981.png',
  image:
      'https://gitee.com/jacklee1995/example-pictures/raw/master/asian/asian-girl-avatar.png',
),

The effect of this code is as follows: 其运行效果如下：

Now, let's explore some special effects - Avatar out of the box.

The Avatar class provides an intermediate layer border property called interlayerBorder. Using this property instead of the border property will help you achieve the effect of characters coming out of the frame. Here's an example code: 下面我们玩一点特效——人物出框。 Avatar 类提供了一个中间层边框属性 interlayerBorder，通过该属性而不是 border 属性设置的边框将帮助你完成人物出框的效果。示例代码如下：

Avatar(
  size: 200,
  interlayerBorder: Border.all(
    color: const Color.fromARGB(255, 255, 251, 3),
    width: 20.0,
    style: BorderStyle.solid,
    strokeAlign: BorderSide.strokeAlignInside,
  ),
  // margin: const EdgeInsets.all(6),
  borderRadius: 100,
  backgroundImage:
      'https://gitee.com/jacklee1995/example-pictures/raw/master/scenery/jonathanvasquez8950_scenery_2f6031d1-c4fe-41d7-8abf-d1c9c40d9981.png',
  image: 'assets/asian-boy-avatar.png', // 也可以使用本地图片资源
)

The effect of this code is as follows: 其效运行果如下：

文字头像（Text Avatar）

Since v2.0.0, a new layer has been added to display text, but the textMode must be turned on with the textmode parameter. If no text is specified, it will be displayed as "?" No, otherwise it is displayed as the text specified by using the text parameter.

从 v2.0.0 开始，添加了新的图层用于显示文字，但是必须使用 textMode 参数开启文字模式。如果没有指定文本，将显示为“?”号，否则显示为使用 text 参数所指定的文本。

examples: 例如：

const Avatar(textMode: true),

The effect of this code is as follows: 效果为：

const Avatar(
  textMode: true, // 文字模式必须启用此参数
  text: 'Lee', // 默认仅仅使用一个字符
),

The effect of this code is as follows: 效果为：

If the text consists of more than one word, you need to specify the number of words through the wordsCount parameter to display more than one character: 如果文本由多个单词构成，需要通过 wordsCount 参数指定单词的数量以显示多个字符：

const Avatar(
  textMode: true,
  text: 'Jun Cai',
  borderRadius: 40,
  wordsCount: 2, // 单词数量，用于显示多个单词的首字符
),

The effect of this code is as follows: 效果为：

Let's enjoy it!~ 尽情探索吧！~

---

API 编程接口

class Avatar

A widget that displays an avatar with various customization options. 此类是一个显示带有各种自定义选项的头像的组件。

This widget allows you to display avatars with custom dimensions, border radius, background color, and an optional background image. You can specify both network and local images for the avatar.

该组件允许您显示具有自定义尺寸、边框半径、背景颜色和可选背景图像的头像。可以为头像指定网络和本地图像。

Example Usage 示例

Avatar({
  Key? key,
  double size = 100,
  double borderRadius = 50,
  String? backgroundImage,
  Color? backgroundColor,
  String? image = '',
  String text = '?',
  EdgeInsetsGeometry margin = EdgeInsets.zero,
  EdgeInsetsGeometry padding = EdgeInsets.zero,
  Border? interlayerBorder,
  Border? border,
  bool textMode = false,
  bool upperCase = false,
  int? wordsCount,
  File? fileImage,
})

Constructor 构造函数

默认构造函数 Avatar

Creates an Avatar widget.

创建Avatar组件。

• size (double, optional): The size of the avatar. Default is 100.

  • 头像的尺寸。默认为100。

• borderRadius (double, optional): The border radius of the avatar. Default is 50.

  • 头像的边框半径。默认为50。

• backgroundImage (String, optional): The URL for the background image of the avatar.

  • 头像的背景图像的URL。

• backgroundColor (Color, optional): The background color of the avatar if backgroundImage is not provided. Default is a gray color.

  • 如果没有提供 backgroundImage，则设置头像的背景颜色。默认为灰色。

• image (String, required): The image for the avatar, which can be either a network URL or a local asset path.

  • 用于设置头像的图像，可以是网络URL或本地资源路径。

• text (String, required): The text for the avatar.

  • 文字头像的文本。

• textMode (bool, optional): Whether to use text avatar mode. Default is false.

  • 是否启用文本头像模式，默认为 false。

• upperCase (bool, optional): Use capital letters. Default is false.

  • 文本转大写，默认为 false。

• wordsCount (int, optional): Number of words, used to display the first characters of multiple words.

  • 单词数量，用于显示多个单词的首字符。

• margin (EdgeInsetsGeometry, optional): The margin around the entire avatar. Default is no margin.

  • 控制整个头像周围的边距。默认没有边距。

• padding (EdgeInsetsGeometry, optional): The padding within the avatar, affecting only the avatar image. Default is no padding.

  • 应用于头像内部，仅影响头像图像的填充。默认没有填充。

• border (Border, optional): The border for the avatar.

  • 头像的边框。

• interlayerBorder (Border, optional): The interlayer border for the avatar.

  • 头像的中间层边框。

SVG图像支持

SVG Image Support

v3.0.0版本开始，Avatar类的image参数支持使用SVG格式的图片，并且支持SVG图像的缓存

Starting from version 3.0.0, the image parameter of the Avatar widget supports using SVG format images, and caching for SVG images is also supported.

v3.0.0暂不支持背景层的SVG图像，背景层的SVG支持计划在下一个版本提交。

ersion 3.0.0 does not support SVG images for the background layer yet. Support for SVG in the background layer is planned for the next release.

一个使用assets中SVG图像的例子是：

// An example using SVG
Avatar(
  size: 200,
  interlayerBorder: Border.all(
    color: const Color.fromARGB(255, 224, 172, 0),
    width: 20.0,
    style: BorderStyle.solid,
    strokeAlign: BorderSide.strokeAlignInside,
  ),
  padding: const EdgeInsets.all(10),
  borderRadius: 100,
  backgroundImage:
      'https://gitee.com/jacklee1995/example-pictures/raw/master/scenery/jonathanvasquez8950_scenery_2f6031d1-c4fe-41d7-8abf-d1c9c40d9981.png',
  image: 'assets/assetSvgAvatar.svg', // An assets image or network image ending with SVG
),

此外，你也可以通过 image 参数指定一个来自网络的SVG图像的url，这个url必须以字符串'svg'结尾，如'https://www.example.com/svgs/example.svg'。

You can also specify a URL for a network SVG image via the image parameter, which must end with the string 'svg', such as 'https://www.example.com/svgs/example.svg'.

设备文件支持

Device File Support

从v3.0.0开始，使用Avatar的 fileImage参数来指定一个本地文件对象。该参数旨在方便配合选择本地文件上传。比如，基于Avatar组件封装一个自定义头像组件：

Starting from version 3.0.0, use the fileImage parameter of the Avatar widget to specify a local file object. This parameter is designed to facilitate selecting and uploading local files. For example, wrapping the Avatar widget into a custom avatar component:

import 'dart:io';

import 'package:flutter/material.dart';
import 'package:easy_avatar/easy_avatar.dart';
import 'package:get/state_manager.dart';

import '../controllers/my_avatar_controller.dart';

class UserAvatar extends GetView<MyAvatarController> {
  final double size;

  final Function()? onTap;
  final Function()? onDoubleTap;
  final Function()? onLongPress;
  const UserAvatar({
    super.key,
    this.size = 76,
    this.onTap,
    this.onDoubleTap,
    this.onLongPress,
  });

  @override
  Widget build(BuildContext context) {
    return Obx(() {
      final File? imageFile = controller.userImage.value;
      return GestureDetector(
        onTap: onTap,
        onDoubleTap: onDoubleTap,
        onLongPress: onLongPress,
        child: Avatar(
          fileImage: imageFile,
          image: controller.avatarImageStr.value,
          size: size,
          borderRadius: 75,
        ),
      );
    });
  }
}

在控制器处，可以定义一个setupImage方法来读取本地头像：

In the controller, you can define a setupImage method to load a local avatar:

class MyAvatarController extends GetxController{

  // ...  

  /// 注意使用Rxn来管理可空的File
  var userImage = Rxn<File>();

  /// 表示图像资源值的字符串
  final Rxn<String> avatarImageStr = Rxn<String>(null);

  /// 从图库选择图像并更新UI的异步方法。
  Future<void> setupImage() async {
    final picker = ImagePicker();
    final pickedFile = await picker.pickImage(source: ImageSource.gallery);

    if (pickedFile != null) {
      userImage.value = File(pickedFile.path); // 更新图像文件
    }
    avatarImageStr.value = null;
  }

}

使用有选择本地文件头像功能时，可以这样调用：

When using the function of selecting local file avatar, you can call it like this:

UserAvatar(
  onDoubleTap: () => controller.setupImage(),
  onTap: () => Get.toNamed('/set_avatrtar'),
),

注：v3.0.0版本文件图像功能暂不直接支持选取svg图像，这将在后续版本更新到file_picker后得到改善。

Note: Version 3.0.0's file image feature does not directly support selecting SVG images yet. This will be improved in future versions with updates to file_picker.

需要指出的是，你可以同时指定 image参数和 fileImage参数，但是如果 image的值非 null，则使用的 image参数指定的头像。也就是说，通过 fileImage参数在 image为 null的条件下生效。

It should be noted that you can specify both the image parameter and the fileImage parameter. However, if the value of image is not null, the avatar specified by the image parameter will be used. In other words, the fileImage parameter takes effect only when image is null.

Major Changes in v2.0.0

Starting from v2.0.0: 从 v2.0.0 开始：

• The width and height properties of the Avatar class have been removed, replaced by the size property.
• 删除了 Avatar 类的 width 属性和 height 属性，取而代之的为 size 属性。
• Added the functionality of text avatars.
• 新增了文字头像功能。

Major Changes in v3.0.0

Starting from v3.0.0: 从 v3.0.0 开始：

• SVG support has been added.

  添加了 SVG 支持。

• Caching for image layers has been implemented. For SVG images, the storage location is the application directory.

  已实现图像层的缓存。对于 SVG 图像，存储位置为应用目录。

Issue Tracker

你可以在 Github 上报告错误：https://github.com/jacklee1995/flutter_easy_avatar/issues

License

This project is licensed under the MIT License - see the LICENSE file for details.

本项目根据MIT许可证许可 - 有关详细信息，请参阅LICENSE文件。