Flutter自定义图标结构插件eticon_struct的使用

Flutter自定义图标结构插件eticon_struct的使用

安装到项目中

在 pubspec.yaml 文件中添加 eticon_struct 作为 dev_dependencies：

dev_dependencies:
  flutter_test:
    sdk: flutter
  flutter_lints: ^1.0.0
  eticon_struct: ^1.0.0

项目结构

项目结构如下所示：

├── 📁 assets
│   ├── 📁 fonts
│   │   └── 📄 empty.ttf
│   ├── 📁 icons
│   │   └── 🖼 empty.png
│   └── 📁 images
│       └── 🖼 empty.png
└── 📁 lib
    ├── 📄 main.dart
    ├── 📁 models
    │   └── 📄 about_models.txt
    ├── 📁 project_utils
    │   ├── 📄 pj_colors.dart
    │   ├── 📄 pj_icons.dart
    │   └── 📄 pj_utils.dart
    ├── 📁 project_widgets
    │   ├── 📄 pj_appbar.dart
    │   ├── 📄 pj_text.dart
    │   └── 📄 pj_widgets.dart
    └── 📁 screens
        └── 📁 main_screen
            ├── 📁 cubit
            │   ├── 📄 cb_main_screen.dart
            │   └── 📄 st_main_screen.dart
            ├── 📄 main_screen.dart
            └── 📄 main_screen_provider.dart

创建项目结构

在创建一个新的 Flutter 项目后，通过终端执行以下命令来创建项目结构：

flutter pub run eticon_struct:create

这将创建以下内容：

1. 项目工具。
2. 全局小部件。
3. 资源文件夹。
4. 模型文件夹。
5. 一个带有与之相连的 Cubit 的基本无状态屏幕。

此外，还会添加一些基本库到项目中：

1. eticon_api
2. get
3. flutter_screenutil
4. flutter_bloc
5. flutter_svg
6. get_storage
7. intl
8. sentry_flutter

如果你想创建一个没有 Cubit 的基础屏幕，可以使用特殊标志 --without-cubit：

flutter pub run eticon_struct:create --without-cubit

如果你想创建一个基础的有状态屏幕，可以使用特殊标志 --stf：

flutter pub run eticon_struct:create --stf

你也可以同时使用这两个标志：

flutter pub run eticon_struct:create --stf --without-cubit

在项目中创建新的屏幕

你可以使用特殊的命令来创建新的屏幕：

flutter pub run eticon_struct:screen --name=<file_name>

例如：

flutter pub run eticon_struct:screen --name=new

执行此命令后，将在项目中添加一个名为 new_screen 的新屏幕。

注意：

名称指定方式与 Dart 文件命名相同，即使用 _ 作为单词分隔符。不要在名称末尾添加 “screen”，因为创建屏幕时会自动添加！

类似于创建项目结构，你可以使用标志 --stf（创建有状态的小部件）和 --without-cubit（创建没有 Cubit 的屏幕）。

例如：

flutter pub run eticon_struct:screen --name=order_schedule --stf --without-cubit

创建不绑定到特定屏幕的新 Cubit

你可以创建不绑定到特定屏幕的新 Cubit：

flutter pub run eticon_struct:cubit --name=<file_name> --path=<your_path>

例如：

flutter pub run eticon_struct:cubit --name=my_cubit --path=project_utils

执行此命令后，将在 project_utils 目录下添加一个新的 Cubit：my_cubit。

注意：

名称指定方式与 Dart 文件命名相同，即使用 _ 作为单词分隔符。path 是新 Cubit 将被创建的目录路径，需要考虑到 path 将被替换为以下行：lib /。

创建单例

你可以使用以下命令创建单例：

flutter pub run eticon_struct:singleton --name=<file_name>

例如：

flutter pub run eticon_struct:singleton --name=my_settings

执行此命令后，将在 project_utils 目录下创建一个名为 singletons 的新目录，其中包含所有创建的单例。

创建的单例结果如下：

class SgMySettings {
  SgMySettings._();

  static SgMySettings instance = SgMySettings._();
  
  static int cnt = 0; // 一些变量 

  // 一些方法
  void inc(){
    cnt++;
  }
}

此类将自动添加到 project_utils.dart 中。

联系我们

如果你有任何问题或建议改进这个包，请通过电子邮件联系我们：main@eticon.ru

示例代码

示例代码：main.dart

import 'package:flutter/material.dart';

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

class MyApp extends StatelessWidget {
  [@override](/user/override)
  Widget build(BuildContext context) {
    return MaterialApp(
      home: MyHomePage(),
    );
  }
}

class MyHomePage extends StatefulWidget {
  [@override](/user/override)
  _MyHomePageState createState() => _MyHomePageState();
}

class _MyHomePageState extends State<MyHomePage> {
  [@override](/user/override)
  Widget build(BuildContext context) {
    return Scaffold(
      appBar: AppBar(
        title: Text('Empty example'),
      ),
      body: Center(
        child: Container(
          width: 150,
          height: 150,
          color: Colors.black,
        ),
      ),
    );
  }
}