useIntlayer Hook Documentation

The useIntlayer hook allows you to retrieve localised content from a dictionary using its key. In Solid, this hook returns reactive content that updates whenever the locale changes.

Usage

import { useIntlayer } from "solid-intlayer";const MyComponent = () => {  const content = useIntlayer("my-dictionary-key");  return (    <div>      <h1>{content.title}</h1>      <p>{content.description}</p>    </div>  );};

Description

The hook performs the following tasks:

1. Locale Detection: It uses the current locale from the IntlayerProvider context.
2. Dictionary Injection: It automatically injects the content of the dictionary corresponding to the provided key, using the optimised declarations generated by the Intlayer compiler.
3. Reactivity: It returns a Solid accessor (Accessor<T>) that automatically re-evaluates when the global locale state changes.
4. Translation Processing: It resolves the content based on the detected locale, processing any t(), enu(), etc. definitions found within the dictionary.

Parameters

• key: The unique key of the dictionary (as defined in your content declaration files).
• locale (optional): Override the current locale.

Returns

An accessor function (() => Content) that returns the localised content.