intlayer-solid ยท diff
v8.1.2 to git:20260218.9e3308f
57 added, 27 removed. Audit A to A.
---
name: intlayer-solid-js
- description: Integrates Intlayer internationalization with SolidJS components. Use when the user asks to "setup SolidJS i18n", use the "useIntlayer" hook in Solid, or manage locales in a SolidJS application.
+ description: Integrates Intlayer internationalization with SolidJS components. Use when the user asks to "setup SolidJS i18n", create a new translated component, use the "useIntlayer" hook in Solid, or configure providers.
metadata:
- author: Intlayer
- url: https://intlayer.org
- license: Apache-2.0
- mcp-server: @intlayer/mcp
- category: productivity
- tags: [i18n]
- documentation: https://intlayer.org/doc
- support: contact@intlayer.org
- version: 8.1.2
+ author: Intlayer
+ url: https://intlayer.org
+ license: Apache-2.0
+ mcp-server: "@intlayer/mcp"
+ category: productivity
+ tags: [i18n, solid, vite]
+ documentation: https://intlayer.org/doc
+ support: contact@intlayer.org
---
# 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`
+
+ ```typescript
+ 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](https://intlayer.org/doc/environment/vite-and-solid.md)
+ - [Vite and Solid](references/environment_vite-and-solid.md)
## useIntlayer Hook
> [!IMPORTANT]
> In Solid, `useIntlayer` returns an **accessor** function (e.g., `content()`). You must call this function to access the reactive content.
```tsx
import { useIntlayer } from "solid-intlayer";
const MyComponent = () => {
- const content = useIntlayer("my-dictionary-key");
+ const content = useIntlayer("my-component");
return (
<div>
- <h1>{content().title}</h1>
- <p>{content().description}</p>
+ <h1>
+ {/* Return content */}
+ {content().text}
+ </h1>
+ {/* Return string (.value) */}
+ <img src={content().text.value} alt={content().text.value} />
</div>
);
};
```
- ## useLocale Hook
+ ## References
- ```tsx
- import { useLocale } from "solid-intlayer";
- import { Locales } from "intlayer";
+ ### Environments
- const LocaleSwitcher = () => {
- const { setLocale } = useLocale();
+ - [Vite and Solid](references/environment_vite-and-solid.md)
- return (
- <button onClick={() => setLocale(Locales.ENGLISH)}>
- Change Language to English
- </button>
- );
- };
- ```
+ ### Packages
+
+ - [Solid Intlayer Exports](references/packages_solid-intlayer_exports.md)