Interface CharacterCountTranslations

Messages shown to users as they type. It provides feedback on how many words or characters they have remaining or if they are over the limit. This also includes a message used as an accessible description for the textarea.

interface CharacterCountTranslations {
    charactersAtLimit?: string;
    charactersOverLimit?: TranslationPluralForms;
    charactersUnderLimit?: TranslationPluralForms;
    textareaDescription?: TranslationPluralForms;
    wordsAtLimit?: string;
    wordsOverLimit?: TranslationPluralForms;
    wordsUnderLimit?: TranslationPluralForms;
}

Properties

charactersAtLimit? charactersOverLimit? charactersUnderLimit? textareaDescription? wordsAtLimit? wordsOverLimit? wordsUnderLimit?

Properties

OptionalcharactersAtLimit

charactersAtLimit?: string

Message displayed when the number of characters reaches the configured maximum, maxlength. This message is displayed visually and through assistive technologies.

OptionalcharactersOverLimit

charactersOverLimit?: TranslationPluralForms

Message displayed when the number of characters is over the configured maximum, maxlength. This message is displayed visually and through assistive technologies. The component will replace the %{count} placeholder with the number of remaining characters. This is a pluralised list of messages.

OptionalcharactersUnderLimit

charactersUnderLimit?: TranslationPluralForms

Message displayed when the number of characters is under the configured maximum, maxlength. This message is displayed visually and through assistive technologies. The component will replace the %{count} placeholder with the number of remaining characters. This is a pluralised list of messages.

OptionaltextareaDescription

textareaDescription?: TranslationPluralForms

Message made available to assistive technologies, if none is already present in the HTML, to describe that the component accepts only a limited amount of content. It is visible on the page when JavaScript is unavailable. The component will replace the %{count} placeholder with the value of the maxlength or maxwords parameter.

OptionalwordsAtLimit

wordsAtLimit?: string

Message displayed when the number of words reaches the configured maximum, maxlength. This message is displayed visually and through assistive technologies.

OptionalwordsOverLimit

wordsOverLimit?: TranslationPluralForms

Message displayed when the number of words is over the configured maximum, maxlength. This message is displayed visually and through assistive technologies. The component will replace the %{count} placeholder with the number of remaining words. This is a pluralised list of messages.

OptionalwordsUnderLimit

wordsUnderLimit?: TranslationPluralForms

Message displayed when the number of words is under the configured maximum, maxlength. This message is displayed visually and through assistive technologies. The component will replace the %{count} placeholder with the number of remaining words. This is a pluralised list of messages.

Settings

Member Visibility

On This Page

Properties