sealed_languages 1.5.1

Provides data for world languages in the form of sealed classes.

This ISO-driven, pure Dart, fully tested and dependency-free package provides information about world languages in the form of compile-time, tree-shakable constant sealed classes. Contains the all 184 languages with ISO 639-1 codes, also provides ISO 639-2 codes, their English, native names, language family info, language name translations, etc. For Flutter ready widgets (like language picker) please use world_countries package.

Features

NaturalLanguage class provides the following information about languages:

Field	Required	Description	Example for LangEng
name	Yes	A non-empty string representing the English name of the natural language.	"English"
code	Yes	A three-letter string representing the ISO 639-2/T Terminological code for the language.	"ENG"
codeShort	Yes	A two-letter string representing the ISO 639-1 code for the language.	"EN"
namesNative	Yes	A list of non-empty strings representing the language's native names.	["English"]
bibliographicCode	No	A three-letter string representing the ISO 639-2/B Bibliographic code for the language.	null
family	No	The language family to which the language belongs.	LanguageFamily(name: "Indo-European")
isRightToLeft	No	A boolean value specifying whether the language is written right-to-left.	false
translations	Yes	A list of TranslatedNames representing the language name translations.	140+ translations for a English language name

Compile time constant list of all languages accessible via NaturalLanguage.list and more over, the NaturalLanguage class provides the following methods/constructors:

• permissive - allows the creation of custom class instances that are not fully compatible with the ISO standard.
• maybeFromValue - returns a language instance if the value matches the provided value, otherwise returns null.
• maybeFromAnyCode - returns a language instance if the value matches any ISO code, otherwise returns null.
• maybeFromCode - returns a language instance if the value matches the provided ISO 639-2 code, otherwise returns null.
• maybeFromCodeShort - returns a language instance if the value matches the provided ISO 639-1 code code, otherwise returns null.
• fromCode - returns a language instance if the value matches the provided ISO 639-2 code.
• fromCodeShort - returns a language instance if the value matches the provided ISO 639-1 code code.
• fromAnyCode - returns a language instance if the value matches the provided ISO 639-1 or ISO 639-2 codes.
• fromName - returns a language instance if the value matches the provided name.

and (thanks to sealed nature of the class) functional-style like methods: whenOrNull, maybeWhen, when, map, maybeMap and is* boolean getters. You can also find a lot of common method you may know from Dart ecosystem - toString overrides, copyWith, toJson, etc. Also a compile time const, tree-shakable, code maps (for a 0(1) access time code mapping), list and much more.

Translations: Use maybeTranslation() or translation() methods to get translations for specific locale.

Getting started

To use this package, add sealed_languages as a dependency in your pubspec.yaml file.

dependencies:
  sealed_languages: any

Then import the package in your Dart code:

import 'package:sealed_languages/sealed_languages.dart';

Usage

Use NaturalLanguage class to get information about languages. Either construct a new instance directly or with use of the class factory constructors/static methods or select one from the NaturalLanguage.list constant.

  const eng = "Eng";
  final fromCode = NaturalLanguage.fromCode(eng);
  /// Equivalent of NaturalLanguage.map[eng];
  print("${fromCode.name}: ${fromCode.codeShort}"); // Prints: "English: EN".
  print(fromCode.isEng); // Prints: "true".

 final script = Script.fromCodeNumeric("215");
 /// Equivalent of Script.codeNumericMap["215"];
 print("${script.name}: ${script.code}"); // Prints: "Latin: Latn".

 final maybeCzech = NaturalLanguage.maybeFromValue(
   "CZE",
   where: (language) => language.bibliographicCode,
 );

 // This will print: "Native name: čeština".
 print("Native name: ${maybeCzech?.namesNative.first}");

 final indoEuropeanLanguages = NaturalLanguage.list.where(
   (language) => language.family is IndoEuropean,
 );
 // Prints a list of Indo-European languages:
 print(indoEuropeanLanguages);
 // (Language(name: Avestan), Language(name: Afrikaans),
 // ...
 // Language(name: Walloon), Language(name: Yiddish).

 // Prints Slovak translations of all available languages.
 for (final language in NaturalLanguage.list) {
   print(
     "Slovak name of ${language.name}: "
     "${language.maybeTranslation(const BasicLocale(LangSlk()))?.name}",
   );
 }

For more usage examples, please see the /example folder.

FAQ

Why should I use this package over any other language-related package?

• Sealed classes: This package provides data in the form of sealed classes, allowing you to create your own instances and work with them as with existing ones (for example this is not possible with enums or regular classes (without losing it's sealed nature), you can also override existing or add new data, etc.).
• No 3rd-party dependencies: This package has no third-party dependencies, ensuring that you won't have any issues or conflicts with other dependencies (no even meta here, because of that).
• Rich data: This package offers far more data than any other package + tons of translations (all GlobalMaterialLocalizations and GlobalCupertinoLocalizations locales and more).
• Type-safe: The contracts and types in this package are exceptionally strong, ensuring that your code is strongly typed and well-defined.
• High code coverage: The code in this package has 100% code coverage, with more than 1533 tests, providing confidence in its reliability and stability.
• Comprehensive documentation: This package provides full documentation for every non-code generated public member, usually with examples, ensuring clarity and ease of use.
• Industry adopted: This package is actively used in production by numerous European companies, ensuring its efficacy and robustness in real-world scenarios.
• MIT license: This package and sources are released under the MIT license, which is a permissive license that allows users to use, modify, and distribute the code with minimal restrictions. The MIT license is considered better than most other open-source licenses because it provides flexibility and allows users to incorporate the code into their projects without worrying about legal implications.

Additional information

If you like this package, please give it a star or like. For more information on using this package, check out the API documentation. PRs or ideas are always welcome. If you have any issues or suggestions for the package, please file them in the GitHub repository.

References, credits and sources

• ISO
• Wikipedia
• Data Source¹
• Primary Translations Source
• Secondary Translations Source
• Project Roadmap