Locale

Implementations

The component Locale is available in the following technologies:

Web Components

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:

Name	Type	Description
`value-key`	`string`	String to point to the value in the locale object. If not provided, the component will render the `unknown` value.
`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.
`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: html `<z-locale custom='{"fill":"#06e7a3"}' />` Check the available values in the customization section.
`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: html `<z-locale custom-str="fill:#06e7a3" />`
`z-theme`	`string`	Sets the theme of the component. The possible values are `light` and `dark`. html `<z-locale z-theme="dark" />`

This component is not available in Figma.

INFO

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

CSS Variable	Type	Description
`--z-locale--color`	`color`	The color of the date

...