@intlayer/docs 9.0.0-canary.2 → 9.0.0-canary.4

package/docs/fr/packages/solid-intlayer/usePathname.md

@@ -0,0 +1,119 @@
+---
+createdAt: 2026-06-22
+updatedAt: 2026-06-22
+title: Documentation du Hook usePathname | solid-intlayer
+description: Découvrez comment utiliser le hook usePathname du package solid-intlayer
+keywords:
+  - usePathname
+  - pathname
+  - locale
+  - Intlayer
+  - Internationalisation
+  - Documentation
+  - Solid
+  - Solid.js
+  - JavaScript
+slugs:
+  - doc
+  - packages
+  - solid-intlayer
+  - usePathname
+history:
+  - version: 10.0.0
+    date: 2026-06-23
+    changes: "Ajout de l'utilitaire usePathname"
+  - version: 8.2.0
+    date: 2026-06-22
+    changes: "Initialisation de l'historique"
+author: aymericzip
+---
+
+# Intégration avec Solid : Documentation du Hook `usePathname`
+
+Le hook `usePathname` retourne le chemin du navigateur (pathname) actuel avec le segment de locale supprimé, sous la forme d'un `Accessor<string>` de Solid. Il est utile pour la navigation liée à la langue — par exemple, déterminer quel élément de navigation est actif — sans avoir à supprimer manuellement le préfixe de la locale.
+
+## Importer `usePathname` avec Solid
+
+```typescript
+import { usePathname } from "solid-intlayer";
+```
+
+## Aperçu
+
+`usePathname` crée un signal réactif initialisé à partir de `window.location.pathname`, retire le préfixe de la locale via `getPathWithoutLocale` et met à jour le signal chaque fois que le navigateur déclenche un événement `popstate` (navigation retour/avant). L'écouteur d'événements est nettoyé automatiquement via `onCleanup`.
+
+## Utilisation
+
+```tsx fileName="src/components/NavItem.tsx"
+import type { Component } from "solid-js";
+import { usePathname } from "solid-intlayer";
+
+type NavItemProps = {
+  href: string;
+  label: string;
+};
+
+const NavItem: Component<NavItemProps> = ({ href, label }) => {
+  const pathname = usePathname();
+
+  return (
+    <a href={href} aria-current={pathname() === href ? "page" : undefined}>
+      {label}
+    </a>
+  );
+};
+
+export default NavItem;
+```
+
+## Valeur de retour
+
+| Type               | Description                                                                                          |
+| ------------------ | ---------------------------------------------------------------------------------------------------- |
+| `Accessor<string>` | Accessor Solid (getter réactif) retournant le chemin (pathname) actuel sans le préfixe de la locale. |
+
+## Comportement
+
+- **Suppression de la locale** : Retire le segment de locale du début du chemin (par ex. `/fr/dashboard` → `/dashboard`).
+- **Réactif** : Se met à jour automatiquement lors d'événements `popstate` (navigation retour / avant du navigateur).
+- **Sûr pour SSR** : Retourne `""` quand `window` n'est pas disponible.
+- **Nettoyage** : L'écouteur `popstate` est retiré automatiquement via la fonction `onCleanup` de Solid.
+
+## Exemple
+
+```tsx fileName="src/components/Sidebar.tsx"
+import type { Component } from "solid-js";
+import { For } from "solid-js";
+import { usePathname } from "solid-intlayer";
+
+const links = [
+  { href: "/dashboard", label: "Tableau de bord" },
+  { href: "/settings", label: "Paramètres" },
+];
+
+const Sidebar: Component = () => {
+  const pathname = usePathname();
+
+  return (
+    <nav>
+      <For each={links}>
+        {({ href, label }) => (
+          <a
+            href={href}
+            style={{ "font-weight": pathname() === href ? "bold" : "normal" }}
+          >
+            {label}
+          </a>
+        )}
+      </For>
+    </nav>
+  );
+};
+
+export default Sidebar;
+```
+
+## Voir Aussi
+
+- [`useLocale`](https://github.com/aymericzip/intlayer/blob/main/docs/docs/fr/packages/solid-intlayer/useLocale.md) — locale actuelle + commutateur de locale
+- [`getPathWithoutLocale`](https://github.com/aymericzip/intlayer/blob/main/docs/docs/fr/packages/intlayer/getPathWithoutLocale.md) — utilitaire sous-jacent utilisé par ce hook

package/docs/fr/packages/svelte-intlayer/exports.md

@@ -14,6 +14,9 @@ slugs:
   - svelte-intlayer
   - exports
 history:
+  - version: 10.0.0
+    date: 2026-06-23
+    changes: "Ajout de l'utilitaire usePathname"
   - version: 8.0.0
     date: 2026-01-21
     changes: "Documentation unifiée pour tous les exports"
@@ -71,6 +74,7 @@ import "svelte-intlayer";
 | `useDictionaryAsync`   | Identique à `useDictionary`, mais gère les dictionnaires asynchrones.                                                                | -                                                                                                                        |
 | `useDictionaryDynamic` | Identique à `useDictionary`, mais gère les dictionnaires dynamiques.                                                                 | -                                                                                                                        |
 | `useLocale`            | Retourne la locale courante et une fonction pour la définir.                                                                         | -                                                                                                                        |
+| `usePathname`          | Retourne le pathname courant en tant que store `Readable<string>` avec le segment de locale supprimé. Réactif à `popstate`.          | [usePathname](https://github.com/aymericzip/intlayer/blob/main/docs/docs/fr/packages/svelte-intlayer/usePathname.md)     |
 | `useRewriteURL`        | Fonction côté client pour gérer les réécritures d'URL. Met automatiquement à jour l'URL si une règle de réécriture localisée existe. | [useRewriteURL](https://github.com/aymericzip/intlayer/blob/main/docs/docs/fr/packages/svelte-intlayer/useRewriteURL.md) |
 | `useIntl`              | Retourne l'objet Intl pour la locale courante.                                                                                       | -                                                                                                                        |
 

package/docs/fr/packages/svelte-intlayer/usePathname.md

@@ -0,0 +1,103 @@
+---
+createdAt: 2026-06-22
+updatedAt: 2026-06-22
+title: Documentation de la fonction usePathname | svelte-intlayer
+description: Découvrez comment utiliser la fonction usePathname du package svelte-intlayer
+keywords:
+  - usePathname
+  - pathname
+  - locale
+  - Intlayer
+  - Internationalisation
+  - Documentation
+  - Svelte
+  - JavaScript
+slugs:
+  - doc
+  - packages
+  - svelte-intlayer
+  - usePathname
+history:
+  - version: 10.0.0
+    date: 2026-06-23
+    changes: "Ajout de l'utilitaire usePathname"
+  - version: 8.2.0
+    date: 2026-06-22
+    changes: "Initialisation de l'historique"
+author: aymericzip
+---
+
+# Intégration Svelte : Documentation de `usePathname`
+
+La fonction `usePathname` retourne le pathname actuel du navigateur sans le segment de la locale, sous forme de store Svelte `Readable<string>`. Cela est utile pour construire une navigation sensible à la locale — par exemple, déterminer quel élément de navigation est actif — sans avoir à supprimer manuellement le préfixe de la locale.
+
+## Importer `usePathname` dans Svelte
+
+```typescript
+import { usePathname } from "svelte-intlayer";
+```
+
+## Aperçu
+
+`usePathname` crée un store Svelte lisible qui lit `window.location.pathname`, retire le préfixe de la locale via `getPathWithoutLocale`, et émet une nouvelle valeur chaque fois que le navigateur déclenche un événement `popstate` (navigation retour/avance). Souscrivez avec la syntaxe de store `$` dans les composants.
+
+## Utilisation
+
+```svelte fileName="src/components/NavItem.svelte"
+<script lang="ts">
+  import { usePathname } from "svelte-intlayer";
+
+  export let href: string;
+  export let label: string;
+
+  const pathname = usePathname();
+</script>
+
+<a {href} aria-current={$pathname === href ? "page" : undefined}>
+  {label}
+</a>
+```
+
+## Valeur de retour
+
+| Type               | Description                                                                     |
+| ------------------ | ------------------------------------------------------------------------------- |
+| `Readable<string>` | Store Svelte lisible contenant le pathname actuel sans le préfixe de la locale. |
+
+## Comportement
+
+- **Suppression de la locale** : Retire le segment de locale de début (ex. `/fr/dashboard` → `/dashboard`).
+- **Réactivité** : Émet une nouvelle valeur à chaque événement `popstate` (navigation arrière / avant du navigateur).
+- **Sûr pour le SSR** : Retourne `""` lorsque `window` n'est pas disponible.
+- **Nettoyage** : L'écouteur `popstate` est retiré automatiquement lorsque le dernier abonné se désabonne.
+
+## Exemple
+
+```svelte fileName="src/components/Sidebar.svelte"
+<script lang="ts">
+  import { usePathname } from "svelte-intlayer";
+
+  const links = [
+    { href: "/dashboard", label: "Tableau de bord" },
+    { href: "/settings", label: "Paramètres" },
+  ];
+
+  const pathname = usePathname();
+</script>
+
+<nav>
+  {#each links as link}
+    <a
+      href={link.href}
+      style:font-weight={$pathname === link.href ? "bold" : "normal"}
+    >
+      {link.label}
+    </a>
+  {/each}
+</nav>
+```
+
+## Voir aussi
+
+- [`useLocale`](https://github.com/aymericzip/intlayer/blob/main/docs/docs/fr/packages/svelte-intlayer/useLocale.md) — locale actuelle + sélecteur de locale
+- [`getPathWithoutLocale`](https://github.com/aymericzip/intlayer/blob/main/docs/docs/fr/packages/intlayer/getPathWithoutLocale.md) — utilitaire sous-jacent utilisé par ce hook

package/docs/fr/packages/vue-intlayer/exports.md

@@ -14,6 +14,9 @@ slugs:
   - vue-intlayer
   - exports
 history:
+  - version: 10.0.0
+    date: 2026-06-23
+    changes: "Ajout de l'utilitaire usePathname"
   - version: 8.0.0
     date: 2026-01-21
     changes: "Documentation unifiée pour toutes les exportations"
@@ -52,16 +55,17 @@ Import :
 import "vue-intlayer";
 ```
 
-| Composable             | Description                                                                                                                            | Doc associée                                                                                                          |
-| ---------------------- | -------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------- |
-| `useIntlayer`          | Basé sur `useDictionary`, mais injecte une version optimisée du dictionnaire provenant de la déclaration générée.                      | -                                                                                                                     |
-| `useDictionary`        | Traite les objets qui ressemblent à des dictionnaires (clé, contenu). Il traite les traductions `t()`, les énumérations, etc.          | -                                                                                                                     |
-| `useDictionaryAsync`   | Identique à `useDictionary`, mais gère les dictionnaires asynchrones.                                                                  | -                                                                                                                     |
-| `useDictionaryDynamic` | Identique à `useDictionary`, mais gère les dictionnaires dynamiques.                                                                   | -                                                                                                                     |
-| `useLocale`            | Renvoie la locale actuelle et une fonction pour la définir.                                                                            | -                                                                                                                     |
-| `useRewriteURL`        | Composable côté client pour gérer les réécritures d'URL. Met automatiquement à jour l'URL si une règle de réécriture localisée existe. | [useRewriteURL](https://github.com/aymericzip/intlayer/blob/main/docs/docs/fr/packages/vue-intlayer/useRewriteURL.md) |
-| `useIntl`              | Retourne l'objet Intl pour la locale courante.                                                                                         | -                                                                                                                     |
-| `useLoadDynamic`       | Composable pour charger des dictionnaires dynamiques.                                                                                  | -                                                                                                                     |
+| Composable             | Description                                                                                                                                      | Doc associée                                                                                                          |
+| ---------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------ | --------------------------------------------------------------------------------------------------------------------- |
+| `useIntlayer`          | Basé sur `useDictionary`, mais injecte une version optimisée du dictionnaire provenant de la déclaration générée.                                | -                                                                                                                     |
+| `useDictionary`        | Traite les objets qui ressemblent à des dictionnaires (clé, contenu). Il traite les traductions `t()`, les énumérations, etc.                    | -                                                                                                                     |
+| `useDictionaryAsync`   | Identique à `useDictionary`, mais gère les dictionnaires asynchrones.                                                                            | -                                                                                                                     |
+| `useDictionaryDynamic` | Identique à `useDictionary`, mais gère les dictionnaires dynamiques.                                                                             | -                                                                                                                     |
+| `useLocale`            | Renvoie la locale actuelle et une fonction pour la définir.                                                                                      | -                                                                                                                     |
+| `usePathname`          | Retourne le chemin (pathname) actuel sous forme de `ComputedRef<string>` avec le segment de la locale retiré. Réactif aux événements `popstate`. | [usePathname](https://github.com/aymericzip/intlayer/blob/main/docs/docs/fr/packages/vue-intlayer/usePathname.md)     |
+| `useRewriteURL`        | Composable côté client pour gérer les réécritures d'URL. Met automatiquement à jour l'URL si une règle de réécriture localisée existe.           | [useRewriteURL](https://github.com/aymericzip/intlayer/blob/main/docs/docs/fr/packages/vue-intlayer/useRewriteURL.md) |
+| `useIntl`              | Retourne l'objet Intl pour la locale courante.                                                                                                   | -                                                                                                                     |
+| `useLoadDynamic`       | Composable pour charger des dictionnaires dynamiques.                                                                                            | -                                                                                                                     |
 
 ### Fonctions
 

package/docs/fr/packages/vue-intlayer/usePathname.md

@@ -0,0 +1,109 @@
+---
+createdAt: 2026-06-22
+updatedAt: 2026-06-22
+title: Documentation de la fonction usePathname | vue-intlayer
+description: Découvrez comment utiliser la fonction usePathname du package vue-intlayer
+keywords:
+  - usePathname
+  - pathname
+  - locale
+  - Intlayer
+  - Internationalisation
+  - Documentation
+  - Vue
+  - JavaScript
+slugs:
+  - doc
+  - packages
+  - vue-intlayer
+  - usePathname
+history:
+  - version: 10.0.0
+    date: 2026-06-23
+    changes: "Ajout de l'utilitaire usePathname"
+  - version: 8.2.0
+    date: 2026-06-22
+    changes: "Initialisation de l'historique"
+author: aymericzip
+---
+
+# Intégration Vue : Documentation de `usePathname`
+
+La fonction `usePathname` retourne le chemin de l'URL actuelle (pathname) du navigateur sans le segment de la locale, sous la forme d'une `ComputedRef<string>` de Vue. C'est utile pour construire une navigation qui prend en compte la locale — par exemple, pour déterminer quel élément de navigation est actif — sans avoir à retirer le préfixe de locale manuellement.
+
+## Importer `usePathname` dans Vue
+
+```typescript
+import { usePathname } from "vue-intlayer";
+```
+
+## Vue d'ensemble
+
+`usePathname` crée une référence calculée (computed ref) Vue qui lit `window.location.pathname`, supprime le préfixe de la locale via `getPathWithoutLocale`, et met à jour sa valeur chaque fois que le navigateur déclenche un événement `popstate` (navigation retour/avance). La valeur peut être utilisée directement dans vos templates Vue ou vos fonctions setup.
+
+## Utilisation
+
+```vue fileName="src/components/NavItem.vue"
+<script setup lang="ts">
+import { usePathname } from "vue-intlayer";
+
+const props = defineProps<{
+  href: string;
+  label: string;
+}>();
+
+const pathname = usePathname();
+</script>
+
+<template>
+  <a :href="href" :aria-current="pathname === href ? 'page' : undefined">
+    {{ label }}
+  </a>
+</template>
+```
+
+## Valeur retournée
+
+| Type                  | Description                                                                                 |
+| --------------------- | ------------------------------------------------------------------------------------------- |
+| `ComputedRef<string>` | Une référence calculée Vue contenant le chemin (pathname) actuel sans le préfixe de locale. |
+
+## Comportement
+
+- **Suppression de la locale** : Retire le segment de locale au début de l'URL (par ex. `/fr/dashboard` → `/dashboard`).
+- **Réactif** : Met à jour la valeur à chaque événement `popstate` (navigation arrière / avant dans le navigateur).
+- **Compatible SSR** : Renvoie `""` lorsque `window` n'est pas disponible.
+- **Nettoyage (Cleanup)** : L'écouteur `popstate` est automatiquement ajouté lors de l'initialisation et n'a pas besoin de nettoyage manuel par composant dans la plupart des cas, grâce à la gestion du cycle de vie globale de Vue.
+
+## Exemple
+
+```vue fileName="src/components/Sidebar.vue"
+<script setup lang="ts">
+import { usePathname } from "vue-intlayer";
+
+const links = [
+  { href: "/dashboard", label: "Tableau de bord" },
+  { href: "/settings", label: "Paramètres" },
+];
+
+const pathname = usePathname();
+</script>
+
+<template>
+  <nav>
+    <a
+      v-for="link in links"
+      :key="link.href"
+      :href="link.href"
+      :style="{ fontWeight: pathname === link.href ? 'bold' : 'normal' }"
+    >
+      {{ link.label }}
+    </a>
+  </nav>
+</template>
+```
+
+## Fonctions liées
+
+- [`useLocale`](https://github.com/aymericzip/intlayer/blob/main/docs/docs/fr/packages/vue-intlayer/useLocale.md) — locale actuelle + commutateur de locale
+- [`getPathWithoutLocale`](https://github.com/aymericzip/intlayer/blob/main/docs/docs/fr/packages/intlayer/getPathWithoutLocale.md) — l'utilitaire sous-jacent utilisé par ce hook