Flutter核心功能扩展插件vvs_core的使用

Flutter核心功能扩展插件vvs_core的使用

安装

1. 依赖

在您的包的pubspec.yaml文件中添加以下内容：

dependencies:
    vvs_core: ^version

2. 安装

您可以从命令行安装包：

$ flutter pub get

3. 导入

现在可以在您的 Dart 代码中使用：

import 'package:vvs_core/vvs_core.dart';

使用的依赖项

此项目使用的依赖项包括：

1. shared_preferences: 在设备的本地存储中存储数据。
2. dio: 执行 HTTP 请求。
3. uuid: 生成 GUID。
4. equatable: 类之间的相等性检查。
5. animate_do: 简化动画。
6. google_fonts: 谷歌字体。
7. intl: 国际化。
8. flutter_hooks: 管理小部件的生命周期。
9. package_info_plus: 获取应用程序的原生信息。
10. connectivity_plus: 检查互联网连接。

包的实用工具

包中所有存在的功能如下：

Utils:

1. copyToClipboard: 用于复制文本的实用工具。
2. ExcludeGlowScrollBehavior: 用于移除列表滚动时的发光效果的小部件。
3. generateGuid: 生成 GUID 的实用工具。
4. getClipboardData: 获取剪贴板中的文本。
5. hideKeyboard: 用于关闭键盘的实用工具。
6. keyboardIsOpened: 用于检查键盘是否打开的实用工具。
7. Resulter: 用于将成功和错误情况分离到一个类中的类。
8. formatCurrency: 用于将数字格式化为货币格式（例如 “R$ 9.999,99”）的实用工具。
9. formatDate: 用于格式化日期的实用工具。
10. formatDecimal: 用于将数字格式化为千位分隔符（例如 “1.000.000,00”）的实用工具。
11. formatPercentage: 用于将数字格式化为百分比（例如 “10%”）的实用工具。
12. formatTelefone: 用于将字符串格式化为电话号码格式（例如 “(xx) xxxxx-xxxx”）的实用工具。
13. CepHelper: 用于验证、格式化和删除 CEP 字符的助手。
14. CnpjHelper: 用于验证、格式化、生成和删除 CNPJ 字符的助手。
15. CpfCnpjHelper: 用于验证、格式化和删除 CPF 或 CNPJ 字符的助手。
16. TelefoneHelper: 用于格式化和删除电话字符的助手。
17. CentavosInputFormatter: 用于在文本字段中格式化带有分位数的货币输入格式器。
18. CepInputFormatter: 用于在文本字段中格式化 CEP 输入格式器。
19. CnpjInputFormatter: 用于在文本字段中格式化 CNPJ 输入格式器。
20. CpfInputFormatter: 用于在文本字段中格式化 CPF 输入格式器。
21. CpfOuCnpjFormatter: 用于在文本字段中格式化 CPF 或 CNPJ 输入格式器。
22. DataInputFormatter: 用于在文本字段中格式化日期输入格式器。
23. PlacaVeiculoInputFormatter: 用于在文本字段中格式化车辆牌照输入格式器。
24. RealInputFormatter: 用于在文本字段中格式化货币输入格式器。
25. TelefoneInputFormatter: 用于在文本字段中格式化电话输入格式器。

Shared:

1. BaseHookView: 使用 flutter_hooks 包创建视图（页面）和视图模型的类。
2. BaseView: 创建视图和视图模型的类。
3. BaseViewModel: 创建视图模型的类。

Services:

1. FlutterDialogService: 用于显示对话框的服务。
   • 此服务不使用任何外部包来显示对话框，要使用它，请参阅 flutter_dialog_service.dart 文件中的步骤。
2. VvsSistemasDioAdapter: 用于对符合 VVS Systems API 响应标准的 API 进行 HTTP 客户端请求的适配器。
3. InternetConnectivityPlusService: 用于检查互联网连接的服务。
   • 此服务使用 connectivity_plus 包。
4. SharedPreferencesLocalStorageService: 用于读取、保存和删除设备本地存储的数据的服务。

扩展:

1. double_extension:

   • arredondar: 将数字四舍五入到指定的小数位。
   • casoForZero: 如果当前值为零，则返回一个给定值 X。
   • getValueOrDefault: 如果当前值为空，则返回一个给定值 X。

2. list_extensions:

   • sumBy: 对列表中的某个属性求和。
   • separarComVirgulas: 将值用逗号分隔（例如，[‘VVS Sistemas’, ‘Google’] = “VVS Sistemas, Google”）。

3. string_extensions:

   • whereNullOrEmpty: 返回一个值，如果当前值为空或 null。
   • toDateTime: 从字符串返回 DateTime（字符串格式必须为 “日/月/年”）。
   • capitalize: 将字符串首字母大写（例如，“texto exemplo PARA CAPITALIZAÇÃO” = “Texto exemplo para capitalização”）。
   • removeWhitespace: 删除字符串中的所有空格。
   • contemNumero: 检查字符串是否包含数字。
   • contemCaracterEspecial: 检查字符串是否包含特殊字符。
   • isInstagramUser: 检查字符串是否以 “@” 开头。

组件:

1. CircularLoader
2. TooltipSpan: 具有提示的 Text.rich。
3. VvsButton: 应用程序的标准按钮。
4. VvsIconButton: 带有图标的应用程序标准按钮。

示例代码

为了更好地理解如何使用 vvs_core 插件，下面是一个简单的示例代码，展示了如何使用一些主要的功能。

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

void main() {
  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> {
  final TextEditingController _textEditingController = TextEditingController();

  void _showDialog() {
    // 使用 FlutterDialogService 显示对话框
    FlutterDialogService.showDialog(
      context: context,
      title: 'Hello',
      content: 'This is a simple dialog.',
    );
  }

  void _copyToClipboard() {
    // 使用 copyToClipboard 实用工具复制文本
    VvsCore.copyToClipboard('Copied text');
  }

  void _formatCurrency() {
    // 使用 formatCurrency 实用工具格式化货币
    String formattedCurrency = VvsCore.formatCurrency(1234567.89);
    print(formattedCurrency); // 输出: R$ 1.234.567,89
  }

  [@override](/user/override)
  Widget build(BuildContext context) {
    return Scaffold(
      appBar: AppBar(
        title: Text('VVS Core Example'),
      ),
      body: Padding(
        padding: const EdgeInsets.all(16.0),
        child: Column(
          children: [
            ElevatedButton(
              onPressed: _showDialog,
              child: Text('Show Dialog'),
            ),
            SizedBox(height: 16),
            ElevatedButton(
              onPressed: _copyToClipboard,
              child: Text('Copy to Clipboard'),
            ),
            SizedBox(height: 16),
            ElevatedButton(
              onPressed: _formatCurrency,
              child: Text('Format Currency'),
            ),
            TextField(
              controller: _textEditingController,
              inputFormatters: [
                // 使用 RealInputFormatter 格式化货币输入
                VvsCore.RealInputFormatter(),
              ],
              decoration: InputDecoration(
                labelText: 'Enter currency',
              ),
            ),
          ],
        ),
      ),
    );
  }
}