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

Native

Parameters

Parameters

Parameters are the attributes that can be used to customize the component when using it in a project. They apply to the WebComponents implementation and wrappers and to the Vue and React CSS implementations. Some parameters names change between the implementations, in order to follow the conventions of each technology and framework.

For example, the param model is named ngModel in Angular, modelValue in Vue, but stays as model in React.

By default, all the parameters are optional or can be set in different, except for the ones marked as required

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

Name	Type	Slottable	Description
amount	number		The value to be displayed in the currency format.
locale	string		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.
currency	string		The currency to be used for formatting the value.
decimals	number		The number of decimals to be displayed.
custom	object		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: <z-currency custom='{"fill":"#06e7a3"}' />
custom-str	string		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: <z-currency custom-str="fill:#06e7a3" />
z-theme	string		Sets the theme of the component. The possible values are light and dark. <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

...

Related components