I18nPluralPipe - Angular

Maps a value to a string that pluralizes the value according to locale rules.

Pipe usage

{{ value_expression | i18nPlural:pluralMap:locale }}

API

class I18nPluralPipe implements PipeTransform {
  constructor(_localization: NgLocalization): I18nPluralPipe;
  transform(value: number | null | undefined, pluralMap: { [count: string]: string; }, locale?: string | undefined): string;
}

constructor

I18nPluralPipe

@param_localizationNgLocalization

@returnsI18nPluralPipe

transform

string

@paramvaluenumber | null | undefined

the number to be formatted

@parampluralMap{ [count: string]: string; }

an object that mimics the ICU format, see https://unicode-org.github.io/icu/userguide/format_parse/messages/.

@paramlocalestring | undefined

a string defining the locale to use (uses the current LOCALE_ID by default).

@returnsstring

Description

Maps a value to a string that pluralizes the value according to locale rules.

Exported by

CommonModule

Usage Notes

Example

@Component({
  selector: 'i18n-plural-pipe',
  imports: [I18nPluralPipe],
  template: `<div>{{ messages.length | i18nPlural: messageMapping }}</div>`,
})
export class I18nPluralPipeComponent {
  messages: any[] = ['Message 1'];
  messageMapping: {[k: string]: string} = {
    '=0': 'No messages.',
    '=1': 'One message.',
    'other': '# messages.',
  };
}