@intlayer/docs 5.5.10 → 5.5.12

package/docs/pt/packages/@intlayer/core/index.md

@@ -0,0 +1,49 @@
+---
+createdAt: 2025-02-07
+updatedAt: 2025-06-29
+title: @intlayer/core - Funções Core para i18n do Intlayer
+description: Pacote NPM contendo funções core para Intlayer, incluindo funções de tradução, funções de dicionário e funções utilitárias para internacionalização.
+keywords:
+  - intlayer
+  - core
+  - tradução
+  - dicionário
+  - utilitários
+  - i18n
+  - JavaScript
+  - NPM
+slugs:
+  - doc
+  - package
+  - @intlayer_core
+---
+
+# @intlayer/core: Pacote NPM contendo funções core do Intlayer
+
+**Intlayer** é um conjunto de pacotes projetados especificamente para desenvolvedores JavaScript. É compatível com frameworks como React, React e Express.js.
+
+\*\*O pacote `@intlayer/core` é um pacote NPM que inclui funções core do Intlayer compartilhadas por múltiplos pacotes. Ele inclui notavelmente:
+
+- Funções de tradução
+- Funções de dicionário
+- Funções utilitárias
+
+## Instalação
+
+Instale o pacote necessário usando seu gerenciador de pacotes preferido:
+
+```bash packageManager="npm"
+npm install @intlayer/core
+```
+
+```bash packageManager="pnpm"
+pnpm add @intlayer/core
+```
+
+```bash packageManager="yarn"
+yarn add @intlayer/core
+```
+
+## Histórico da Documentação
+
+- 5.5.10 - 2025-06-29: Histórico inicial

package/docs/pt/packages/@intlayer/design-system/index.md

@@ -0,0 +1,45 @@
+---
+createdAt: 2025-02-07
+updatedAt: 2025-06-29
+title: @intlayer/design-system - Componentes de UI para Intlayer
+description: Pacote NPM contendo componentes do sistema de design e elementos de UI para construir interfaces de usuário consistentes com a internacionalização do Intlayer.
+keywords:
+  - intlayer
+  - sistema de design
+  - componentes de UI
+  - interface
+  - i18n
+  - JavaScript
+  - NPM
+  - estilização
+slugs:
+  - doc
+  - package
+  - @intlayer_design-system
+---
+
+# @intlayer/design-system: Pacote NPM contendo a biblioteca de UI do Intlayer
+
+**Intlayer** é um conjunto de pacotes projetados especificamente para desenvolvedores JavaScript. É compatível com frameworks como React, React e Express.js.
+
+O pacote **`@intlayer/design-system`** é um pacote NPM que inclui o sistema de design do Intlayer. Este pacote é notavelmente utilizado pelo [editor Intlayer](https://github.com/aymericzip/intlayer/tree/main/docs/pt/packages/intlayer-editor/index.md), no [Website](https://intlayer.org) e no [Editor Visual / CMS](https://intlayer.org/dashboard).
+
+## Instalação
+
+Instale o pacote necessário usando seu gerenciador de pacotes preferido:
+
+```bash packageManager="npm"
+npm install @intlayer/design-system
+```
+
+```bash packageManager="pnpm"
+pnpm add @intlayer/design-system
+```
+
+```bash packageManager="yarn"
+yarn add @intlayer/design-system
+```
+
+## Histórico da Documentação
+
+- 5.5.10 - 2025-06-29: Histórico inicial

package/docs/pt/packages/@intlayer/dictionary-entry/index.md

@@ -0,0 +1,45 @@
+---
+createdAt: 2025-02-07
+updatedAt: 2025-06-29
+title: @intlayer/dictionary-entry - Gestão de Dicionários para Intlayer
+description: Pacote NPM para gerenciar entradas de dicionário no Intlayer, fornecendo utilitários para criar, atualizar e organizar dicionários de tradução.
+keywords:
+  - intlayer
+  - dicionário
+  - entradas
+  - gestão
+  - tradução
+  - i18n
+  - JavaScript
+  - NPM
+slugs:
+  - doc
+  - package
+  - @intlayer_dictionary-entry
+---
+
+# @intlayer/dictionary-entry: Pacote NPM para recuperar dicionários do Intlayer
+
+**Intlayer** é um conjunto de pacotes projetados especificamente para desenvolvedores JavaScript. É compatível com frameworks como React, React e Express.js.
+
+O pacote **`@intlayer/dictionary-entry`** é um pacote NPM que retorna apenas o caminho de entrada dos dicionários do Intlayer. Como a busca no sistema de arquivos é impossível a partir do navegador, usar bundlers como Webpack ou Rollup para recuperar o caminho de entrada dos dicionários não é possível. Este pacote tem como objetivo ser aliasado.
+
+## Instalação
+
+Instale o pacote necessário usando seu gerenciador de pacotes preferido:
+
+```bash packageManager="npm"
+npm install @intlayer/dictionary-entry
+```
+
+```bash packageManager="pnpm"
+pnpm add @intlayer/dictionary-entry
+```
+
+```bash packageManager="yarn"
+yarn add @intlayer/dictionary-entry
+```
+
+## Histórico da Documentação
+
+- 5.5.10 - 2025-06-29: Histórico inicial

package/docs/pt/packages/@intlayer/editor/index.md

@@ -0,0 +1,45 @@
+---
+createdAt: 2025-02-07
+updatedAt: 2025-06-29
+title: @intlayer/editor - Pacote de Interface do Editor Intlayer
+description: Pacote NPM que fornece utilitários para interligar aplicações com o editor Intlayer e manipular dicionários em todos os frameworks JavaScript.
+keywords:
+  - intlayer
+  - editor
+  - dicionário
+  - interface
+  - NPM
+  - JavaScript
+  - utilitários
+  - multiplataforma
+slugs:
+  - doc
+  - package
+  - @intlayer_editor
+---
+
+# @intlayer/editor: Pacote NPM que fornece utilitários para interligar a aplicação com o editor Intlayer e manipular dicionários
+
+**Intlayer** é um conjunto de pacotes projetados especificamente para desenvolvedores JavaScript. É compatível com frameworks como React, Next.js e Express.js.
+
+O pacote **`intlayer-editor`** fornece utilitários para interligar a aplicação com o editor Intlayer. Inclui a API para interagir com o editor e utilitários para manipular dicionários. Este pacote é multiplataforma.
+
+## Instalação
+
+Instale o pacote necessário usando seu gerenciador de pacotes preferido:
+
+```bash
+npm install @intlayer/editor
+```
+
+```bash
+yarn add @intlayer/editor
+```
+
+```bash
+pnpm add @intlayer/editor
+```
+
+## Histórico da Documentação
+
+- 5.5.10 - 2025-06-29: Histórico inicial

package/docs/pt/packages/@intlayer/editor-react/index.md

@@ -0,0 +1,45 @@
+---
+createdAt: 2025-02-07
+updatedAt: 2025-06-29
+title: @intlayer/editor-react - Componentes React para o Editor Intlayer
+description: Pacote NPM que fornece componentes e hooks React para integrar o editor visual Intlayer em aplicações React para internacionalização.
+keywords:
+  - intlayer
+  - editor
+  - React
+  - componentes
+  - hooks
+  - i18n
+  - JavaScript
+  - NPM
+slugs:
+  - doc
+  - package
+  - @intlayer_editor-react
+---
+
+# @intlayer/editor-react: Pacote NPM que fornece Estados, Contextos, Hooks e Componentes React para interagir com o editor Intlayer
+
+**Intlayer** é um conjunto de pacotes projetados especificamente para desenvolvedores JavaScript. É compatível com frameworks como React, Next.js e Express.js.
+
+O pacote **`@intlayer/editor-react`** fornece estados, contextos, hooks e componentes para interagir com o editor Intlayer em uma aplicação React.
+
+## Instalação
+
+Instale o pacote necessário usando seu gerenciador de pacotes preferido:
+
+```bash
+npm install @intlayer/editor-react
+```
+
+```bash
+yarn add @intlayer/editor-react
+```
+
+```bash
+pnpm add @intlayer/editor-react
+```
+
+## Histórico da Documentação
+
+- 5.5.10 - 2025-06-29: Histórico inicial

package/docs/pt/packages/@intlayer/webpack/index.md

@@ -0,0 +1,60 @@
+---
+createdAt: 2025-02-07
+updatedAt: 2025-06-29
+title: @intlayer/webpack - Plugin Webpack para Intlayer i18n
+description: Pacote NPM que fornece configuração e plugin Webpack para integração perfeita da internacionalização Intlayer com aplicações baseadas em Webpack.
+keywords:
+  - intlayer
+  - webpack
+  - plugin
+  - configuração
+  - i18n
+  - JavaScript
+  - NPM
+  - bundler
+slugs:
+  - doc
+  - package
+  - @intlayer_webpack
+---
+
+# @intlayer/webpack: Pacote NPM para usar o Plugin Webpack do Intlayer na sua aplicação
+
+**Intlayer** é um conjunto de pacotes projetados especificamente para desenvolvedores JavaScript. É compatível com frameworks como React, React e Express.js.
+
+O pacote **`@intlayer/webpack`** é usado para fornecer uma configuração Webpack que facilita o trabalho com uma aplicação baseada em Webpack utilizando Intlayer. O pacote também fornece um plugin para ser adicionado em uma aplicação Webpack existente.
+
+## Uso
+
+```ts
+import { IntlayerPlugin } from "@intlayer/webpack";
+
+export default {
+  plugins: [
+    new IntlayerPlugin({
+      // Opções
+    }),
+  ],
+};
+```
+
+## Instalação
+
+Instale o pacote necessário usando seu gerenciador de pacotes preferido:
+
+```bash packageManager="npm"
+npm install @intlayer/webpack
+```
+
+```bash packageManager="pnpm"
+pnpm add @intlayer/webpack
+```
+
+```bash packageManager="yarn"
+yarn add @intlayer/webpack
+yarn add @intlayer/webpack
+```
+
+## Histórico da Documentação
+
+- 5.5.10 - 2025-06-29: Histórico inicial

package/docs/pt/packages/angular-intlayer/index.md

@@ -0,0 +1,53 @@
+---
+createdAt: 2025-04-18
+updatedAt: 2025-06-29
+title: Documentação do Pacote | angular-intlayer
+description: Veja como usar o pacote angular-intlayer
+keywords:
+  - Intlayer
+  - angular-intlayer
+  - Internacionalização
+  - Documentação
+  - JavaScript
+  - Angular
+slugs:
+  - doc
+  - packages
+  - angular-intlayer
+---
+
+# angular-intlayer: Pacote NPM para internacionalizar (i18n) uma aplicação Angular
+
+**Intlayer** é um conjunto de pacotes projetados especificamente para desenvolvedores JavaScript. É compatível com frameworks como Angular, Angular e Express.js.
+
+**O pacote `angular-intlayer`** permite que você internacionalize sua aplicação Angular. Ele fornece provedores de contexto e hooks para a internacionalização no Angular.
+
+## Por que internacionalizar sua aplicação Angular?
+
+Internacionalizar sua aplicação Angular é essencial para atender eficazmente a um público global. Isso permite que sua aplicação entregue conteúdo e mensagens no idioma preferido de cada usuário. Essa capacidade melhora a experiência do usuário e amplia o alcance da sua aplicação, tornando-a mais acessível e relevante para pessoas de diferentes origens linguísticas.
+
+## Por que integrar o Intlayer?
+
+- **Gerenciamento de Conteúdo com JavaScript**: Aproveite a flexibilidade do JavaScript para definir e gerenciar seu conteúdo de forma eficiente.
+- **Ambiente com Tipagem Segura**: Aproveite o TypeScript para garantir que todas as definições de conteúdo sejam precisas e livres de erros.
+- **Arquivos de Conteúdo Integrados**: Mantenha suas traduções próximas aos seus respectivos componentes, melhorando a manutenção e a clareza.
+
+## Instalação
+
+Instale o pacote necessário usando seu gerenciador de pacotes preferido:
+
+```bash packageManager="npm"
+npm install angular-intlayer
+```
+
+```bash packageManager="yarn"
+yarn add angular-intlayer
+```
+
+```bash packageManager="pnpm"
+pnpm add angular-intlayer
+```
+
+## Histórico da Documentação
+
+- 5.5.10 - 2025-06-29: Histórico inicial

package/docs/pt/packages/express-intlayer/index.md

@@ -0,0 +1,255 @@
+---
+createdAt: 2024-08-11
+updatedAt: 2025-06-29
+title: Documentação do Pacote | express-intlayer
+description: Veja como usar o pacote express-intlayer
+keywords:
+  - Intlayer
+  - express-intlayer
+  - Internacionalização
+  - Documentação
+  - Next.js
+  - JavaScript
+  - React
+slugs:
+  - doc
+  - packages
+  - express-intlayer
+---
+
+# express-intlayer: Pacote JavaScript para internacionalizar (i18n) uma aplicação Express.js
+
+**Intlayer** é um conjunto de pacotes projetados especificamente para desenvolvedores JavaScript. É compatível com frameworks como React, Next.js e Express.js.
+
+**O pacote `express-intlayer`** permite que você internacionalize sua aplicação Express.js. Ele fornece um middleware para detectar a localidade preferida do usuário e retorna o dicionário apropriado para o usuário.
+
+## Por que Internacionalizar Seu Backend?
+
+Internacionalizar seu backend é essencial para atender eficazmente a um público global. Isso permite que sua aplicação entregue conteúdo e mensagens no idioma preferido de cada usuário. Essa capacidade melhora a experiência do usuário e amplia o alcance da sua aplicação, tornando-a mais acessível e relevante para pessoas de diferentes origens linguísticas.
+
+### Casos de Uso Práticos
+
+- **Exibir Erros do Backend no Idioma do Usuário**: Quando ocorre um erro, exibir mensagens no idioma nativo do usuário melhora a compreensão e reduz a frustração. Isso é especialmente útil para mensagens de erro dinâmicas que podem ser exibidas em componentes de front-end, como toasts ou modais.
+
+- **Recuperar Conteúdo Multilíngue**: Para aplicações que buscam conteúdo de um banco de dados, a internacionalização garante que você possa fornecer esse conteúdo em vários idiomas. Isso é crucial para plataformas como sites de comércio eletrônico ou sistemas de gerenciamento de conteúdo que precisam exibir descrições de produtos, artigos e outros conteúdos no idioma preferido pelo usuário.
+
+- **Enviar Emails Multilíngues**: Seja para emails transacionais, campanhas de marketing ou notificações, enviar emails no idioma do destinatário pode aumentar significativamente o engajamento e a eficácia.
+
+- **Notificações Push Multilíngues**: Para aplicações móveis, enviar notificações push no idioma preferido do usuário pode melhorar a interação e a retenção. Esse toque pessoal pode fazer com que as notificações pareçam mais relevantes e acionáveis.
+
+- **Outras Comunicações**: Qualquer forma de comunicação do backend, como mensagens SMS, alertas do sistema ou atualizações da interface do usuário, se beneficia de estar no idioma do usuário, garantindo clareza e aprimorando a experiência geral do usuário.
+
+Ao internacionalizar o backend, sua aplicação não apenas respeita as diferenças culturais, mas também se alinha melhor às necessidades do mercado global, tornando-se um passo fundamental para escalar seus serviços mundialmente.
+
+## Por que integrar o Intlayer?
+
+- **Ambiente com Tipagem Segura**: Aproveite o TypeScript para garantir que todas as suas definições de conteúdo sejam precisas e livres de erros.
+
+## Instalação
+
+Instale o pacote necessário usando seu gerenciador de pacotes preferido:
+
+```bash
+npm install express-intlayer
+```
+
+```bash
+yarn add express-intlayer
+```
+
+```bash
+pnpm add express-intlayer
+```
+
+### Configurar o Intlayer
+
+O Intlayer fornece um arquivo de configuração para configurar seu projeto. Coloque este arquivo na raiz do seu projeto.
+
+```typescript fileName="intlayer.config.ts" codeFormat="typescript"
+import { Locales, type IntlayerConfig } from "intlayer";
+
+const config: IntlayerConfig = {
+  internationalization: {
+    locales: [Locales.ENGLISH, Locales.FRENCH, Locales.SPANISH],
+    defaultLocale: Locales.ENGLISH,
+  },
+};
+
+export default config;
+```
+
+```javascript fileName="intlayer.config.mjs" codeFormat="esm"
+import { Locales } from "intlayer";
+
+/** @type {import('intlayer').IntlayerConfig} */
+// Configuração do Intlayer para internacionalização
+const config = {
+  internationalization: {
+    locales: [Locales.ENGLISH, Locales.FRENCH, Locales.SPANISH],
+    defaultLocale: Locales.ENGLISH,
+  },
+};
+
+export default config;
+```
+
+```javascript fileName="intlayer.config.cjs" codeFormat="commonjs"
+const { Locales } = require("intlayer");
+
+/** @type {import('intlayer').IntlayerConfig} */
+// Configuração do Intlayer para internacionalização
+const config = {
+  internationalization: {
+    locales: [Locales.ENGLISH, Locales.FRENCH, Locales.SPANISH],
+    defaultLocale: Locales.ENGLISH,
+  },
+};
+
+module.exports = config;
+```
+
+> Para uma lista completa dos parâmetros disponíveis, consulte a [documentação de configuração](https://github.com/aymericzip/intlayer/blob/main/docs/docs/pt/configuration.md).
+
+## Exemplo de uso
+
+Configure sua aplicação Express para usar `express-intlayer`:
+
+```typescript fileName="src/index.ts" codeFormat="typescript"
+import express, { type Express } from "express";
+import { intlayer, t } from "express-intlayer";
+
+const app: Express = express();
+
+// Carregar o manipulador de requisições de internacionalização
+app.use(intlayer());
+
+// Rotas
+app.get("/", (_req, res) => {
+  res.send(
+    t({
+      en: "Example of returned content in English",
+      fr: "Exemplo de conteúdo retornado em francês",
+      "es-ES": "Exemplo de conteúdo retornado em espanhol (Espanha)",
+      "es-MX": "Exemplo de conteúdo retornado em espanhol (México)",
+    })
+  );
+});
+
+// Iniciar servidor
+app.listen(3000, () => console.log(`Escutando na porta 3000`));
+```
+
+```javascript fileName="src/index.mjs" codeFormat="esm"
+import express from "express";
+import { intlayer, t } from "express-intlayer";
+
+const app = express();
+
+// Carregar o manipulador de requisição de internacionalização
+app.use(intlayer());
+
+// Rotas
+app.get("/", (_req, res) => {
+  res.send(
+    t({
+      en: "Example of returned content in English",
+      fr: "Exemplo de conteúdo retornado em francês",
+      "es-MX": "Exemplo de conteúdo retornado em espanhol (México)",
+      "es-ES": "Exemplo de conteúdo retornado em espanhol (Espanha)",
+    })
+  );
+});
+
+// Iniciar servidor
+app.listen(3000, () => console.log(`Escutando na porta 3000`));
+```
+
+```javascript fileName="src/index.cjs" codeFormat="commonjs"
+const express = require("express");
+const { intlayer, t } = require("express-intlayer");
+
+const app = express();
+
+// Carregar o manipulador de requisição de internacionalização
+app.use(intlayer());
+
+// Rotas
+app.get("/", (_req, res) => {
+  res.send(
+    t({
+      en: "Example of returned content in English",
+      fr: "Exemple de contenu renvoyé en français",
+      "es-MX": "Ejemplo de contenido devuelto en español (México)",
+      "es-ES": "Ejemplo de contenido devuelto en español (España)",
+    })
+  );
+});
+
+// Iniciar servidor
+app.listen(3000, () => console.log(`Escutando na porta 3000`));
+```
+
+### Compatibilidade
+
+`express-intlayer` é totalmente compatível com:
+
+- [`react-intlayer`](https://github.com/aymericzip/intlayer/blob/main/docs/docs/pt/packages/react-intlayer/index.md) para aplicações React
+- [`next-intlayer`](https://github.com/aymericzip/intlayer/blob/main/docs/docs/pt/packages/next-intlayer/index.md) para aplicações Next.js
+- [`vite-intlayer`](https://github.com/aymericzip/intlayer/blob/main/docs/docs/pt/packages/vite-intlayer/index.md) para aplicações Vite
+
+Também funciona perfeitamente com qualquer solução de internacionalização em diversos ambientes, incluindo navegadores e requisições API. Você pode personalizar o middleware para detectar o locale através de headers ou cookies:
+
+```typescript fileName="intlayer.config.ts" codeFormat="typescript"
+import { Locales, type IntlayerConfig } from "intlayer";
+
+const config: IntlayerConfig = {
+  // ... Outras opções de configuração
+  middleware: {
+    headerName: "my-locale-header",
+    cookieName: "my-locale-cookie",
+  },
+};
+
+export default config;
+```
+
+```javascript fileName="intlayer.config.mjs" codeFormat="esm"
+import { Locales } from "intlayer";
+
+/** @type {import('intlayer').IntlayerConfig} */
+const config = {
+  // ... Outras opções de configuração
+  middleware: {
+    headerName: "my-locale-header",
+    cookieName: "my-locale-cookie",
+  },
+};
+
+export default config;
+```
+
+```javascript fileName="intlayer.config.cjs" codeFormat="commonjs"
+const { Locales } = require("intlayer");
+
+javascript fileName="intlayer.config.cjs" codeFormat="commonjs"
+/** @type {import('intlayer').IntlayerConfig} */
+const config = {
+  // ... Outras opções de configuração
+  middleware: {
+    headerName: "my-locale-header",
+    cookieName: "my-locale-cookie",
+  },
+};
+
+module.exports = config;
+```
+
+Por padrão, o `express-intlayer` interpretará o header `Accept-Language` para determinar o idioma preferido do cliente.
+
+## Funções fornecidas pelo pacote `express-intlayer`
+
+- [`t()`](https://github.com/aymericzip/intlayer/blob/main/docs/docs/pt/packages/express-intlayer/t.md)
+
+## Histórico da documentação
+
+- 5.5.10 - 2025-06-29: Histórico inicial