Skip to content
/ icu4x Public
forked from unicode-org/icu4x

Solving i18n for client-side and resource-constrained environments.

License

Notifications You must be signed in to change notification settings

aethanyc/icu4x

 
 

Repository files navigation

ICU4X Docs Build Status Coverage Status (Coveralls) Coverage Status (Codecov)

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: [email protected]. 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 docs subdirectory.

Quick Start

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

Cargo.toml:

[dependencies]
icu = "1.3.0"

src/main.rs:

use icu::calendar::DateTime;
use icu::datetime::{options::length, DateTimeFormatter};
use icu::locid::locale;

let options =
    length::Bag::from_date_time_style(length::Date::Long, length::Time::Medium).into();

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

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

let formatted_date = dtf.format_to_string(&date).expect("formatting should succeed");
assert_eq!(
    formatted_date,
    "12 de septiembre de 2020, 12:35:00"
);

Development

ICU4X is developed by the ICU4X-SC. We are a subcommittee of ICU-TC in the Unicode Consortium focused on providing solutions for client-side internationalization. See unicode.org for more information on our governance.

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:

  1. Small and modular code.
  2. Pluggable locale data.
  3. Availability and ease of use in multiple programming languages.
  4. 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

Copyright © 2020-2023 Unicode, Inc. Unicode and the Unicode Logo are registered trademarks of Unicode, Inc. in the United States and other countries.

The project is released under LICENSE.

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

About

Solving i18n for client-side and resource-constrained environments.

Resources

License

Stars

Watchers

Forks

Packages

No packages published

Languages

  • Rust 98.3%
  • C++ 0.6%
  • Makefile 0.3%
  • HTML 0.3%
  • TypeScript 0.2%
  • C 0.2%
  • Other 0.1%