Intl

https://pub.dev/packages/intl
Admin
Intl is a Dart package that provides internationalization and localization facilities, including...
Tokens:11,972
Snippets:100
Trust Score:9.9
Update:1 day ago
Show doc for...
Tokens:
Raw
### Intl.message with parameters and examples

Source: https://pub.dev/packages/intl

Shows a message function with a parameter used in the string and an examples map for translators. The name and args must match the function signature.

```dart
greetingMessage(name) => Intl.message(
    'Hello $name!',
    name: 'greetingMessage',
    args: [name],
    desc: 'Greet the user as they first open the application',
    examples: const {'name': 'Emily'});
print(greetingMessage('Dan'));
```

--------------------------------

### Get locale from browser with findSystemLocale

Source: https://pub.dev/packages/intl

Imports intl_browser.dart and calls findSystemLocale() to obtain the browser's locale, then continues program execution in the callback.

```dart
import 'package:intl/intl_browser.dart';
...
findSystemLocale().then(runTheRestOfMyProgram);
```

--------------------------------

### Intl.gender message

Source: https://pub.dev/packages/intl

Uses Intl.gender to handle gender-specific messages. The examples map is a list of maps, each with a gender and a name.

```dart
notOnlineMessage(String userName, String userGender) =>
  Intl.gender(
    userGender,
    male: '$userName is unavailable because he is not online.',
    female: '$userName is unavailable because she is not online.',
    other: '$userName is unavailable because they are not online',
    name: 'notOnlineMessage',
    args: [userName, userGender],
    desc: 'The user is not available to hangout.',
    examples: const {{'userGender': 'male', 'userName': 'Fred'},
        {'userGender': 'female', 'userName' : 'Alice'}});
```

--------------------------------

### Format dates with DateFormat skeletons and patterns

Source: https://pub.dev/packages/intl

Shows formatting a DateTime using a skeleton and explicit patterns with different locales. The output for each is shown in comments.

```dart
DateFormat.yMMMMEEEEd().format(aDateTime);
  ==> 'Wednesday, January 10, 2012'
DateFormat('EEEEE', 'en_US').format(aDateTime);
  ==> 'Wednesday'
DateFormat('EEEEE', 'ln').format(aDateTime);
  ==> 'mokɔlɔ mwa mísáto'
```

--------------------------------

### Generate locale libraries with generate_from_arb.dart

Source: https://pub.dev/packages/intl

Run this command to generate Dart libraries for each locale from translated ARB files. The --generated_file_prefix flag sets the prefix for the generated files.

```console
> pub run intl_translation:generate_from_arb --generated_file_prefix=<prefix>
    <my_dart_files> <translated_ARB_files>
```

--------------------------------

### Initialize date formatting data for a locale

Source: https://pub.dev/packages/intl

Imports the date symbol data library and calls initializeDateFormatting to load locale data before formatting dates. The future must complete before formatting data is available.

```dart
import 'package:intl/date_symbol_data_local.dart';
...
initializeDateFormatting('de_DE', null).then(formatDates);
```

--------------------------------

### Initialize messages for a locale

Source: https://pub.dev/packages/intl

Import the generated messages file and call initializeMessages with the locale code. The returned future ensures message data is available before printing.

```dart
import 'my_prefix_messages_all.dart';
...
initializeMessages('dk').then(printSomeMessages);
```

--------------------------------

### Combine skeletons to format date and time

Source: https://pub.dev/packages/intl

Combines a date skeleton with a time skeleton to print a full date and time. The output is shown in a comment.

```dart
DateFormat.yMEd().add_jms().format(DateTime.now());
  ==> 'Thu, 5/23/2013 10:21:47 AM'
```

--------------------------------

### Format a number with NumberFormat

Source: https://pub.dev/packages/intl

Creates a NumberFormat instance with a pattern and locale, then formats a number. The locale parameter is optional; if omitted, the current locale is used.

```dart
var f = NumberFormat('###.0#', 'en_US');
print(f.format(12.345));
  ==> 12.35
```

--------------------------------

### Basic Intl.message function

Source: https://pub.dev/packages/intl

Defines a simple message with a name, description, and empty args list. The function can be called before translation and returns the original string.

```dart
String continueMessage() => Intl.message(
    'Hit any key to continue',
    name: 'continueMessage',
    args: [],
    desc: 'Explains that we will not proceed further until '
        'the user presses a key');
print(continueMessage());
```

--------------------------------

### Extract messages with extract_to_arb.dart

Source: https://pub.dev/packages/intl

Run this command to extract messages from Dart files into an intl_messages.arb file. The --output-dir flag specifies the target directory.

```console
> pub run intl_translation:extract_to_arb --output-dir=target/directory
    my_program.dart more_of_my_program.dart
```

--------------------------------

### Set default locale and use DateFormat.jm

Source: https://pub.dev/packages/intl

Sets the default locale to 'es' and then formats the current time using the short time format.

```dart
Intl.defaultLocale = 'es';
DateFormat.jm().format(DateTime.now());
```

--------------------------------

### Parse dates with DateFormat

Source: https://pub.dev/packages/intl

Parses date strings using skeletons and patterns with a specified locale.

```dart
DateFormat.yMd('en_US').parse('1/10/2012');
DateFormat('Hms', 'en_US').parse('14:23:01');
```

--------------------------------

### Create DateFormat with specific locale

Source: https://pub.dev/packages/intl

Creates a DateFormat object for the 'ar' locale and formats the current date/time.

```dart
var format = DateFormat.yMd('ar');
var dateString = format.format(DateTime.now());
```

--------------------------------

### Set global locale with Intl.defaultLocale

Source: https://pub.dev/packages/intl

Sets the package-wide default locale to 'pt_BR'. All subsequent operations use this locale unless overridden.

```dart
Intl.defaultLocale = 'pt_BR';
```

--------------------------------

### BidiFormatter RTL wrapWithUnicode and wrapWithSpan

Source: https://pub.dev/packages/intl

Use BidiFormatter.RTL() to wrap a string with Unicode directional indicators or an HTML span for right-to-left text. The constructors RTL and LTR specify direction, or it can be detected from the text.

```dart
BidiFormatter.RTL().wrapWithUnicode('xyz');
BidiFormatter.RTL().wrapWithSpan('xyz');
```

--------------------------------

### Intl.plural without Intl.message wrapper

Source: https://pub.dev/packages/intl

Alternative top-level plural usage where Intl.plural is called directly, omitting the Intl.message wrapper and passing its parameters to Intl.plural.

```dart
remainingEmailsMessage(int howMany, String userName) =>
  Intl.plural(
    howMany,
    zero: 'There are no emails left for $userName.',
    one: 'There is $howMany email left for $userName.',
    other: 'There are $howMany emails left for $userName.',
    name: 'remainingEmailsMessage',
    args: [howMany, userName],
    desc: 'How many emails remain after archiving.',
    examples: const {'howMany': 42, 'userName': 'Fred'});
```

--------------------------------

### Override locale for an operation with Intl.withLocale

Source: https://pub.dev/packages/intl

Runs a specific operation using the 'fr' locale, overriding the defaultLocale for the duration of the operation. Note that async tasks spawned from the operation also use this locale.

```dart
Intl.withLocale('fr', () => print(myLocalizedMessage()));
```

--------------------------------

### Access number symbol data

Source: https://pub.dev/packages/intl

Accesses the number symbol data for the current locale, which provides separator characters, patterns, and other formatting information.

```dart
f.symbols
```

--------------------------------

### Pass locale as parameter to method

Source: https://pub.dev/packages/intl

Passes the locale 'ar' directly to a method call, overriding the default locale for that operation.

```dart
print(myMessage(dateString, locale: 'ar');
```

--------------------------------

### Intl.plural inside Intl.message

Source: https://pub.dev/packages/intl

Uses Intl.plural within an Intl.message to handle plural forms. The message string uses a triple-quoted string with interpolation.

```dart
remainingEmailsMessage(int howMany, String userName) =>
  Intl.message(
    '''${Intl.plural(howMany,
        zero: 'There are no emails left for $userName.',
        one: 'There is $howMany email left for $userName.',
        other: 'There are $howMany emails left for $userName.')}''',
  name: 'remainingEmailsMessage',
  args: [howMany, userName],
  desc: 'How many emails remain after archiving.',
  examples: const {'howMany': 42, 'userName': 'Fred'});

print(remainingEmailsMessage(1, 'Fred'));
```
Tokens:
Raw