ICU4X

Welcome to the home page for the ICU4X project.

ICU4X provides components enabling wide range of software internationalization. It draws deeply from the experience of ICU4C, ICU4J and ECMA-402 and relies on data from the CLDR project.

The design goals of ICU4X are:

Small and modular code
Pluggable locale data
Availability and ease of use in multiple programming languages
Written by internationalization experts to encourage best practices

Stay informed! Join our public, low-traffic mailing list: icu4x-announce@unicode.org. Note: After subscribing, check your spam folder for a confirmation.

Documentation

For an introduction to the project, please visit the "Introduction to ICU4X for Rust" tutorial. Further tutorials can be found in the tutorial index.

For technical information on how to use ICU4X, visit our API docs (latest stable) or API docs (tip of main).

More information about the project can be found in the documents subdirectory.

Quick Start

An example ICU4X powered application in Rust may look like below...

Cargo.toml:

[dependencies]
icu = "1.5.0"

src/main.rs:

use icu::calendar::DateTime;
use icu::datetime::{DateTimeFormatter, NeoSkeletonLength, fieldset::YMDHMS};
use icu::locale::locale;

let dtf = DateTimeFormatter::try_new(
    &locale!("es").into(),
    YMDHMS::long()
)
.expect("locale should be present in compiled data");

let date = DateTime::try_new_iso(2020, 9, 12, 12, 35, 0).expect("datetime should be valid");
let date = date.to_any();

let formatted_date = dtf.convert_and_format(&date).to_string_lossy();
assert_eq!(
    formatted_date,
    "12 de septiembre de 2020, 12:35:00"
);

Development

ICU4X is developed by the ICU4X Technical Committee (ICU4X-TC) in the Unicode Consortium. The ICU4X-TC leads strategy and development of internationalization solutions for modern platforms and ecosystems, including client-side and resource-constrained environments. See unicode.org for more information on our governance.

ICU4X-TC convenes approximately once per quarter in advance of ICU4X releases. Most work in the interim takes place in the ICU4X Working Group (ICU4X WG), which makes technical recommendations, lands them in the repository, and records them in CHANGELOG.md. The recommendations of ICU4X WG are subject to approval by the ICU4X-TC.

Please subscribe to this repository to participate in discussions. If you want to contribute, see our contributing.md.

Charter

For the full charter, including answers to frequently asked questions, see charter.md.

ICU4X is a new project whose objective is to solve the needs of clients who wish to provide client-side internationalization for their products in resource-constrained environments.

ICU4X, or "ICU for X", will be built from the start with several key design constraints:

Small and modular code.
Pluggable locale data.
Availability and ease of use in multiple programming languages.
Written by internationalization experts to encourage best practices.

ICU4X will provide an ECMA-402-compatible API surface in the target client-side platforms, including the web platform, iOS, Android, WearOS, WatchOS, Flutter, and Fuchsia, supported in programming languages including Rust, JavaScript, Objective-C, Java, Dart, and C++.

Licensing and Copyright

The project is released under LICENSE, the free and open-source Unicode License, which is based on the well-known MIT license, with the primary difference being that the Unicode License expressly covers data and data files, as well as code. For further information please see The Unicode Consortium Intellectual Property, Licensing, and Technical Contribution Policies.

A CLA is required to contribute to this project - please refer to the CONTRIBUTING.md file (or start a Pull Request) for more information.