solid-intlayer

This package is in development.

solid-intlayer: Internationalize (i18n) an Solid application

Intlayer is a suite of packages designed specifically for JavaScript developers. It is compatible with frameworks like Solid, Svelte, and Express.js.

The solid-intlayer package allows you to internationalize your Solid application. It provides context providers and hooks for Solid internationalization.

Why Internationalize Your Solid Application?

Internationalizing your Solid application is essential for serving a global audience effectively. It allows your application to deliver content and messages in the preferred language of each user. This capability enhances user experience and broadens your application's reach by making it more accessible and relevant to people from different linguistic backgrounds.

Why to integrate Intlayer?

• JavaScript-Powered Content Management: Harness the flexibility of JavaScript to define and manage your content efficiently.
• Type-Safe Environment: Leverage TypeScript to ensure all your content definitions are precise and error-free.
• Integrated Content Files: Keep your translations close to their respective components, enhancing maintainability and clarity.

Installation

Install the necessary package using your preferred package manager:

npm install solid-intlayer

yarn add solid-intlayer

pnpm add solid-intlayer

Example of usage

With Intlayer, you can declare your content in a structured way anywhere in your codebase.

By default, Intlayer scans for files with the extension .content.{json,ts,tsx,js,jsx,mjs,mjx,cjs,cjx}.

You can modify the default extension by setting the contentDir property in the configuration file.

.
├── intlayer.config.ts
└── src
    └── components
        ├── Component1
        │   ├── index.content.ts
        │   └── index.solid
        └── Component2
            ├── index.content.ts
            └── index.solid

Declare your content

solid-intlayer is made to work with the intlayer package.intlayer is a package that allows you to declare your content anywhere in your code. It converts multilingual content declarations into structured dictionaries that integrate seamlessly into your application.

Here’s an example of content declaration:

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

const component1Content = {
  key: "component-1",
  content: {
    myTranslatedContent: t({
      en: "Hello World",
      fr: "Bonjour le monde",
      es: "Hola Mundo",
    }),
    numberOfCar: enu({
      "<-1": "Less than minus one car",
      "-1": "Minus one car",
      "0": "No cars",
      "1": "One car",
      ">5": "Some cars",
      ">19": "Many cars",
    }),
  },
} satisfies Dictionary;

export default component1Content;

Utilize Content in Your Code

...

Mastering the internationalization of your Solid application

Intlayer provides a lot of features to help you internationalize your Solid application.

To learn more about these features, refer to the Solid Internationalization (i18n) with Intlayer and Vite and Solid guide for Vite and Solid Application, or the Solid Internationalization (i18n) with Intlayer and Solid (CRA) guide for Solid Create App.

Functions provided by solid-intlayer package

The solid-intlayer package also provides some functions to help you to internationalize your application.

Read about Intlayer

• Intlayer Website

• Intlayer Documentation

• Intlayer GitHub

• Ask your questions to our smart documentation