atomic-format-unit (Deprecated)

This is for:

Developer

In this article

Properties

Atomic v1 has been deprecated. We recommend using the latest version of the Coveo Atomic library.

The atomic-format-unit component is used for formatting numbers with units. The numerical format of compatible parents will be set according to the properties of this component.

Go to the interactive example

Properties

Property Attribute Description Type Default

Property	Attribute	Description	Type	Default
`unit` (required)	`unit`	The unit to use in unit formatting. Leverages the Intl.NumberFormat constructor. The unit must be sanctioned unit identifier	`string`
`unitDisplay`	`unit-display`	The unit formatting style to use in unit formatting. "long" (for example, 16 litres) "short" (for example, 16 l) "narrow" (for example, 16l)	`"long" \| "narrow" \| "short" \| undefined`	`'short'`

unit (required)

unit

The unit to use in unit formatting. Leverages the Intl.NumberFormat constructor. The unit must be sanctioned unit identifier

string

unitDisplay

unit-display

The unit formatting style to use in unit formatting.

"long" (for example, 16 litres)
"short" (for example, 16 l)
"narrow" (for example, 16l)

"long" | "narrow" | "short" | undefined

'short'