Flutter插件flutter_ditto的介绍与使用

Flutter_ditto

该插件旨在提供与Dittowords本地化集成的简单方法，类似于React中的ditto-react。

支持的功能

• ✅ OTA（Over-the-Air）更新翻译
• ✅ 带有复数的翻译
• ✅ 带有变量的翻译

快速开始

要将Ditto集成到您的应用中，只需用DittoMaterialApp替换当前的MaterialApp。

分离初始化

您可以将DittoStore的初始化与DittoMaterialApp分开进行：

Future<void> main() async {
  WidgetsFlutterBinding.ensureInitialized();

  // 初始化 DittoStore
  await DittoStore().initialize(
    configs: DittoConfigData.base(
      projectId: '<YOUR_PROJECT_ID>',
      apiKey: '<YOUR_API_KEY>',
    ),
  );

  runApp(const MyApp());
}

class _MyAppState extends State<MyApp> {
  [@override](/user/override)
  Widget build(BuildContext context) {
    return DittoMaterialApp(
      title: 'Ditto 测试',
      fallbackLocale: const Locale('en'),
      home: const MyHomePage(),
    );
  }
}

集成初始化

也可以让DittoMaterialApp组件直接处理DittoStore的初始化，通过传递DittoConfigData实现：

class _MyAppState extends State<MyApp> {
  [@override](/user/override)
  Widget build(BuildContext context) {
    return DittoMaterialApp(
      title: 'Ditto 测试',
      fallbackLocale: const Locale('en'),
      home: const MyHomePage(),
      configData: DittoConfigData.base(
        projectId: '<YOUR_PROJECT_ID>',
        apiKey: '<YOUR_API_KEY>',
      ),
      loadingPlaceholder: Container(
        color: Theme.of(context).primaryColor,
        child: const Center(
          child: CircularProgressIndicator(color: Colors.white),
        ),
      ),
    );
  }
}

翻译

在包裹了DittoMaterialApp后，您可以使用String.translate()扩展方法来翻译文本。

示例代码

简单翻译

'simple_key'.translate()

带变量的翻译

'variable_key'.translate({'var_name': 'var_value'})
// 如果想隐藏变量，可以传入 `null`
'variable_key'.translate({'var_name': null})

带复数的翻译

'plural_key'.translate({'var_name': 'var_value'}, 2)

完整示例代码

以下是一个完整的示例代码，展示了如何使用flutter_ditto插件：

import 'dart:math';

import 'package:flutter/material.dart';
import 'package:flutter_ditto/api/configs/config_data.dart';
import 'package:flutter_ditto/flutter_ditto.dart';

Future<void> main() async {
  WidgetsFlutterBinding.ensureInitialized();
  runApp(
    InheritedDitto(
      config: DittoConfigData(
        projectId: '<YOUR-PROJECT-ID>',
        apiKey: '<YOUR-API-KEY>',
      ),
      onlyNetworkLabels: true,
      defaultLocale: const Locale('it'),
      loadingWidget: const Center(child: CircularProgressIndicator()),
      child: const MyApp(),
    ),
  );
}

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

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

class _MyAppState extends State<MyApp> {
  [@override](/user/override)
  Widget build(BuildContext context) {
    return MaterialApp(
      title: 'Ditto 测试',
      localizationsDelegates: [
        InheritedDitto.of(context).localizationsDelegate,
        ...defaultDelegates,
      ],
      home: const MyHomePage(),
    );
  }
}

class MyHomePage extends StatefulWidget {
  const MyHomePage({super.key});

  [@override](/user/override)
  State<MyHomePage> createState() => _MyHomePageState();
}

class _MyHomePageState extends State<MyHomePage> {
  final _emailNotifier = ValueNotifier<String?>(null);
  final _clickedNotifier = ValueNotifier<int>(0);

  [@override](/user/override)
  Widget build(BuildContext context) {
    return Scaffold(
      appBar: AppBar(
        title: Text('appbar_title'.translate(context)),
      ),
      body: Padding(
        padding: const EdgeInsets.symmetric(horizontal: 20),
        child: Column(
          mainAxisAlignment: MainAxisAlignment.center,
          children: [
            TextField(
              decoration: InputDecoration(
                hintText: 'hint_email'.translate(context),
              ),
              onChanged: (value) => _emailNotifier.value = value,
            ),
            TextField(
              decoration: InputDecoration(
                hintText: 'text.hint.password'.translate(context),
              ),
            ),
            ValueListenableBuilder<String?>(
              valueListenable: _emailNotifier,
              builder: (context, snap, _) => Visibility(
                visible: snap != null && snap.isNotEmpty,
                child: Padding(
                  padding: const EdgeInsets.only(top: 20),
                  child: Text(
                    'text_inserted_email'
                        .translate(context, variables: {'email': snap ?? '-'}),
                  ),
                ),
              ),
            ),
            const SizedBox(height: 20),
            Row(
              mainAxisAlignment: MainAxisAlignment.center,
              children: [
                ElevatedButton(
                  onPressed: () =>
                      _clickedNotifier.value = _clickedNotifier.value + 1,
                  child: const Text('+'),
                ),
                const SizedBox(width: 10),
                ElevatedButton(
                  onPressed: () =>
                      _clickedNotifier.value = max(0, _clickedNotifier.value - 1),
                  child: const Text('-'),
                ),
              ],
            ),
            ValueListenableBuilder<int>(
              valueListenable: _clickedNotifier,
              builder: (context, data, _) => Text(
                'text_clicked'
                    .translate(context, variables: {'count': data.toString()}, count: data),
              ),
            ),
            const SizedBox(height: 20),
            ElevatedButton(
              onPressed: () {},
              child: Text('button.login'.translate(context)),
            ),
          ],
        ),
      ),
    );
  }
}