Skip to main content

Function: useLocalize()

useLocalize(): (key, parameters?) => string

Defined in: packages/react-page-renderer/src/hooks/localize.ts:14

Provides direct access to Dictionary.get function.

Returns

Localized string.

(key, parameters?): string

Retrieves the localization phrase identified by the specified key, evaluates the phrase's placeholder expressions using the provided parameters and returns the result.

Parameters

key

never

The key identifying the localization phrase.

parameters?

ObjectParameters

The map of parameter names to the parameter values to use. Defaults to an empty plain object.

Returns

string

The specified localization phrase with its placeholders evaluated using the provided parameters.

Example

const localize = useLocalize();