@intlayer/docs 9.1.3 → 9.2.0

package/docs/id/formatters.md

@@ -137,45 +137,40 @@ const MyComponent = () => {
 };
 ```
 
-## Intl yang Di-cache
+### Hook `useIntl`
 
-`Intl` yang diekspor adalah pembungkus tipis yang di-cache di sekitar `Intl` global. Ini menyimpan instance dari `NumberFormat`, `DateTimeFormat`, `RelativeTimeFormat`, `ListFormat`, `DisplayNames`, `Collator`, dan `PluralRules`, yang menghindari pembuatan ulang formatter yang sama berulang kali.
+Hook `useIntl` menyediakan akses langsung ke objek `Intl` yang terikat pada locale. Ini berguna ketika Anda memerlukan API `Intl` lengkap (misalnya, `DisplayNames`, `Collator`, `PluralRules`) dengan injeksi locale otomatis.
 
-Karena pembuatan formatter relatif mahal, caching ini meningkatkan performa tanpa mengubah perilaku. Pembungkus ini menampilkan API yang sama seperti `Intl` asli, sehingga penggunaannya identik.
-
-- Caching dilakukan per proses dan transparan bagi pemanggil.
+```tsx
+import { useIntl } from "react-intlayer/format";
 
-> Jika `Intl.DisplayNames` tidak tersedia di lingkungan, hanya satu peringatan khusus pengembang yang dicetak (pertimbangkan menggunakan polyfill).
+const MyComponent = () => {
+  const intl = useIntl(); // menggunakan locale konteks
 
-Contoh:
+  // API Intl standar, tetapi locale disuntikkan secara otomatis ketika undefined
+  const formatted = new intl.NumberFormat(undefined, {
+    style: "currency",
+    currency: "USD",
+  }).format(123.45);
 
-```ts
-import { Intl } from "intlayer";
+  // Anda masih dapat menimpa locale jika diperlukan
+  const date = new intl.DateTimeFormat("fr-FR").format(new Date());
 
-// Format angka
-const numberFormat = new Intl.NumberFormat("en-GB", {
-  style: "currency",
-  currency: "GBP",
-});
-numberFormat.format(1234.5); // "£1,234.50"
+  // Akses fitur Intl lainnya
+  const displayNames = new intl.DisplayNames(undefined, { type: "language" });
+  const languageName = displayNames.of("fr"); // "French" (atau terlokalisasi)
 
-// Nama tampilan untuk bahasa, wilayah, dll.
-const displayNames = new Intl.DisplayNames("fr", { type: "language" });
-displayNames.of("en"); // "anglais"
-
-// Kolasi untuk pengurutan
-const collator = new Intl.Collator("fr", { sensitivity: "base" });
-collator.compare("é", "e"); // 0 (sama)
-
-// Aturan jamak
-const pluralRules = new Intl.PluralRules("fr");
-pluralRules.select(1); // "one"
-pluralRules.select(2); // "other"
+  return (
+    <div>
+      <p>{formatted}</p>
+      <p>{date}</p>
+      <p>{languageName}</p>
+    </div>
+  );
+};
 ```
 
-## Utilitas Intl Tambahan
-
-Selain pembantu formatter, Anda juga dapat menggunakan pembungkus Intl yang di-cache secara langsung untuk fitur Intl lainnya:
+## Vue Formatters
 
 ### `Intl.DisplayNames`
 
@@ -281,6 +276,189 @@ pluralRules.select(3); // "few"
 pluralRules.select(11); // "many"
 ```
 
+### Fungsi Formatter
+
+#### `number(value, options?)`
+
+Memformat nilai numerik menggunakan pengelompokan dan desimal yang menyadari lokal.
+
+- **value**: `number | string`
+- **options**: `Intl.NumberFormatOptions & { locale?: LocalesValues }`
+
+```ts
+number(123456.789); // "123,456.789" (in en-US)
+number("1000000", { locale: "fr" }); // "1 000 000"
+number(1234.5, { minimumFractionDigits: 2 }); // "1,234.50"
+```
+
+#### `percentage(value, options?)`
+
+Memformat angka sebagai string persentase. Nilai lebih besar dari 1 dinormalisasi (misalnya, `25` → `25%`, `0.25` → `25%`).
+
+- **value**: `number | string`
+- **options**: `Intl.NumberFormatOptions & { locale?: LocalesValues }`
+
+```ts
+percentage(0.25); // "25%"
+percentage(25); // "25%"
+percentage(0.237, { minimumFractionDigits: 1 }); // "23.7%"
+```
+
+#### `currency(value, options?)`
+
+Memformat nilai sebagai mata uang yang dilokalisasi. Default ke `USD`.
+
+- **value**: `number | string`
+- **options**: `Intl.NumberFormatOptions & { locale?: LocalesValues }`
+  - Common: `currency`, `currencyDisplay` (`"symbol" | "code" | "name"`)
+
+```ts
+currency(1234.5, { currency: "EUR" }); // "€1,234.50"
+currency("5000", { locale: "fr", currency: "CAD", currencyDisplay: "code" }); // "5 000,00 CAD"
+```
+
+#### `date(date, optionsOrPreset?)`
+
+Memformat nilai tanggal/waktu.
+
+- **date**: `Date | string | number`
+- **optionsOrPreset**: `Intl.DateTimeFormatOptions & { locale?: LocalesValues }` atau preset: `"short" | "long" | "dateOnly" | "timeOnly" | "full"`
+
+```ts
+date(new Date(), "short"); // misalnya, "08/02/25, 14:30"
+date("2025-08-02T14:30:00Z", { locale: "fr", month: "long", day: "numeric" }); // "2 août"
+```
+
+#### `relativeTime(from, to?, options?)`
+
+Memformat waktu relatif antara dua momen.
+
+- **from**: `Date | string | number`
+- **to**: `Date | string | number` (default ke `new Date()`)
+- **options**: `{ locale?, unit?, numeric?, style? }`
+
+```ts
+const now = new Date();
+const in3Days = new Date(now.getTime() + 3 * 864e5);
+relativeTime(now, in3Days, { unit: "day" }); // "dalam 3 hari"
+
+const twoHoursAgo = new Date(now.getTime() - 2 * 3600e3);
+relativeTime(now, twoHoursAgo, { unit: "hour", numeric: "auto" }); // "2 jam yang lalu"
+```
+
+#### `units(value, options?)`
+
+Memformat nilai numerik dengan unit.
+
+- **value**: `number | string`
+- **options**: `Intl.NumberFormatOptions & { locale?: LocalesValues }`
+  - Common: `unit` (e.g., `"kilometer"`, `"byte"`), `unitDisplay` (`"short" | "narrow" | "long"`)
+
+```ts
+units(5, { unit: "kilometer", unitDisplay: "long", locale: "en-GB" }); // "5 kilometers"
+units(1024, { unit: "byte", unitDisplay: "narrow" }); // "1,024B"
+```
+
+#### `compact(value, options?)`
+
+Memformat angka menggunakan notasi kompak.
+
+- **value**: `number | string`
+- **options**: `Intl.NumberFormatOptions & { locale?: LocalesValues }`
+
+```ts
+compact(1200); // "1.2K"
+compact("1000000", { locale: "fr", compactDisplay: "long" }); // "1 million"
+```
+
+#### `list(values, options?)`
+
+Memformat array menjadi string list yang terlokalisasi.
+
+- **values**: `(string | number)[]`
+- **options**: `Intl.ListFormatOptions & { locale?: LocalesValues }`
+  - Common: `type` (`"conjunction" | "disjunction" | "unit"`), `style` (`"long" | "short" | "narrow"`)
+
+```ts
+list(["apple", "banana", "orange"]); // "apple, banana, and orange"
+list(["red", "green", "blue"], { locale: "fr", type: "disjunction" }); // "rouge, vert ou bleu"
+```
+
+## Cached Intl
+
+`Intl` yang diekspor dari `intlayer` adalah wrapper yang di-cache di sekitar `Intl` global. Ini memoizes instance formatter (`NumberFormat`, `DateTimeFormat`, dll.) untuk menghindari pengulangan konstruksinya, meningkatkan performance.
+
+```ts
+import { Intl } from "intlayer";
+
+// Pemformatan angka
+const numberFormat = new Intl.NumberFormat("en-GB", {
+  style: "currency",
+  currency: "GBP",
+});
+numberFormat.format(1234.5); // "£1,234.50"
+
+// Nama tampilan untuk bahasa, region, dll.
+const displayNames = new Intl.DisplayNames("fr", { type: "language" });
+displayNames.of("en"); // "anglais"
+
+// Collation untuk pengurutan
+const collator = new Intl.Collator("fr", { sensitivity: "base" });
+collator.compare("é", "e"); // 0 (equal)
+
+// Aturan plural
+const pluralRules = new Intl.PluralRules("fr");
+pluralRules.select(1); // "one"
+pluralRules.select(2); // "other"
+```
+
+### Fitur Intl Tambahan
+
+#### `Intl.DisplayNames`
+
+Untuk nama-nama terlokalisasi dari bahasa, region, mata uang, dan skrip:
+
+```ts
+import { Intl } from "intlayer";
+
+const languageNames = new Intl.DisplayNames("en", { type: "language" });
+languageNames.of("fr"); // "French"
+
+const regionNames = new Intl.DisplayNames("fr", { type: "region" });
+regionNames.of("US"); // "États-Unis"
+```
+
+#### `Intl.Collator`
+
+Untuk perbandingan dan pengurutan string yang peka terhadap locale:
+
+```ts
+import { Intl } from "intlayer";
+
+const collator = new Intl.Collator("de", {
+  sensitivity: "base",
+  numeric: true,
+});
+
+const words = ["äpfel", "zebra", "100", "20"];
+words.sort(collator.compare); // ["20", "100", "äpfel", "zebra"]
+```
+
+#### `Intl.PluralRules`
+
+Untuk menentukan bentuk plural dalam lokal yang berbeda:
+
+```ts
+import { Intl } from "intlayer";
+
+const pluralRules = new Intl.PluralRules("ar");
+pluralRules.select(0); // "zero"
+pluralRules.select(1); // "one"
+pluralRules.select(2); // "two"
+pluralRules.select(3); // "few"
+pluralRules.select(11); // "many"
+```
+
 ## Utilitas Locale
 
 ### `getLocaleName(displayLocale, targetLocale?)`
@@ -419,8 +597,6 @@ const content = getTranslation(
 - **locale**: Locale target (default ke locale default yang dikonfigurasi)
 - **fallback**: Apakah akan kembali ke locale default (default true)
 
-### Fitur Intl Tambahan
-
 ### `getIntlayer(dictionaryKey, locale?, plugins?)`
 
 Mengambil dan mengubah konten dari kamus berdasarkan kunci:
@@ -436,281 +612,8 @@ const nestedContent = getIntlayer("common", "fr", customPlugins);
 - **locale**: Locale opsional (default ke locale default yang dikonfigurasi)
 - **plugins**: Array opsional dari plugin transformasi kustom
 
-## Formatter
-
-Semua helper di bawah ini diekspor dari `intlayer`.
-
-### `number(value, options?)`
-
-Memformat nilai numerik menggunakan pengelompokan dan desimal yang sesuai dengan locale.
-
-- **value**: `number | string`
-- **options**: `Intl.NumberFormatOptions & { locale?: LocalesValues }`
-
-Contoh:
-
-```ts
-import { number } from "intlayer";
-
-number(123456.789); // "123,456.789" (dalam en-US)
-number("1000000", { locale: "fr" }); // "1 000 000"
-number(1234.5, { minimumFractionDigits: 2 }); // "1,234.50"
-```
-
-### `percentage(value, options?)`
-
-Memformat angka sebagai string persentase.
-
-Perilaku: nilai yang lebih besar dari 1 diartikan sebagai persentase utuh dan dinormalisasi (misalnya, `25` → `25%`, `0.25` → `25%`).
-
-- **value**: `number | string`
-- **options**: `Intl.NumberFormatOptions & { locale?: LocalesValues }`
-
-Contoh:
-
-```ts
-import { percentage } from "intlayer";
-
-percentage(0.25); // "25%"
-percentage(25); // "25%"
-percentage(0.237, { minimumFractionDigits: 1 }); // "23.7%"
-```
-
-### `currency(value, options?)`
-
-Memformat nilai sebagai mata uang lokal. Default ke `USD` dengan dua digit pecahan.
-
-- **value**: `number | string`
-- **options**: `Intl.NumberFormatOptions & { locale?: LocalesValues }`
-  - Field umum: `currency` (misalnya, `"EUR"`), `currencyDisplay` (`"symbol" | "code" | "name"`)
-
-Contoh:
-
-```ts
-import { currency } from "intlayer";
-
-currency(1234.5, { currency: "EUR" }); // "€1,234.50"
-currency("5000", { locale: "fr", currency: "CAD", currencyDisplay: "code" }); // "5 000,00 CAD"
-```
-
-### `date(date, optionsOrPreset?)`
-
-Memformat nilai tanggal/waktu dengan `Intl.DateTimeFormat`.
-
-- **date**: `Date | string | number`
-- **optionsOrPreset**: `Intl.DateTimeFormatOptions & { locale?: LocalesValues }` atau salah satu preset:
-  - Preset: `"short" | "long" | "dateOnly" | "timeOnly" | "full"`
-
-Contoh:
-
-```ts
-import { date } from "intlayer";
-
-date(new Date(), "short"); // misalnya, "08/02/25, 14:30"
-date("2025-08-02T14:30:00Z", { locale: "fr", month: "long", day: "numeric" }); // "2 août"
-```
-
-### `relativeTime(from, to = new Date(), options?)`
-
-Memformat waktu relatif antara dua momen dengan `Intl.RelativeTimeFormat`.
-
-- Berikan "now" sebagai argumen pertama dan target sebagai argumen kedua untuk mendapatkan frasa yang alami.
-- **from**: `Date | string | number`
-- **to**: `Date | string | number` (defaultnya `new Date()`)
-- **options**: `{ locale?: LocalesValues; unit?: Intl.RelativeTimeFormatUnit; numeric?: Intl.RelativeTimeFormatNumeric; style?: Intl.RelativeTimeFormatStyle }`
-  - Default `unit` adalah `"second"`.
-
-Contoh:
-
-```ts
-import { relativeTime } from "intlayer";
-
-const now = new Date();
-const in3Days = new Date(now.getTime() + 3 * 864e5);
-relativeTime(now, in3Days, { unit: "day" }); // "dalam 3 hari"
-
-const twoHoursAgo = new Date(now.getTime() - 2 * 3600e3);
-relativeTime(now, twoHoursAgo, { unit: "hour", numeric: "auto" }); // "2 jam yang lalu"
-```
-
-### `units(value, options?)`
-
-Memformat nilai numerik sebagai string unit yang dilokalkan menggunakan `Intl.NumberFormat` dengan `style: 'unit'`.
-
-- **value**: `number | string`
-- **options**: `Intl.NumberFormatOptions & { locale?: LocalesValues }`
-  - Field umum: `unit` (misalnya, `"kilometer"`, `"byte"`), `unitDisplay` (`"short" | "narrow" | "long"`)
-  - Default: `unit: 'day'`, `unitDisplay: 'short'`, `useGrouping: false`
-
-Contoh:
-
-```ts
-import { units } from "intlayer";
-
-units(5, { unit: "kilometer", unitDisplay: "long", locale: "en-GB" }); // "5 kilometers"
-units(1024, { unit: "byte", unitDisplay: "narrow" }); // "1,024B" (tergantung locale)
-```
-
-### `compact(value, options?)`
-
-Memformat angka menggunakan notasi ringkas (misalnya, `1.2K`, `1M`).
-
-- **value**: `number | string`
-- **options**: `Intl.NumberFormatOptions & { locale?: LocalesValues }` (menggunakan `notation: 'compact'` secara internal)
-
-Contoh:
-
-```ts
-import { compact } from "intlayer";
-
-compact(1200); // "1.2K"
-compact("1000000", { locale: "fr", compactDisplay: "long" }); // "1 juta"
-```
-
-### `list(values, options?)`
-
-Memformat array nilai menjadi string daftar yang dilokalkan menggunakan `Intl.ListFormat`.
-
-- **values**: `(string | number)[]`
-- **options**: `Intl.ListFormatOptions & { locale?: LocalesValues }`
-  - Field umum: `type` (`"conjunction" | "disjunction" | "unit"`), `style` (`"long" | "short" | "narrow"`)
-  - Default: `type: 'conjunction'`, `style: 'long'`
-
-Contoh:
-
-```ts
-import { list } from "intlayer";
-
-list(["apple", "banana", "orange"]); // "apple, banana, dan orange"
-list(["red", "green", "blue"], { locale: "fr", type: "disjunction" }); // "rouge, vert ou bleu"
-list([1, 2, 3], { type: "unit" }); // "1, 2, 3"
-```
-
-## Utilitas Penanganan Konten
-
 ## Catatan
 
 - Semua helper menerima input `string`; secara internal akan dikonversi menjadi angka atau tanggal.
 - Locale default adalah `internationalization.defaultLocale` yang telah Anda konfigurasi jika tidak disediakan.
 - Utilitas ini adalah pembungkus tipis; untuk pemformatan lanjutan, gunakan opsi standar `Intl`.
-
-## Titik masuk dan ekspor ulang (`@index.ts`)
-
-Formatter berada di paket inti dan diekspor ulang dari paket tingkat atas untuk menjaga impor tetap ergonomis di berbagai runtime:
-
-Contoh:
-
-```ts
-// Kode aplikasi (direkomendasikan)
-import {
-  number,
-  currency,
-  date,
-  relativeTime,
-  units,
-  compact,
-  list,
-  Intl,
-  getLocaleName,
-  getLocaleLang,
-  getLocaleFromPath,
-  getPathWithoutLocale,
-  getLocalizedUrl,
-  getHTMLTextDir,
-  getContent,
-  getTranslation,
-  getIntlayer,
-} from "intlayer";
-```
-
-### React
-
-Komponen klien:
-
-```tsx
-import {
-  useNumber,
-  useCurrency,
-  useDate,
-  usePercentage,
-  useCompact,
-  useList,
-  useRelativeTime,
-  useUnit,
-} from "react-intlayer/format";
-// atau di aplikasi Preact
-// "preact-intlayer/format";
-// atau di aplikasi Next.js
-// "next-intlayer/client/format";
-
-const MyComponent = () => {
-  const number = useNumber();
-  const currency = useCurrency();
-  const date = useDate();
-  const percentage = usePercentage();
-  const compact = useCompact();
-  const list = useList();
-  const relativeTime = useRelativeTime();
-  const unit = useUnit();
-
-  return (
-    <div>
-      <p>{number(123456.789)}</p>
-      <p>{currency(1234.5, { currency: "EUR" })}</p>
-      <p>{date(new Date(), "short")}</p>
-      <p>{percentage(0.25)}</p>
-      <p>{compact(1200)}</p>
-      <p>{list(["apel", "pisang", "jeruk"])}</p>
-      <p>{relativeTime(new Date(), new Date() + 1000)}</p>
-      <p>{unit(123456.789, { unit: "kilometer" })}</p>
-    </div>
-  );
-};
-```
-
-Komponen server (atau runtime React Server):
-
-```ts
-import {
-  useNumber,
-  useCurrency,
-  useDate,
-  usePercentage,
-  useCompact,
-  useList,
-  useRelativeTime,
-  useUnit,
-} from "react-intlayer/server/format";
-// atau di aplikasi Next.js
-import {
-  useNumber,
-  useCurrency,
-  useDate,
-  usePercentage,
-  useCompact,
-  useList,
-  useRelativeTime,
-  useUnit,
-} from "next-intlayer/server/format";
-```
-
-> Hooks tersebut akan mempertimbangkan locale dari `IntlayerProvider` atau `IntlayerServerProvider`
-
-### Vue
-
-Komponen klien:
-
-```ts
-import {
-  useNumber,
-  useCurrency,
-  useDate,
-  usePercentage,
-  useCompact,
-  useList,
-  useRelativeTime,
-  useUnit,
-} from "vue-intlayer/format";
-```
-
-> Composables tersebut akan mempertimbangkan locale dari `IntlayerProvider` yang di-inject