Number

When displaying numbers:

• Decimals can be optionally displayed. Note that some countries use “,” and some others use “.” to separate decimals. This will depend on system locale.

• If needed, you can include units (km, gb, etc...). The unit can be displayed either in long, short, or narrow format. Note that pluralization is integrated.

Implementations

The component Number 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 [required]	number		The value to be displayed.
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.
unit	string		It follows the format <unit><?:unitDisplay> where the two components are: unit: The unit to be displayed. It can be any of the units supported by the Intl.NumberFormat API plus some extra ones with limitations. unitDisplay: (optional) The unit display format. It can be either long, short, or narrow. The physical unit to be displayed are: acacre bitbit bytebyte °Ccelsius m³cubic-meter daysday degdegree °Ffahrenheit ftfoot galgallon Gbgigabit GBgigabyte ggram hahectare hrhour ininch kbkilobit kBkilobyte kgkilogram kmkilometer km/hkilometer-per-hour Lliter Mbmegabit MBmegabyte mmeter m/smeter-per-second m/msmeter-per-millisecond mimile mLmilliliter mmmillimeter msmillisecond minminute mthsmonth ozounce %percent PBpetabyte lbpound secsecond m²square-meter ststone Tbterabit TBterabyte wksweek ydyard yrsyear Attention! The long option for square-* and cubic-* amounts are only supported for English locales.
truncate	boolean		The number will be truncated.
compact	boolean		The number will be displayed in a compact format.
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-number 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-number custom-str="fill:#06e7a3" />
z-theme	string		Sets the theme of the component. The possible values are light and dark. <z-number 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