Currency

Updated:

Displays a formatted currency amount.

Properties

Learn more about properties.

amount

The amount you want formatted.

currency

Formats the amount to a specific currency.

locale

Formats to the language provided. Accepts multiple locales in an array as sequential fallbacks.

signDisplay
sign-display

Determine how the positive or negative sign should display.

Behavior:

  • always: Always display the sign.
  • auto: Sign displays for negative numbers only, including negative zero.
  • exceptZero: Sign displays for positive and negative numbers, but not zero.
  • never: Never display the sign.
size

Applies styling based on the size provided. If no size is provided, it will display as inline text.

Methods

The q2-currency element exposes methods that can be used to perform various actions on the component.

Learn more about methods.

displayedMessageValue

Test only

A method to select a tab pane corresponding with the value.

Type signature

displayedMessageValue() => Promise<string>

Release Notes

Initial Release

Accessibility Report

Tecton components are designed and tested to be WCAG compliant when used appropriately, and do not get released without proper validation. Developers should prefer not to set ARIA attributes when using components from the Tecton Design System.

The following CSS variables are available to override the default theme styles of the q2-currencycomponent.