Improve this Doc ngMessageFormat

Installation

First, get the file:

• Google CDN e.g.

  "//ajax.googleapis.com/ajax/libs/angularjs/X.Y.Z/angular-message-format.js"

• NPM e.g.

  npm install --save [email protected]

  or

  yarn add [email protected]

• Bower e.g.

  bower install angular-message-format#X.Y.Z

• code.angularjs.org (discouraged for production use) e.g.

  "//code.angularjs.org/X.Y.Z/angular-message-format.js"

where X.Y.Z is the AngularJS version you are running.

Then, include angular-message-format.js in your HTML:

<script src="path/to/angular.js"></script>
<script src="path/to/angular-message-format.js"></script>

Finally, load the module in your application by adding it as a dependent module:

angular.module('app', ['ngMessageFormat']);

With that you're ready to get started!

What is ngMessageFormat?

The ngMessageFormat module extends the AngularJS $interpolate service with a syntax for handling pluralization and gender specific messages, which is based on the ICU MessageFormat syntax.

See the design doc for more information.

Examples

Gender

This example uses the "select" keyword to specify the message based on gender.

Plural

This example shows how the "plural" keyword is used to account for a variable number of entities. The "#" variable holds the current number and can be embedded in the message.

Note that "=1" takes precedence over "one".

The example also shows the "offset" keyword, which allows you to offset the value of the "#" variable.

Plural and Gender together

This example shows how you can specify gender rules for specific plural matches - in this case, =1 is special cased for gender.