csv_localizations 1.7.0+1 csv_localizations: ^1.7.0+1 copied to clipboard
A minimal CSV localization package built on LocalizationsDelegate.
csv_localizations #
A minimal CSV localization package for Flutter.
Store translations for multiple languages in a single CSV file.
One language per column - one translation per row.
Install #
Add csc_localizations
and flutter_localizations
to your pubspec.yaml
.
dependencies:
flutter_localizations:
sdk: flutter
csv_localizations: <last-version>
Add a single CSV file asset to your pubspec.yaml
.
flutter:
assets:
- assets/translations.csv
Add CsvLocalizationsDelegate
and supported locales to MaterialApp
.
MaterialApp(
localizationsDelegates: [
// delegate from flutter_localization
GlobalMaterialLocalizations.delegate,
GlobalWidgetsLocalizations.delegate,
GlobalCupertinoLocalizations.delegate,
// delegate from csv_localizations
CsvLocalizationsDelegate(path: 'assets/translations.csv'),
],
supportedLocales: [
Locale('en'),
Locale('nb'),
],
}
Note on iOS #
Add supported locales to ios/Runner/Info.plist
as described here
Example:
<key>CFBundleLocalizations</key>
<array>
<string>en</string>
<string>nb</string>
</array>
Format #
First row are supported language/country codes. First column are keys for localized values.
key | en | nb |
---|---|---|
Hi | Hi | Hei |
Dog | Dog | Hund |
Cat | Cat | Cat |
Tip keys can point to local assets like images
Example file:
key,en,nb
Hi,Hi,Hei
Dog,Dog,Hund
Cat,Cat,Katt
my_img,assets/en.png,assets/nb.png
Tip wrap multiline strings in quotation marks
API #
Translate text using:
CsvLocalizations.instance.string('Hi')
or add a String
extension:
Note: we don't want to pollute the String API by default
extension LocalizedString on String {
String tr(BuildContext context) => CsvLocalizations.instance.string(this);
}
We use \n
as the default end-of-line char, but you can change this via CsvLocalizations.instance.eol
Example #
See example.