Skip to main content
cngx-src documentation

withInputAriaLabels

Functionforms/input

projects/forms/input/input-config.ts

Description#

Overrides the built-in ARIA label strings the input directives announce.

  • Unset keys fall back to DEFAULT_INPUT_ARIA_LABELS per key, so a partial override is safe.
  • Library defaults are English; German (or any locale) is consumer-supplied here. Mirrors the select family's withAriaLabels.
  • clear -> CngxInputClear button label.
  • copySuccess / copyError -> CngxCopyValue live-region announcements.
  • otpGroup / otpSlot(index, length) / otpComplete -> CngxOtpInput group, per-slot labels, and completion announcement.
  • capsLockOn -> CngxCapsLock assertive warning.
  • passwordStrength(label) -> CngxPasswordStrength polite announcement.
  • inputRejected -> CngxInputFilter assertive rejection.
  • sensitiveReveal / sensitiveHide -> CngxSensitiveValue reveal/hide announcements.
  • ratingValue(value, max) -> CngxRating polite committed-value announcement.
  • ratingItem(step, max) -> CngxRating per-star radio aria-label.
  • phoneCountry -> CngxPhoneInput country-picker aria-label.
provideInputConfig(
  withInputAriaLabels({ clear: 'Leeren', copySuccess: 'Kopiert' }),
);

Signature#

withInputAriaLabels(labels: Partial)

Parameters#

@paramlabelsPartial

Returns#

InputConfigFeature