パッケージ、リポジトリ、アプリカテゴリを検索

パッケージ詳細v0.9.0

i18next

i18next標準に基づくローカリゼーションフォーマッターです。まだ完全なi18nツールではなく、フォーマットそのもののみです。

AndroidiOSWebmacOSWindowsLinux
30日間ダウンロード
6万
いいね数
21
Pub ポイント
160

パッケージをインストール

flutter pub add i18next

パッケージ概要

公開情報に基づく選定ガイドです。参考としてご利用ください。

i18next は、i18next 標準に基づいたローカライズフォーマットを提供する Flutter/Dart パッケージです。国際化のフォーマットに関する側面に焦点を当てており、プレースホルダーや複数形を含む構造化された翻訳処理を可能にします。完全なi18nソリューションではないものの、プラットフォーム間で一貫したテキストフォーマットを実現します。標準的なローカライズパターンが必要な開発者向けに設計されており、既存のワークフローと良好に統合されます。このパッケージは Android、iOS、Web、macOS、Windows、Linux と互換性があります。

用途

  • プレースホルダーを使用して翻訳された文字列をフォーマットする
  • 翻訳における複数形の取り扱い
  • マルチリンガルアプリコンテンツのサポート
  • i18nextベースのバックエンドシステムとの統合
  • 動的メッセージレンダリングの簡素化

主な機能

  • i18next 標準準拠
  • プレースホルダと複数形のサポート
  • クロスプラットフォーム互換性
  • 軽量フォーマットエンジン
  • 既存の翻訳ファイルとの簡単な統合

適している対象

  • 構造化ローカリゼーションを必要とするアプリ
  • i18nextに精通した開発者
  • 外部翻訳管理を使用するプロジェクト
  • 複数のプラットフォーム間で一貫した書式を維持する必要があるチーム
  • フロントエンド中心の国際化

注意事項

  • 完全なi18nツールキットを含んでいません
  • 外部の翻訳ファイル管理が必要です
  • フォーマットのみに限定され、ロケールの読み込みや切り替えは対象外
  • 複雑なi18nワークフローには適していません
  • 翻訳リソースの適切な設定に依存する

元の README

関連するソースリポジトリの README 原文のスナップショットです。最新の内容はリポジトリをご覧ください。

i18next

build codecov

This is an adaptation of i18next standard for Dart with support for Flutter localization techniques. This package is still a work in progress. Mind that this is still a pre-1.0.0 so breaking changes may occur frequently.

  • [x] Support for variables

  • [x] Support for namespaces

  • [x] Support for context

  • [x] Support for simple plural forms (one or plural)

  • [x] Support for multiple plural forms (one, few, many, plural, ...)

  • [x] Plural and context fallbacks

  • [x] Locale and namespace fallbacks

  • [x] Get string or object tree

  • [x] Support for nesting

  • [x] Flutter's LocalizationsDelegate support

  • [x] Asset bundle localizations data source (retrieves from pubspec.yaml). See the example for more details.

  • [ ] Sprintf support

  • [ ] Resource caching

  • [ ] Custom post-processing

  • [ ] ~Retrieve resource files from server~ (won't do, see https://github.com/williamhjcho/i18next/issues/27)

Usage

Simples way to add the latest version is to run flutter pub add i18next Or you can declare it directly into your pubspec.yaml file:

dependencies:
  i18next: ^0.9.0 # (or the latest version available)

To use it with flutter's LocalizationsDelegate you first create I18NextLocalizationDelegate and register it in your WidgetsApp (MaterialApp or CupertinoApp).

I18NextLocalizationDelegate(
  locales: widget.locales,
  // this data source is from where the delegate will retrieve the localizations from (namespaces Map)
  dataSource: ...,
  // optional extra options can be added here
  options: I18NextOptions(...),
),

Then to access and use it, simply call

Widget build(BuildContext context) {
  // It finds the i18next instance on the widgets tree via `Localizations.of`
  I18Next.of(context).t(...);
  ...
}

But if you want to handle it yourself, then simply instantiate it:

I18Next(
  locale,
  // This store is from where i18next will attempt to retrieve the localizations from.
  resourceStore: ...,
  // Optional extra options can be added here
  options: I18NextOptions(...)
);

Syntax

For the simple and straightforward usages:

{
  "key": "Hello World!",
  "nested": {
    "key": "My nested key"
  }
}
i18next.t('key'); // 'Hello World!'
i18next.t('nested.key'); // 'My nested key'

// unmapped keys usually return themselves (when graceful fallback fails)
i18next.t('unspecifiedKey'); // 'unspecifiedKey'
{
  "key": "Hello {{name}}!",
  "grouped_key": "Hello {{grouped.name}}"
}
i18next.t('key', arguments: {'name': 'World'}); // 'Hello World!'
i18next.t('grouped_key', arguments: {'grouped': {'name': 'Grouped World'}}); // 'Hello Grouped World!'
{
  "nesting1": "1 $t(nesting2)",
  "nesting2": "2 $t(nesting3)",
  "nesting3": "3"
}
i18next.t('nesting1'); // "1 2 3"
{
  "key": "item",
  "key_plural": "items",
  "keyWithCount": "{{count}} item",
  "keyWithCount_plural": "{{count}} items"
}
i18next.t('key', count: 0); // 'items'
i18next.t('key', count: 1); // 'item'
i18next.t('key', count: 5); // 'items'
i18next.t('keyWithCount', count: 0); // '0 items'
i18next.t('keyWithCount', count: 1); // '1 item'
i18next.t('keyWithCount', count: 5); // '5 items'

There are also ways of dealing with locales with multiple plural: zero, one, few, many, others (key identifier) (Unsupported)

  • Contexts like gender, are marked via underscores
{
    "genderMessage": "They",
    "genderMessage_male": "Him",
    "genderMessage_female": "Her"
}
i18next.t('genderMessage'); // 'They'
i18next.t('genderMessage', context: 'male'); // 'Him'
i18next.t('genderMessage', context: 'female'); // 'Her'

And can be used with plurals

{
  "friend": "A friend",
  "friend_plural": "{{count}} friends",
  "friend_male": "A boyfriend",
  "friend_female": "A girlfriend",
  "friend_male_plural": "{{count}} boyfriends",
  "friend_female_plural": "{{count}} girlfriends"
}
i18next.t('friend'); // 'A friend'
i18next.t('friend', count: 1); // 'A friend'
i18next.t('friend', count: 100); // '100 friends'

i18next.t('friend', context: 'male', count: 1); // 'A boyfriend'
i18next.t('friend', context: 'female', count: 1); // 'A girlfriend'
i18next.t('friend', context: 'male', count: 100); // '100 boyfriends'
i18next.t('friend', context: 'female', count: 100); // '100 girlfriends'
{
  "key1": "{{text, uppercase}} just uppercased",
  "key2": "The current date is {{now, datetime(format:dd/MM/yyyy)}}",
  "key3": "Right now we are in {{now, datetime(format:MMM), uppercase}}."
}
i18next.t('key1', arguments: { 'text': 'my text' }); // 'MY TEXT just uppercased'
i18next.t('key2', arguments: { 'now': DateTime.now() }); // 'The current date is 21/01/2020'
i18next.t('key3', arguments: { 'now': DateTime.now() }); // 'Right now we are in JAN.'

There are other usages and possibilities as well, this is just an example of what is defined by this format.

  • Namespaces: A namespace can be thought of as logical groupings of different sets of translations. In a given namespace you could have a set of languages, each with their own set of keys. They can also be understood as separate files. For example:

    • common.json: Things that are reused everywhere, eg. Button labels 'save', 'cancel'
    • validation.json: All validation texts
    • glossary.json: Words we want to be reused consistently inside texts
// common.json
{
  "myKey": "This key is in common"
}

// feature.json
{
  "myKey": "This key is in my feature"
}
i18next.t('common:myKey'); // 'This key is in common'
i18next.t('feature:myKey'); // 'This key is in my feature'
  • Context/plural fallback mechanism:
{
  "friend": "A friend",
  "friend_female": "A girlfriend"
}
i18next.t('friend'); // 'A friend'

i18next.t('friend', count: 1); // 'A friend'
// It fallbacks to `friend` since `friend_plural` is not present
i18next.t('friend', count: 2); // 'A friend'

i18next.t('friend', context: 'female'); // 'A girlfriend'
// It fallbacks to `friend` since `friend_male` is not present
i18next.t('friend', context: 'male'); // 'A friend'

There is a way to also set the default namespace or a order of namespaces so a key knows where to start looking for the translation.

カテゴリー

依存関係

依存関係一覧 2 件

ソースリポジトリ

このパッケージを使用しているプロジェクト