@intlayer/docs 7.0.7 → 7.0.8

package/docs/pl/packages/intlayer/getEnumeration.md

@@ -0,0 +1,160 @@
+---
+createdAt: 2025-08-23
+updatedAt: 2025-08-23
+title: Dokumentacja funkcji getEnumeration | intlayer
+description: Zobacz, jak używać funkcji getEnumeration w pakiecie intlayer
+keywords:
+  - getEnumeration
+  - tłumaczenie
+  - Intlayer
+  - intlayer
+  - Internacjonalizacja
+  - Dokumentacja
+  - Next.js
+  - JavaScript
+  - React
+slugs:
+  - doc
+  - packages
+  - intlayer
+  - getEnumeration
+history:
+  - version: 5.5.10
+    date: 2025-06-29
+    changes: Inicjalizacja historii
+---
+
+# Dokumentacja: funkcja `getEnumeration` w `intlayer`
+
+## Opis
+
+Funkcja `getEnumeration` pobiera zawartość odpowiadającą określonej ilości na podstawie zdefiniowanych warunków w obiekcie enumeracji. Warunki są zdefiniowane jako klucze, a ich priorytet jest określany przez kolejność w obiekcie.
+
+## Parametry
+
+- `enumerationContent: QuantityContent<Content>`
+  - **Opis**: Obiekt, w którym klucze reprezentują warunki (np. `<=`, `<`, `>=`, `=`), a wartości odpowiadające im treści. Kolejność kluczy definiuje priorytet dopasowania.
+  - **Typ**: `QuantityContent<Content>`
+    - `Content` może być dowolnym typem.
+
+- `quantity: number`
+  - **Opis**: Wartość numeryczna używana do dopasowania do warunków w `enumerationContent`.
+  - **Typ**: `number`
+
+## Zwracana wartość
+
+- **Typ**: `Content`
+- **Opis**: Zawartość odpowiadająca pierwszemu pasującemu warunkowi w `enumerationContent`. Jeśli nie znaleziono dopasowania, zachowanie zależy od implementacji (np. błąd lub zawartość zapasowa).
+
+## Przykład użycia
+
+### Podstawowe użycie
+
+```typescript codeFormat="typescript"
+typescript codeFormat="typescript"
+import { getEnumeration } from "intlayer";
+
+const content = getEnumeration(
+  {
+    "<=-2.3": "Masz mniej niż -2.3",
+    "<1": "Masz mniej niż jeden",
+    "2": "Masz dwa",
+    ">=3": "Masz trzy lub więcej",
+  },
+  2
+);
+
+console.log(content); // Wynik: "Masz dwa"
+```
+
+```javascript codeFormat="esm"
+import { getEnumeration } from "intlayer";
+
+const content = getEnumeration(
+  {
+    "<1": "Masz mniej niż jeden",
+    "2": "Masz dwa",
+    ">=3": "Masz trzy lub więcej",
+  },
+  2
+);
+
+console.log(content); // Wynik: "Masz dwa"
+```
+
+```javascript codeFormat="commonjs"
+const { getEnumeration } = require("intlayer");
+
+const content = getEnumeration(
+  {
+    "<1": "Masz mniej niż jeden",
+    "2": "Masz dwa",
+    ">=3": "Masz trzy lub więcej",
+  },
+  2
+);
+
+console.log(content); // Wynik: "Masz dwa"
+```
+
+### Priorytet warunków
+
+```typescript codeFormat="typescript"
+import { getEnumeration } from "intlayer";
+
+const content = getEnumeration(
+  {
+    "<4": "Masz mniej niż cztery",
+    "2": "Masz dwa",
+  },
+  2
+);
+
+console.log(content); // Wynik: "Masz mniej niż cztery"
+```
+
+```javascript codeFormat="esm"
+import { getEnumeration } from "intlayer";
+
+const content = getEnumeration(
+  {
+    "<4": "Masz mniej niż cztery",
+    "2": "Masz dwa",
+  },
+  2
+);
+
+console.log(content); // Wynik: "Masz mniej niż cztery"
+```
+
+```javascript codeFormat="commonjs"
+const { getEnumeration } = require("intlayer");
+
+const content = getEnumeration(
+  {
+    "<4": "Masz mniej niż cztery",
+    "2": "Masz dwa",
+  },
+  2
+);
+
+console.log(content); // Wynik: "Masz mniej niż cztery"
+```
+
+## Przypadki brzegowe
+
+- **Brak pasującego warunku:**
+  - Jeśli żaden warunek nie pasuje do podanej ilości, funkcja zwróci `undefined` lub obsłuży domyślny/scenariusz zapasowy w sposób jawny.
+
+- **Niejasne warunki:**
+  - Jeśli warunki się nakładają, pierwszeństwo ma pierwszy pasujący warunek (na podstawie kolejności w obiekcie).
+
+- **Nieprawidłowe klucze:**
+  - Funkcja zakłada, że wszystkie klucze w `enumerationContent` są poprawne i możliwe do przetworzenia jako warunki. Nieprawidłowe lub źle sformatowane klucze mogą prowadzić do nieoczekiwanego zachowania.
+
+- **Wymuszenie TypeScript:**
+  - Funkcja zapewnia, że typ `Content` jest spójny dla wszystkich kluczy, co pozwala na bezpieczeństwo typów w pobieranych treściach.
+
+## Uwagi
+
+- Narzędzie `findMatchingCondition` jest używane do określenia odpowiedniego warunku na podstawie podanej ilości.

package/docs/pl/packages/intlayer/getHTMLTextDir.md

@@ -0,0 +1,121 @@
+---
+createdAt: 2025-08-23
+updatedAt: 2025-08-23
+title: Dokumentacja funkcji getHTMLTextDir | intlayer
+description: Zobacz, jak używać funkcji getHTMLTextDir w pakiecie intlayer
+keywords:
+  - getHTMLTextDir
+  - tłumaczenie
+  - Intlayer
+  - intlayer
+  - Internacjonalizacja
+  - Dokumentacja
+  - Next.js
+  - JavaScript
+  - React
+slugs:
+  - doc
+  - packages
+  - intlayer
+  - getHTMLTextDir
+history:
+  - version: 5.5.10
+    date: 2025-06-29
+    changes: Inicjalizacja historii
+---
+
+# Dokumentacja: funkcja `getHTMLTextDir` w `intlayer`
+
+## Opis
+
+Funkcja `getHTMLTextDir` określa kierunek tekstu (`ltr`, `rtl` lub `auto`) na podstawie podanego locale. Została zaprojektowana, aby pomóc deweloperom ustawić atrybut `dir` w HTML dla prawidłowego renderowania tekstu.
+
+## Parametry
+
+- `locale?: Locales`
+  - **Opis**: Ciąg znaków locale (np. `Locales.ENGLISH`, `Locales.ARABIC`) używany do określenia kierunku tekstu.
+  - **Typ**: `Locales` (opcjonalny)
+
+## Zwracana wartość
+
+- **Typ**: `Dir` (`'ltr' | 'rtl' | 'auto'`)
+- **Opis**: Kierunek tekstu odpowiadający locale:
+  - `'ltr'` dla języków pisanych od lewej do prawej.
+  - `'rtl'` dla języków pisanych od prawej do lewej.
+  - `'auto'` jeśli locale nie jest rozpoznane.
+
+## Przykład użycia
+
+### Określanie kierunku tekstu
+
+```typescript codeFormat="typescript"
+import { getHTMLTextDir } from "intlayer";
+
+getHTMLTextDir(Locales.ENGLISH); // Wynik: "ltr"
+getHTMLTextDir(Locales.FRENCH); // Wynik: "ltr"
+getHTMLTextDir(Locales.ARABIC); // Wynik: "rtl"
+```
+
+```javascript codeFormat="esm"
+import { getHTMLTextDir } from "intlayer";
+
+getHTMLTextDir(Locales.ENGLISH); // Wynik: "ltr"
+getHTMLTextDir(Locales.FRENCH); // Wynik: "ltr"
+getHTMLTextDir(Locales.ARABIC); // Wynik: "rtl"
+```
+
+```javascript codeFormat="commonjs"
+const { getHTMLTextDir } = require("intlayer");
+
+getHTMLTextDir(Locales.ENGLISH); // Wynik: "ltr"
+getHTMLTextDir(Locales.FRENCH); // Wynik: "ltr"
+getHTMLTextDir(Locales.ARABIC); // Wynik: "rtl"
+```
+
+## Przypadki brzegowe
+
+- **Brak podanego locale:**
+  - Funkcja zwraca `'auto'`, gdy `locale` jest `undefined`.
+
+- **Nieznane locale:**
+  - Dla nieznanych locale funkcja domyślnie zwraca `'auto'`.
+
+## Użycie w komponentach:
+
+Funkcja `getHTMLTextDir` może być użyta do dynamicznego ustawienia atrybutu `dir` w dokumencie HTML, aby poprawnie renderować tekst w zależności od locale.
+
+```tsx codeFormat="typescript"
+import type { FC } from "react";
+import { getHTMLTextDir, type Locales } from "intlayer";
+
+export const HTMLLayout: FC<PropsWithChildren<{ locale: Locales }>> = ({
+  children,
+  locale,
+}) => (
+  <html dir={getHTMLTextDir(locale)} locale={locale}>
+    <body>{children}</body>
+  </html>
+);
+```
+
+```jsx codeFormat="esm"
+import { getHTMLTextDir } from "intlayer";
+
+const HTMLLayout = ({ children, locale }) => (
+  <html dir={getHTMLTextDir(locale)} locale={locale}>
+    <body>{children}</body>
+  </html>
+);
+```
+
+```jsx codeFormat="commonjs"
+const { getHTMLTextDir } = require("intlayer");
+
+const HTMLLayout = ({ children, locale }) => (
+  <html dir={getHTMLTextDir(locale)} locale={locale}>
+    <body>{children}</body>
+  </html>
+);
+```
+
+W powyższym przykładzie atrybut `dir` jest dynamicznie ustawiany na podstawie lokalizacji (locale).

package/docs/pl/packages/intlayer/getLocaleLang.md

@@ -0,0 +1,81 @@
+---
+createdAt: 2025-08-23
+updatedAt: 2025-08-23
+title: Dokumentacja funkcji getLocaleLang | intlayer
+description: Zobacz, jak używać funkcji getLocaleLang w pakiecie intlayer
+keywords:
+  - getLocaleLang
+  - tłumaczenie
+  - Intlayer
+  - intlayer
+  - Internacjonalizacja
+  - Dokumentacja
+  - Next.js
+  - JavaScript
+  - React
+slugs:
+  - doc
+  - packages
+  - intlayer
+  - getLocaleLang
+history:
+  - version: 5.5.10
+    date: 2025-06-29
+    changes: Inicjalizacja historii
+---
+
+# Dokumentacja: funkcja `getLocaleLang` w `intlayer`
+
+## Opis
+
+Funkcja `getLocaleLang` wyodrębnia kod języka z ciągu lokalizacji (locale). Obsługuje lokalizacje z kodami krajów lub bez nich. Jeśli lokalizacja nie zostanie podana, domyślnie zwraca pusty ciąg znaków.
+
+## Parametry
+
+- `locale?: Locales`
+  - **Opis**: Ciąg lokalizacji (np. `Locales.ENGLISH_UNITED_STATES`, `Locales.FRENCH_CANADA`), z którego wyodrębniany jest kod języka.
+  - **Typ**: `Locales` (opcjonalny)
+
+## Zwracana wartość
+
+- **Typ**: `string`
+- **Opis**: Kod języka wyodrębniony z lokalizacji. Jeśli lokalizacja nie zostanie podana, zwraca pusty ciąg znaków (`''`).
+
+## Przykład użycia
+
+### Wyodrębnianie kodów języków:
+
+```typescript codeFormat="typescript"
+import { getLocaleLang, Locales } from "intlayer";
+
+getLocaleLang(Locales.ENGLISH_UNITED_STATES); // Wynik: "en"
+getLocaleLang(Locales.ENGLISH); // Wynik: "en"
+getLocaleLang(Locales.FRENCH_CANADA); // Wynik: "fr"
+getLocaleLang(Locales.FRENCH); // Wynik: "fr"
+```
+
+```javascript codeFormat="esm"
+import { getLocaleLang } from "intlayer";
+
+getLocaleLang(Locales.ENGLISH_UNITED_STATES); // Wynik: "en"
+getLocaleLang(Locales.ENGLISH); // Wynik: "en"
+getLocaleLang(Locales.FRENCH_CANADA); // Wynik: "fr"
+getLocaleLang(Locales.FRENCH); // Wynik: "fr"
+```
+
+```javascript codeFormat="commonjs"
+const { getLocaleLang } = require("intlayer");
+
+getLocaleLang(Locales.ENGLISH_UNITED_STATES); // Wynik: "en"
+getLocaleLang(Locales.ENGLISH); // Wynik: "en"
+getLocaleLang(Locales.FRENCH_CANADA); // Wynik: "fr"
+getLocaleLang(Locales.FRENCH); // Wynik: "fr"
+```
+
+## Przypadki brzegowe
+
+- **Brak podanej lokalizacji:**
+  - Funkcja zwraca pusty ciąg znaków, gdy `locale` jest `undefined`.
+
+- **Niepoprawne ciągi lokalizacji:**
+  - Jeśli `locale` nie jest zgodne z formatem `language-country` (np. `Locales.ENGLISH-US`), funkcja bezpiecznie zwraca część przed `'-'` lub cały ciąg znaków, jeśli `'-'` nie występuje.

package/docs/pl/packages/intlayer/getLocaleName.md

@@ -0,0 +1,118 @@
+---
+createdAt: 2025-08-23
+updatedAt: 2025-08-23
+title: Dokumentacja funkcji getLocaleName | intlayer
+description: Zobacz, jak używać funkcji getLocaleName w pakiecie intlayer
+keywords:
+  - getLocaleName
+  - tłumaczenie
+  - Intlayer
+  - intlayer
+  - Internacjonalizacja
+  - Dokumentacja
+  - Next.js
+  - JavaScript
+  - React
+slugs:
+  - doc
+  - packages
+  - intlayer
+  - getLocaleName
+history:
+  - version: 5.5.10
+    date: 2025-06-29
+    changes: Inicjalizacja historii
+---
+
+# Dokumentacja: funkcja `getLocaleName` w `intlayer`
+
+## Opis
+
+Funkcja `getLocaleName` zwraca zlokalizowaną nazwę podanego locale (`targetLocale`) w locale wyświetlającym (`displayLocale`). Jeśli `targetLocale` nie jest podany, zwraca nazwę `displayLocale` w jego własnym języku.
+
+## Parametry
+
+- `displayLocale: Locales`
+  - **Opis**: Locale, w którym zostanie wyświetlona nazwa docelowego locale.
+  - **Typ**: Enum lub string reprezentujący poprawne locale.
+
+- `targetLocale?: Locales`
+  - **Opis**: Locale, którego nazwa ma zostać zlokalizowana.
+  - **Typ**: Opcjonalny. Enum lub string reprezentujący poprawne locale.
+
+## Zwraca
+
+- **Typ**: `string`
+- **Opis**: Zlokalizowana nazwa `targetLocale` w `displayLocale`, lub własna nazwa `displayLocale`, jeśli `targetLocale` nie jest podany. Jeśli nie znaleziono tłumaczenia, zwraca `"Unknown locale"`.
+
+## Przykład użycia
+
+```typescript codeFormat="typescript"
+import { Locales, getLocaleName } from "intlayer";
+
+getLocaleName(Locales.ENGLISH); // Output: "English"
+getLocaleName(Locales.ENGLISH, Locales.FRENCH); // Output: "Anglais"
+getLocaleName(Locales.ENGLISH, Locales.ESPANOL); // Output: "Inglés"
+getLocaleName(Locales.ENGLISH, Locales.ENGLISH); // Output: "English"
+
+getLocaleName(Locales.FRENCH); // Output: "Français"
+getLocaleName(Locales.FRENCH, Locales.FRENCH); // Output: "Français"
+getLocaleName(Locales.FRENCH, Locales.ESPANOL); // Output: "Francés"
+getLocaleName(Locales.FRENCH, Locales.ENGLISH); // Output: "French"
+
+getLocaleName(Locales.CHINESE); // Output: "中文"
+getLocaleName(Locales.CHINESE, Locales.FRENCH); // Output: "Chinois"
+getLocaleName(Locales.CHINESE, Locales.ESPANOL); // Output: "Chino"
+getLocaleName(Locales.CHINESE, Locales.ENGLISH); // Output: "Chinese"
+
+getLocaleName("unknown-locale"); // Output: "Unknown locale"
+```
+
+```javascript codeFormat="esm"
+import { Locales, getLocaleName } from "intlayer";
+
+getLocaleName(Locales.ENGLISH); // Wynik: "English"
+getLocaleName(Locales.ENGLISH, Locales.FRENCH); // Wynik: "Anglais"
+getLocaleName(Locales.ENGLISH, Locales.ESPANOL); // Wynik: "Inglés"
+getLocaleName(Locales.ENGLISH, Locales.ENGLISH); // Wynik: "English"
+
+getLocaleName(Locales.FRENCH); // Wynik: "Français"
+getLocaleName(Locales.FRENCH, Locales.FRENCH); // Wynik: "Français"
+getLocaleName(Locales.FRENCH, Locales.ESPANOL); // Wynik: "Francés"
+getLocaleName(Locales.FRENCH, Locales.ENGLISH); // Wynik: "French"
+
+getLocaleName(Locales.CHINESE); // Wynik: "中文"
+getLocaleName(Locales.CHINESE, Locales.FRENCH); // Wynik: "Chinois"
+getLocaleName(Locales.CHINESE, Locales.ESPANOL); // Wynik: "Chino"
+getLocaleName(Locales.CHINESE, Locales.ENGLISH); // Wynik: "Chinese"
+
+getLocaleName("unknown-locale"); // Wynik: "Unknown locale"
+```
+
+```javascript codeFormat="commonjs"
+const { Locales, getLocaleName } = require("intlayer");
+
+getLocaleName(Locales.ENGLISH); // Wynik: "English"
+getLocaleName(Locales.ENGLISH, Locales.FRENCH); // Wynik: "Anglais"
+getLocaleName(Locales.ENGLISH, Locales.ESPANOL); // Wynik: "Inglés"
+getLocaleName(Locales.ENGLISH, Locales.ENGLISH); // Wynik: "English"
+
+getLocaleName(Locales.FRENCH); // Wynik: "Français"
+getLocaleName(Locales.FRENCH, Locales.FRENCH); // Wynik: "Français"
+getLocaleName(Locales.FRENCH, Locales.ESPANOL); // Wynik: "Francés"
+getLocaleName(Locales.FRENCH, Locales.ENGLISH); // Wynik: "French"
+
+getLocaleName(Locales.CHINESE); // Wynik: "中文"
+getLocaleName(Locales.CHINESE, Locales.FRENCH); // Wynik: "Chinois"
+getLocaleName(Locales.CHINESE, Locales.ESPANOL); // Wynik: "Chino"
+getLocaleName(Locales.CHINESE, Locales.ENGLISH); // Wynik: "Chinese"
+
+getLocaleName("unknown-locale"); // Wynik: "Unknown locale"
+```
+
+## Przypadki brzegowe
+
+- **Brak podanego `targetLocale`:**
+  - Funkcja domyślnie zwraca własną nazwę `displayLocale`.
+- **Brakujące tłumaczenia:**
+  - Jeśli `localeNameTranslations` nie zawiera wpisu dla `targetLocale` lub konkretnego `displayLocale`, funkcja korzysta z `ownLocalesName` lub zwraca `"Unknown locale"`.