Skip to content

Currency

Currency is a specific case of Number, where the unit is set to a currency.

Specifications

  • The number always needs a unit (currency). Note that the position of the currency symbol and number changes according to the system locale.

  • Decimals can optionally be displayed.

Implementations

The component Currency is available in the following technologies:

Web Components
webreactvueangular
Native
react_native

Parameters

Parameters

Make sure you have read about the parameters in here.

The parametrization of the component can be done with the following custom params or properties:

NameTypeSlotDescription
amountnumberThe value to be displayed in the currency format.
localestring

The locale parameter is used to set the locale of the component. The value must be part of the registered locales in ZDS. If not set, the default locale of the document will be used.

Have a look to the localization mechanisms.

currencystringThe currency to be used for formatting the value.
decimalsnumberThe number of decimals to be displayed.
customobject

A record of key-value pairs to set the CSS custom tokens. It's a complex attribute set as an JS object in stringified JSON format.

Example:

html
<z-currency custom='{"fill":"#06e7a3"}' />

Check the available values in the customization section.

custom-strstring

The stringified version of the custom property. It follows the pattern key:value;key:value;, with the possibility of setting multiple values and spaces between the punctuation characters.

Example:

html
<z-currency custom-str="fill:#06e7a3" />
z-themestring

Sets the theme of the component. The possible values are light and dark.

html
<z-currency z-theme="dark" />

From Figma to code

This component is not available in Figma.

Customization

INFO

Check everything about the customization mechanics in the "How it works" documentation.

No customization tokens yet implemented for this component

...