vue-intlayer 6.0.2 → 6.1.1

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
package/README.md CHANGED
@@ -1,161 +1,276 @@
1
- <div align="center">
2
- <a href="https://intlayer.org">
3
- <img src="https://raw.githubusercontent.com/aymericzip/intlayer/572ae9c9acafb74307b81530c1931a8e98990aef/docs/assets/logo.png" width="500" alt="intlayer" />
1
+ <p align="center">
2
+ <a href="https://intlayer.org" rel="">
3
+ <img src="https://raw.githubusercontent.com/aymericzip/intlayer/main/docs/assets/cover.png" width="60%" alt="Intlayer Logo" />
4
4
  </a>
5
- </div>
6
-
7
- <div align="center">
8
- <a href="https://www.npmjs.com/package/vue-intlayer" target="blank"><img
9
- align="center"
10
- alt="npm"
11
- src="https://img.shields.io/npm/v/vue-intlayer.svg?labelColor=49516F&color=8994BC&style=for-the-badge"
12
- height="30" /></a>
13
- <a href="https://npmjs.org/package/vue-intlayer" target="blank"><img
14
- align="center"
15
- src="https://img.shields.io/npm/dm/vue-intlayer?labelColor=49516F&color=8994BC&style=for-the-badge"
16
- alt="monthly downloads"
17
- height="30"
18
- /></a>
19
- <a href="https://npmjs.org/package/vue-intlayer" target="blank"><img
20
- align="center"
21
- src="https://img.shields.io/npm/types/vue-intlayer?label=types%20included&labelColor=49516F&color=8994BC&style=for-the-badge"
22
- alt="types included"
23
- height="30"
24
- /></a>
25
- </div>
26
-
27
- <div>
28
- <br/>
29
- <p align="center">
30
- <a href="https://discord.gg/528mBV4N" target="blank"><img align="center"
31
- src="https://img.shields.io/badge/discord-5865F2.svg?style=for-the-badge&logo=discord&logoColor=white"
32
- alt="Intlayer Discord" height="30"/></a>
33
- <a href="https://www.linkedin.com/company/intlayerorg" target="blank"><img align="center"
34
- src="https://img.shields.io/badge/linkedin-%231DA1F2.svg?style=for-the-badge&logo=linkedin&logoColor=white"
35
- alt="Intlayer LinkedIn" height="30"/></a>
36
- <a href="https://www.facebook.com/intlayer" target="blank"><img align="center"
37
- src="https://img.shields.io/badge/facebook-4267B2.svg?style=for-the-badge&logo=facebook&logoColor=white"
38
- alt="Intlayer Facebook" height="30"/></a>
39
- <a href="https://www.instagram.com/intlayer/" target="blank"><img align="center"
40
- src="https://img.shields.io/badge/instagram-%23E4405F.svg?style=for-the-badge&logo=Instagram&logoColor=white"
41
- alt="Intlayer Instagram" height="30"/></a>
42
- <a href="https://x.com/Intlayer183096" target="blank"><img align="center"
43
- src="https://img.shields.io/badge/x-1DA1F2.svg?style=for-the-badge&logo=x&logoColor=white"
44
- alt="Intlayer X" height="30"/></a>
45
- <a href="https://www.youtube.com/@intlayer" target="blank"><img align="center"
46
- src="https://img.shields.io/badge/youtube-FF0000.svg?style=for-the-badge&logo=youtube&logoColor=white"
47
- alt="Intlayer YouTube" height="30"/></a>
48
- <a href="https://www.tiktok.com/@intlayer" target="blank"><img align="center"
49
- src="https://img.shields.io/badge/tiktok-000000.svg?style=for-the-badge&logo=tiktok&logoColor=white"
50
- alt="Intlayer TikTok" height="30"/></a>
51
- <br>
52
- </p>
53
- </div>
5
+ </p>
6
+
7
+ <h1 align="center">
8
+ <strong> Intlayer : an Open-source, per-component i18n toolkit with AI-powered translation & CMS.</strong>
9
+ </h1>
10
+
11
+ <br />
12
+
13
+ <p align="center">
14
+ <a href="https://intlayer.org/doc/concept/content" rel="">Docs</a> •
15
+ <a href="https://intlayer.org/doc/environment/nextjs" rel="">Next.js</a> •
16
+ <a href="https://intlayer.org/doc/environment/vite-and-react" rel="">React + Vite</a> •
17
+ <a href="https://intlayer.org/doc/concept/cms" rel="">CMS</a> •
18
+ <a href="https://discord.gg/7uxamYVeCk" rel="noopener noreferrer nofollow">Discord</a>
19
+ </p>
20
+ <p align="center" style="margin-top:15px;">
21
+ <a href="https://www.npmjs.com/package/intlayer" target="_blank" rel="noopener noreferrer nofollow"><img src="https://img.shields.io/npm/v/intlayer?style=for-the-badge&labelColor=FFFFFF&color=000000&logoColor=FFFFFF" alt="npm version" height="24"/></a>
22
+ <a href="https://github.com/aymericzip/intlayer/stargazers" target="_blank" rel="noopener noreferrer nofollow"><img src="https://img.shields.io/github/stars/aymericzip/intlayer?style=for-the-badge&labelColor=000000&color=FFFFFF&logo=github&logoColor=FFD700" alt="GitHub Stars" height="24"/></a>
23
+ <a href="https://www.npmjs.org/package/intlayer" target="_blank" rel="noopener noreferrer nofollow"><img src="https://img.shields.io/npm/dm/intlayer?style=for-the-badge&labelColor=000000&color=FFFFFF&logoColor=000000" alt="monthly downloads" height="24"/></a>
24
+ <a href="https://github.com/aymericzip/intlayer/blob/main/LICENSE" target="_blank" rel="noopener noreferrer nofollow"><img src="https://img.shields.io/github/license/aymericzip/intlayer?style=for-the-badge&labelColor=000000&color=FFFFFF&logoColor=000000" alt="license"/></a>
25
+ <a href="https://github.com/aymericzip/intlayer/commits/main" target="_blank" rel="noopener noreferrer nofollow"><img src="https://img.shields.io/github/last-commit/aymericzip/intlayer?style=for-the-badge&labelColor=000000&color=FFFFFF&logoColor=000000" alt="last commit"/>
26
+ </a>
27
+ </p>
54
28
 
55
- > This package is in development.
29
+ ![Watch the video](https://github.com/aymericzip/intlayer/blob/main/docs/assets/demo_video.gif)
56
30
 
57
- # vue-intlayer: Internationalize (i18n) an Vue application
31
+ <a href="https://intlayer.org/doc/concept/content" rel="">
32
+ <img src="https://img.shields.io/badge/Get_Started-FFFFFF?style=for-the-badge&logo=rocket&logoColor=black" />
33
+ </a>
58
34
 
59
- **Intlayer** is a suite of packages designed specifically for JavaScript developers. It is compatible with frameworks like Vue, Svelte, and Express.js.
35
+ ## What is Intlayer?
60
36
 
61
- **The `vue-intlayer` package** allows you to internationalize your Vue application. It provides context providers and hooks for Vue internationalization.
37
+ Most i18n libraries are either too complex, too rigid, or not built for modern frameworks.
62
38
 
63
- ## Why Internationalize Your Vue Application?
39
+ Intlayer is a **modern i18n solution** for web and mobile apps.
40
+ It’s framework-agnostic, **AI-powered**, and includes a free **CMS & visual editor**.
64
41
 
65
- Internationalizing your Vue 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.
42
+ With **per-locale content files**, **TypeScript autocompletion**, **tree-shakable dictionaries**, and **CI/CD integration**, Intlayer makes internationalization **faster, cleaner, and smarter**.
66
43
 
67
- ## Why to integrate Intlayer?
44
+ ## Keys benefits of Intlayer:
68
45
 
69
- - **JavaScript-Powered Content Management**: Harness the flexibility of JavaScript to define and manage your content efficiently.
70
- - **Type-Safe Environment**: Leverage TypeScript to ensure all your content definitions are precise and error-free.
71
- - **Integrated Content Files**: Keep your translations close to their respective components, enhancing maintainability and clarity.
46
+ | Feature | Description |
47
+ | --------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
48
+ | <img src="https://github.com/aymericzip/intlayer/blob/main/docs/assets/frameworks.png?raw=true" alt="Feature" width="700"> | **Cross-Frameworks Support**<br><br>Intlayer is compatible with all major frameworks and libraries, including Next.js, React, Vite, Vue.js, Nuxt, Preact, Express, and more. |
49
+ | <img src="https://github.com/aymericzip/intlayer/blob/main/docs/assets/javascript_content_management.png?raw=true" alt="Feature" width="700"> | **JavaScript-Powered Content Management**<br><br>Harness the flexibility of JavaScript to define and manage your content efficiently. <br><br> - [Content declaration](https://intlayer.org/doc/concept/content) |
50
+ | <img src="https://github.com/aymericzip/intlayer/blob/main/docs/assets/per_locale_content_declaration_file.png?raw=true" alt="Feature" width="700"> | **Per-Locale Content Declaration File**<br><br>Speed up your development by declaring your content once, before auto generation.<br><br> - [Per-Locale Content Declaration File](https://intlayer.org/doc/concept/per-locale-file) |
51
+ | <img src="https://github.com/aymericzip/intlayer/blob/main/docs/assets/autocompletion.png?raw=true" alt="Feature" width="700"> | **Type-Safe Environment**<br><br>Leverage TypeScript to ensure your content definitions and code are error-free, while also benefiting from IDE autocompletion.<br><br> - [TypeScript configuration](https://intlayer.org/doc/environment/vite-and-react#configure-typescript) |
52
+ | <img src="https://github.com/aymericzip/intlayer/blob/main/docs/assets/config_file.png?raw=true" alt="Feature" width="700"> | **Simplified Setup**<br><br>Get up and running quickly with minimal configuration. Adjust settings for internationalization, routing, AI, build, and content handling with ease. <br><br> - [Explore Next.js integration](https://intlayer.org/doc/environment/nextjs) |
53
+ | <img src="https://github.com/aymericzip/intlayer/blob/main/docs/assets/content_retrieval.png?raw=true" alt="Feature" width="700"> | **Simplified Content Retrieval**<br><br>No need to call your `t` function for each piece of content. Retrieve all your content directly using a single hook.<br><br> - [React integration](https://intlayer.org/doc/environment/create-react-app) |
54
+ | <img src="https://github.com/aymericzip/intlayer/blob/main/docs/assets/server_component.png?raw=true" alt="Feature" width="700"> | **Consistent Server Component Implementation**<br><br>Perfectly suited for Next.js server components, use the same implementation for both client and server components, no need to pass your `t` function across each server component. <br><br> - [Server Components](https://intlayer.org/doc/environment/nextjs#step-7-utilize-content-in-your-code) |
55
+ | <img src="https://github.com/aymericzip/intlayer/blob/main/docs/assets/file_tree.png?raw=true" alt="Feature" width="700"> | **Organized Codebase**<br><br>Keep your codebase more organized: 1 component = 1 dictionary in the same folder. Translations close to their respective components, enhance maintainability and clarity. <br><br> - [How Intlayer works](https://intlayer.org/doc/concept/how-works-intlayer) |
56
+ | <img src="https://github.com/aymericzip/intlayer/blob/main/docs/assets/url_routing.png?raw=true" alt="Feature" width="700"> | **Enhanced Routing**<br><br>Full support of app routing, adapting seamlessly to complex application structures, for Next.js, React, Vite, Vue.js, etc.<br><br> - [Explore Next.js integration](https://intlayer.org/doc/environment/nextjs) |
57
+ | <img src="https://github.com/aymericzip/intlayer/blob/main/docs/assets/markdown.png?raw=true" alt="Feature" width="700"> | **Markdown Support**<br><br>Import and interpret, locale files and remote Markdown for multilingual content like privacy policies, documentation, etc. Interpret and make Markdown metadata accessible in your code.<br><br> - [Content files](https://intlayer.org/doc/concept/content/file) |
58
+ | <img src="https://github.com/aymericzip/intlayer/blob/main/docs/assets/visual_editor.png?raw=true" alt="Feature" width="700"> | **Free Visual Editor & CMS**<br><br>A free visual editor and CMS are available for content writers, removing the need for a localization platform. Keep your content synchronized using Git, or externalize it totally or partially with the CMS.<br><br> - [Intlayer Editor](https://intlayer.org/doc/concept/editor) <br> - [Intlayer CMS](https://intlayer.org/doc/concept/cms) |
59
+ | <img src="https://github.com/aymericzip/intlayer/blob/main/docs/assets/bundle.png?raw=true" alt="Feature" width="700"> | **Tree-shakable Content**<br><br>Tree-shakable content, reducing the size of the final bundle. Loads content per component, excluding any unused content from your bundle. Supports lazy loading to enhance app loading efficiency. <br><br> - [App build optimization](https://intlayer.org/doc/concept/how-works-intlayer#app-build-optimization) |
60
+ | <img src="https://github.com/aymericzip/intlayer/blob/main/docs/assets/static_rendering.png?raw=true" alt="Feature" width="700"> | **Static Rendering**<br><br>Doesn't block Static Rendering. <br><br> - [Next.js integration](https://intlayer.org/doc/environment/nextjs) |
61
+ | <img src="https://github.com/aymericzip/intlayer/blob/main/docs/assets/AI_translation.png?raw=true" alt="Feature" width="700"> | **AI-Powered Translation**<br><br>Transform your website into 231 languages with just one click using Intlayer's advanced AI-powered translation tools using your own AI provider / API key. <br><br> - [CI/CD integration](https://intlayer.org/doc/concept/ci-cd) <br> - [Intlayer CLI](https://intlayer.org/doc/concept/cli) <br> - [Auto fill](https://intlayer.org/doc/concept/auto-fill) |
62
+ | <img src="https://github.com/aymericzip/intlayer/blob/main/docs/assets/mcp.png?raw=true" alt="Feature" width="700"> | **MCP Server Integration**<br><br>Provides an MCP (Model Context Protocol) server for IDE automation, enabling seamless content management and i18n workflows directly within your development environment. <br><br> - [MCP Server](https://github.com/aymericzip/intlayer/blob/main/docs/docs/en/mcp_server.md) |
63
+ | <img src="https://github.com/aymericzip/intlayer/blob/main/docs/assets/vscode_extension.png?raw=true" alt="Feature" width="700"> | **VSCode Extension**<br><br>Intlayer provides a VSCode extension to help you manage your content and translations, builting your dictionaries, translating your content, and more. <br><br> - [VSCode Extension](https://intlayer.org/doc/vs-code-extension) |
64
+ | <img src="https://github.com/aymericzip/intlayer/blob/main/docs/assets/interoperability.png?raw=true" alt="Feature" width="700"> | **Interoperability**<br><br>Allow interoperability with react-i18next, next-i18next, next-intl, and react-intl. <br><br> - [Intlayer and react-intl](https://intlayer.org/blog/intlayer-with-react-intl) <br> - [Intlayer and next-intl](https://intlayer.org/blog/intlayer-with-next-intl) <br> - [Intlayer and next-i18next](https://intlayer.org/blog/intlayer-with-next-i18next) |
72
65
 
73
- ## Installation
66
+ ---
74
67
 
75
- Install the necessary package using your preferred package manager:
68
+ ## 📦 Installation
76
69
 
77
- ```bash packageManager="npm"
78
- npm install vue-intlayer
79
- ```
70
+ Start your journey with Intlayer today and experience a smoother, more powerful approach to internationalization.
80
71
 
81
- ```bash packageManager="yarn"
82
- yarn add vue-intlayer
83
- ```
72
+ <a href="https://intlayer.org/doc/concept/content" rel="">
73
+ <img src="https://img.shields.io/badge/Get_Started-FFFFFF?style=for-the-badge&logo=rocket&logoColor=black" />
74
+ </a>
84
75
 
85
- ```bash packageManager="pnpm"
86
- pnpm add vue-intlayer
76
+ ```bash
77
+ npm install intlayer react-intlayer
87
78
  ```
88
79
 
89
- ## Example of usage
90
-
91
- With Intlayer, you can declare your content in a structured way anywhere in your codebase.
80
+ Quick Start (Next.js)
92
81
 
93
- By default, Intlayer scans for files with the extension `.content.{json,ts,tsx,js,jsx,mjs,mjx,cjs,cjx}`.
82
+ ```ts
83
+ // intlayer.config.ts
84
+ import { Locales, type IntlayerConfig } from "intlayer";
94
85
 
95
- > You can modify the default extension by setting the `contentDir` property in the [configuration file](https://intlayer.org/doc/concept/configuration).
86
+ const config: IntlayerConfig = {
87
+ internationalization: {
88
+ locales: [Locales.ENGLISH, Locales.FRENCH, Locales.SPANISH],
89
+ defaultLocale: Locales.ENGLISH,
90
+ },
91
+ };
96
92
 
97
- ```bash codeFormat="typescript"
98
- .
99
- ├── intlayer.config.ts
100
- └── src
101
- └── components
102
- ├── Component1
103
- │   ├── index.content.ts
104
- │   └── index.vue
105
- └── Component2
106
- ├── index.content.ts
107
- └── index.vue
93
+ export default config;
108
94
  ```
109
95
 
110
- ### Declare your content
111
-
112
- `vue-intlayer` is made to work with the [`intlayer` package](https://github.com/aymericzip/intlayer/blob/main/docs/docs/en/packages/intlayer/index.md).`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.
113
-
114
- Here’s an example of content declaration:
115
-
116
- ```tsx fileName="src/Component1/index.content.ts" codeFormat="typescript"
96
+ ```ts
97
+ // app/home.content.ts
117
98
  import { t, type Dictionary } from "intlayer";
118
99
 
119
- const component1Content = {
120
- key: "component-1",
100
+ const content = {
101
+ key: "home",
121
102
  content: {
122
- myTranslatedContent: t({
123
- en: "Hello World",
124
- es: "Hola Mundo",
125
- fr: "Bonjour le monde",
126
- }),
127
- numberOfCar: enu({
128
- "<-1": "Less than minus one car",
129
- "-1": "Minus one car",
130
- "0": "No cars",
131
- "1": "One car",
132
- ">5": "Some cars",
133
- ">19": "Many cars",
103
+ title: t({
104
+ en: "Home",
105
+ fr: "Accueil",
106
+ es: "Inicio",
134
107
  }),
135
108
  },
136
109
  } satisfies Dictionary;
137
110
 
138
- export default component1Content;
111
+ export default content;
139
112
  ```
140
113
 
141
- ### Utilize Content in Your Code
142
-
143
- ...
114
+ ```tsx
115
+ // app/page.tsx
116
+ import { useIntlayer } from "react-intlayer";
144
117
 
145
- ## Mastering the internationalization of your Vue application
118
+ const HomePage = () => {
119
+ const { title } = useIntlayer("home");
146
120
 
147
- Intlayer provides a lot of features to help you internationalize your Vue application.
121
+ return <h1>{title}</h1>;
122
+ };
123
+ ```
148
124
 
149
- **To learn more about these features, refer to the [Vue Internationalization (i18n) with Intlayer and Vite and Vue](https://github.com/aymericzip/intlayer/blob/main/docs/docs/en/intlayer_with_vite+react.md) guide for Vite and Vue Application, or the [Vue Internationalization (i18n) with Intlayer and Vue (CRA)](https://intlayer.org/doc/environment/create-react-app) guide for Vue Create App.**
125
+ <a href="https://intlayer.org/doc/environment/nextjs"> Get the full guide → </a>
126
+
127
+ ## 🎥 Live tutorial on YouTube
128
+
129
+ [![How to Internationalize your application using Intlayer](https://i.ytimg.com/vi/e_PPG7PTqGU/hqdefault.jpg?sqp=-oaymwEcCNACELwBSFXyq4qpAw4IARUAAIhCGAFwAcABBg==&rs=AOn4CLDtyJ4uYotEjl12nZ_gZKZ_kjEgOQ)](https://youtu.be/e_PPG7PTqGU?si=GyU_KpVhr61razRw)
130
+
131
+ <a href="https://intlayer.org/doc/concept/content" rel="">
132
+ <img src="https://img.shields.io/badge/Get_Started-FFFFFF?style=for-the-badge&logo=rocket&logoColor=black" />
133
+ </a>
134
+
135
+ ## Table of Contents
136
+
137
+ Explore our comprehensive documentation to get started with Intlayer and learn how to integrate it into your projects.
138
+
139
+ <details open>
140
+ <summary style="font-size:16px; font-weight:bold;">📘 Get Started</summary>
141
+ <ul>
142
+ <li><a href="https://intlayer.org/doc/why" rel=''>Why Intlayer?</a></li>
143
+ <li><a href="https://intlayer.org/doc" rel=''>Introduction</a></li>
144
+ </ul>
145
+ </details>
146
+
147
+ <details>
148
+ <summary style="font-size:16px; font-weight:bold;">⚙️ Concept</summary>
149
+ <ul>
150
+ <li><a href="https://intlayer.org/doc/concept/how-works-intlayer" rel=''>How Intlayer Works</a></li>
151
+ <li><a href="https://intlayer.org/doc/concept/configuration" rel=''>Configuration</a></li>
152
+ <li><a href="https://intlayer.org/doc/concept/cli" rel=''>Intlayer CLI</a></li>
153
+ <li><a href="https://intlayer.org/doc/concept/editor" rel=''>Intlayer Editor</a></li>
154
+ <li><a href="https://intlayer.org/doc/concept/cms" rel=''>Intlayer CMS</a></li>
155
+ <li><a href="https://intlayer.org/doc/concept/content" rel=''>Dictionary</a>
156
+ <ul>
157
+ <li><a href="https://intlayer.org/doc/concept/content/per-locale-file" rel=''>Per-Locale Content Declaration File</a></li>
158
+ <li><a href="https://intlayer.org/doc/concept/content/translation" rel=''>Translation</a></li>
159
+ <li><a href="https://intlayer.org/doc/concept/content/enumeration" rel=''>Enumeration</a></li>
160
+ <li><a href="https://intlayer.org/doc/concept/content/condition" rel=''>Condition</a></li>
161
+ <li><a href="https://intlayer.org/doc/concept/content/nesting" rel=''>Nesting</a></li>
162
+ <li><a href="https://intlayer.org/doc/concept/content/markdown" rel=''>Markdown</a></li>
163
+ <li><a href="https://intlayer.org/doc/concept/content/function-fetching" rel=''>Function Fetching</a></li>
164
+ <li><a href="https://intlayer.org/doc/concept/content/insertion" rel=''>Insertion</a></li>
165
+ <li><a href="https://intlayer.org/doc/concept/content/file" rel=''>File</a></li>
166
+ </ul>
167
+ </li>
168
+ </ul>
169
+ </details>
170
+
171
+ <details open>
172
+ <summary style="font-size:16px; font-weight:bold;">🌐 Environment</summary>
173
+ <ul>
174
+ <li><a href="https://intlayer.org/doc/environment/nextjs" rel=''>Intlayer with Next.js 15</a>
175
+ <ul>
176
+ <li><a href="https://intlayer.org/doc/environment/nextjs/14" rel=''>Next.js 14 (App Router)</a></li>
177
+ <li><a href="https://intlayer.org/doc/environment/nextjs/next-with-Page-Router" rel=''>Next.js Page Router</a></li>
178
+ </ul>
179
+ </li>
180
+ <li><a href="https://intlayer.org/doc/environment/create-react-app" rel=''>React CRA</a></li>
181
+ <li><a href="https://intlayer.org/doc/environment/vite-and-react" rel=''>Vite + React</a>
182
+ <ul>
183
+ <li><a href="https://intlayer.org/doc/environment/vite-and-react/react-router-v7" rel=''>React-router-v7</a></li>
184
+ <li><a href="https://intlayer.org/doc/environment/vite-and-react/tanstack-start" rel=''>Tanstack start</a></li>
185
+ </ul>
186
+ </li>
187
+ <li><a href="https://intlayer.org/doc/environment/react-native-and-expo" rel=''>React Native</a></li>
188
+ <li><a href="https://intlayer.org/doc/environment/lynx-and-react" rel=''>Lynx + React</a></li>
189
+ <li><a href="https://intlayer.org/doc/environment/vite-and-svelte" rel=''>Vite + Svelte</a></li>
190
+ <li><a href="https://intlayer.org/doc/environment/vite-and-preact" rel=''>Vite + Preact</a></li>
191
+ <li><a href="https://intlayer.org/doc/environment/vite-and-vue" rel=''>Vite + Vue</a></li>
192
+ <li><a href="https://intlayer.org/doc/environment/vite-and-nuxt" rel=''>Vite + Nuxt</a></li>
193
+ <li><a href="https://intlayer.org/doc/environment/vite-and-solid" rel=''>Vite + Solid</a></li>
194
+ <li><a href="https://intlayer.org/doc/environment/angular" rel=''>Angular</a></li>
195
+ <li><a href="https://intlayer.org/doc/environment/express" rel=''>Express</a></li>
196
+ <li><a href="https://intlayer.org/doc/environment/nest" rel=''>NestJS</a></li>
197
+ </ul>
198
+ </details>
199
+
200
+ <details>
201
+ <summary style="font-size:16px; font-weight:bold;">📰 Blog</summary>
202
+ <ul>
203
+ <li><a href="https://github.com/aymericzip/intlayer/blob/main/docs/blog/en/what_is_internationalization.md" rel=''>What is i18n</a></li>
204
+ <li><a href="https://intlayer.org/blog/SEO-and-i18n" rel=''>i18n and SEO</a></li>
205
+ <li><a href="https://intlayer.org/blog/intlayer-with-next-i18next" rel=''>Intlayer and i18next</a></li>
206
+ <li><a href="https://intlayer.org/blog/intlayer-with-react-i18next" rel=''>Intlayer and react-intl</a></li>
207
+ <li><a href="https://intlayer.org/blog/intlayer-with-next-intl" rel=''>Intlayer and next-intl</a></li>
208
+ </ul>
209
+ </details>
210
+
211
+ ## 🌐 Readme in other languages
212
+
213
+ <p align="center">
214
+ <a href="https://github.com/aymericzip/intlayer/blob/main/readme.md">English</a> •
215
+ <a href="https://github.com/aymericzip/intlayer/blob/main/docs/docs/zh/readme.md">简体中文</a> •
216
+ <a href="https://github.com/aymericzip/intlayer/blob/main/docs/docs/ru/readme.md">Русский</a> •
217
+ <a href="https://github.com/aymericzip/intlayer/blob/main/docs/docs/ja/readme.md">日本語</a> •
218
+ <a href="https://github.com/aymericzip/intlayer/blob/main/docs/docs/fr/readme.md">Français</a> •
219
+ <a href="https://github.com/aymericzip/intlayer/blob/main/docs/docs/ko/readme.md">한국어</a> •
220
+ <a href="https://github.com/aymericzip/intlayer/blob/main/docs/docs/es/readme.md">Español</a> •
221
+ <a href="https://github.com/aymericzip/intlayer/blob/main/docs/docs/de/readme.md">Deutsch</a> •
222
+ <a href="https://github.com/aymericzip/intlayer/blob/main/docs/docs/ar/readme.md">العربية</a> •
223
+ <a href="https://github.com/aymericzip/intlayer/blob/main/docs/docs/it/readme.md">Italiano</a> •
224
+ <a href="https://github.com/aymericzip/intlayer/blob/main/docs/docs/en-GB/readme.md">English (UK)</a> •
225
+ <a href="https://github.com/aymericzip/intlayer/blob/main/docs/docs/pt/readme.md">Português</a> •
226
+ <a href="https://github.com/aymericzip/intlayer/blob/main/docs/docs/hi/readme.md">हिन्दी</a> •
227
+ <a href="https://github.com/aymericzip/intlayer/blob/main/docs/docs/tr/readme.md">Türkçe</a>
228
+ </p>
229
+
230
+ ## 🤝 Community
231
+
232
+ Intlayer is built with and for the community and we’d love your input!
233
+
234
+ - Have a suggestion? [Open an issue](https://github.com/aymericzip/intlayer/issues)
235
+ - Found a bug or improvement? [Submit a PR](https://github.com/aymericzip/intlayer/pulls)
236
+ - Need help or want to connect? [Join our Discord](https://discord.gg/7uxamYVeCk)
237
+
238
+ You can also follow us on :
239
+
240
+ <div>
241
+ <br/>
242
+ <p align="center">
243
+ <a href="https://discord.gg/528mBV4N" target="blank" rel='noopener noreferrer nofollow'><img align="center"
244
+ src="https://img.shields.io/badge/discord-5865F2.svg?style=for-the-badge&logo=discord&logoColor=white"
245
+ alt="Intlayer Discord" height="30"/></a>
246
+ <a href="https://www.linkedin.com/company/intlayerorg" target="blank" rel='noopener noreferrer nofollow'><img align="center"
247
+ src="https://img.shields.io/badge/linkedin-%231DA1F2.svg?style=for-the-badge&logo=linkedin&logoColor=white"
248
+ alt="Intlayer LinkedIn" height="30"/></a>
249
+ <a href="https://www.facebook.com/intlayer" target="blank" rel='noopener noreferrer nofollow'><img align="center"
250
+ src="https://img.shields.io/badge/facebook-4267B2.svg?style=for-the-badge&logo=facebook&logoColor=white"
251
+ alt="Intlayer Facebook" height="30"/></a>
252
+ <a href="https://www.instagram.com/intlayer/" target="blank" rel='noopener noreferrer nofollow'><img align="center"
253
+ src="https://img.shields.io/badge/instagram-%23E4405F.svg?style=for-the-badge&logo=Instagram&logoColor=white"
254
+ alt="Intlayer Instagram" height="30"/></a>
255
+ <a href="https://x.com/Intlayer183096" target="blank" rel='noopener noreferrer nofollow'><img align="center"
256
+ src="https://img.shields.io/badge/x-1DA1F2.svg?style=for-the-badge&logo=x&logoColor=white"
257
+ alt="Intlayer X" height="30"/></a>
258
+ <a href="https://www.youtube.com/@intlayer" target="blank" rel='noopener noreferrer nofollow'><img align="center"
259
+ src="https://img.shields.io/badge/youtube-FF0000.svg?style=for-the-badge&logo=youtube&logoColor=white"
260
+ alt="Intlayer YouTube" height="30"/></a>
261
+ <a href="https://www.tiktok.com/@intlayer" target="blank" rel='noopener noreferrer nofollow'><img align="center"
262
+ src="https://img.shields.io/badge/tiktok-000000.svg?style=for-the-badge&logo=tiktok&logoColor=white"
263
+ alt="Intlayer TikTok" height="30"/></a>
264
+ <br>
265
+ </p>
266
+ </div>
150
267
 
151
- ## Functions provided by `vue-intlayer` package
268
+ ### Contribution
152
269
 
153
- The `vue-intlayer` package also provides some functions to help you to internationalize your application.
270
+ For more detailed guidelines on contributing to this project, please refer to the [`CONTRIBUTING.md`](https://github.com/aymericzip/intlayer/blob/main/CONTRIBUTING.md) file. It contains essential information on our development process, commit message conventions, and release procedures. Your contributions are valuable to us, and we appreciate your efforts in making this project better!
154
271
 
155
- ## Read about Intlayer
272
+ ### Thank You for the Support
156
273
 
157
- - [Intlayer Website](https://intlayer.org)
158
- - [Intlayer Documentation](https://intlayer.org/doc)
159
- - [Intlayer GitHub](https://github.com/aymericzip/intlayer)
274
+ If you like Intlayer, give us a ⭐ on GitHub. It helps others discover the project! [See why GitHub Stars matter](https://github.com/aymericzip/intlayer/blob/main/CONTRIBUTING.md#why-github-stars-matter-).
160
275
 
161
- - [Ask your questions to our smart documentation](https://intlayer.org/docchat)
276
+ [![Star History Chart](https://api.star-history.com/svg?repos=aymericzip/intlayer&type=Date)](https://star-history.com/#aymericzip/intlayer&Date)
@@ -1 +1 @@
1
- {"version":3,"file":"useDictionary.d.ts","sourceRoot":"","sources":["../../../src/client/useDictionary.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,aAAa,EAAE,MAAM,yBAAyB,CAAC;AAC7D,OAAO,EAAE,KAAK,UAAU,EAAE,MAAM,gBAAgB,CAAC;AACjD,OAAO,EASL,KAAK,MAAM,EACZ,MAAM,KAAK,CAAC;AAEb,OAAO,EAAE,oBAAoB,EAAE,MAAM,YAAY,CAAC;AAGlD,eAAO,MAAM,aAAa,GAAI,CAAC,SAAS,UAAU,EAChD,YAAY,CAAC,EACb,SAAS,aAAa,KACrB,MAAM,CAAC,oBAAoB,CAAC,CAAC,CAAC,SAAS,CAAC,CAAC,CA0C3C,CAAC"}
1
+ {"version":3,"file":"useDictionary.d.ts","sourceRoot":"","sources":["../../../src/client/useDictionary.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,aAAa,EAAE,MAAM,yBAAyB,CAAC;AAC7D,OAAO,EAAE,KAAK,UAAU,EAAE,MAAM,gBAAgB,CAAC;AACjD,OAAO,EASL,KAAK,MAAM,EACZ,MAAM,KAAK,CAAC;AAEb,OAAO,EAAE,oBAAoB,EAAE,MAAM,YAAY,CAAC;AAGlD,eAAO,MAAM,aAAa,GAAI,CAAC,SAAS,UAAU,EAChD,YAAY,CAAC,EACb,SAAS,aAAa,KACrB,MAAM,CAAC,oBAAoB,CAAC,CAAC,CAAC,SAAS,CAAC,CAAC,CA2C3C,CAAC"}
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "vue-intlayer",
3
- "version": "6.0.2",
3
+ "version": "6.1.1",
4
4
  "private": false,
5
5
  "description": "Easily internationalize i18n your Vue applications with type-safe multilingual content management.",
6
6
  "keywords": [
@@ -65,39 +65,39 @@
65
65
  "dependencies": {
66
66
  "js-cookie": "^3.0.5",
67
67
  "uuid": "^11.1.0",
68
- "@intlayer/core": "6.0.2",
69
- "@intlayer/config": "6.0.2",
70
- "@intlayer/dictionaries-entry": "6.0.2",
71
- "@intlayer/api": "6.0.2",
72
- "@intlayer/editor": "6.0.2"
68
+ "@intlayer/config": "6.1.1",
69
+ "@intlayer/dictionaries-entry": "6.1.1",
70
+ "@intlayer/core": "6.1.1",
71
+ "@intlayer/api": "6.1.1",
72
+ "@intlayer/editor": "6.1.1"
73
73
  },
74
74
  "devDependencies": {
75
75
  "@types/js-cookie": "^3.0.6",
76
- "@types/node": "^24.2.1",
77
- "@typescript-eslint/parser": "^8.33.1",
76
+ "@types/node": "^24.5.2",
77
+ "@typescript-eslint/parser": "^8.44.1",
78
78
  "@vitejs/plugin-vue": "^6.0.1",
79
- "concurrently": "^9.1.2",
80
- "eslint": "^9.34.0",
79
+ "concurrently": "^9.2.1",
80
+ "eslint": "^9.36.0",
81
81
  "fast-glob": "^3.3.3",
82
82
  "prettier": "^3.6.2",
83
83
  "rimraf": "^6.0.1",
84
84
  "typescript": "^5.9.2",
85
- "vite": "^7.1.2",
85
+ "vite": "^7.1.7",
86
86
  "vite-plugin-dts": "^4.5.3",
87
87
  "vitest": "^3.2.4",
88
88
  "@utils/eslint-config": "1.0.4",
89
- "@utils/ts-config": "1.0.4",
90
89
  "@utils/ts-config-types": "1.0.4",
90
+ "@utils/ts-config": "1.0.4",
91
91
  "@utils/tsup-config": "1.0.4"
92
92
  },
93
93
  "peerDependencies": {
94
94
  "vue": "^3.5.13",
95
- "@intlayer/api": "6.0.2",
96
- "@intlayer/dictionaries-entry": "6.0.2",
97
- "@intlayer/config": "6.0.2",
98
- "@intlayer/editor": "6.0.2",
99
- "@intlayer/core": "6.0.2",
100
- "intlayer": "6.0.2"
95
+ "@intlayer/api": "6.1.1",
96
+ "@intlayer/dictionaries-entry": "6.1.1",
97
+ "@intlayer/config": "6.1.1",
98
+ "@intlayer/core": "6.1.1",
99
+ "@intlayer/editor": "6.1.1",
100
+ "intlayer": "6.1.1"
101
101
  },
102
102
  "engines": {
103
103
  "node": ">=14.18"
@@ -114,6 +114,7 @@
114
114
  "lint:fix": "eslint . --cache --fix",
115
115
  "prettier": "prettier . --check",
116
116
  "prettier:fix": "prettier . --write",
117
+ "prepublish": "cp -f ../../README.md ./README.md",
117
118
  "test": "vitest run",
118
119
  "test:watch": "vitest",
119
120
  "typecheck": "tsup --project ./tsconfig.json --noEmit"