aymericzip/intlayer-solid-js

Intlayer Solid Usage

Core Philosophy

Intlayer promotes Component-Level Content Declaration. Instead of a massive global translation file, content is declared in *.content.ts files adjacent to the Solid components that use them.

Workflow

To create a translated component, you need two files:

1. Declaration: A content file (e.g., myComponent.content.ts) defining the dictionary.
2. Implementation: A Solid component (e.g., MyComponent.tsx) using the useIntlayer hook.

Declare Content

Create a content file using t() for translations. File: src/components/MyComponent/myComponent.content.ts

import { t, type Dictionary } from "intlayer";

const content = {
  // The 'key' must be unique and matches what you pass to useIntlayer()
  key: "my-component",
  content: {
    text: t({
      en: "Welcome",
      fr: "Bienvenue",
      es: "Hola",
    }),
  },
} satisfies Dictionary;

export default content;

Setup

• Vite and Solid

useIntlayer Hook

[!IMPORTANT] In Solid, useIntlayer returns an accessor function (e.g., content()). You must call this function to access the reactive content.

import { useIntlayer } from "solid-intlayer";

const MyComponent = () => {
  const content = useIntlayer("my-component");

  return (
    <div>
      <h1>
        {/* Return content */}
        {content().text}
      </h1>
      {/* Return string (.value) */}
      <img src={content().text.value} alt={content().text.value} />
    </div>
  );
};

References

• Website
• Doc

Environments

• Vite and Solid

Packages

• Solid Intlayer Exports