Documentation: getHTMLTextDir Fonction dans intlayer
Description
La fonction getHTMLTextDir détermine la direction du texte (ltr, rtl ou auto) en fonction de la locale fournie. Elle est conçue pour aider les développeurs à définir l'attribut dir dans HTML pour un rendu correct du texte.
Paramètres
locale?: Locales
- Description : La chaîne de locale (par exemple, Locales.ENGLISH, Locales.ARABIC) utilisée pour déterminer la direction du texte.
- Type : Locales (optionnel)
Retours
- Type : Dir ('ltr' | 'rtl' | 'auto')
- Description : La direction du texte correspondant à la locale :
- 'ltr' pour les langues de gauche à droite.
- 'rtl' pour les langues de droite à gauche.
- 'auto' si la locale n'est pas reconnue.
Exemple d'utilisation
Déterminer la direction du texte
typescript
import { getHTMLTextDir } from "intlayer";getHTMLTextDir(Locales.ENGLISH); // Résultat : "ltr"getHTMLTextDir(Locales.FRENCH); // Résultat : "ltr"getHTMLTextDir(Locales.ARABIC); // Résultat : "rtl"Cas particuliers
Aucune locale fournie :
- La fonction retourne 'auto' lorsque locale est undefined.
Locale non reconnue :
- Pour les locales non reconnues, la fonction retourne par défaut 'auto'.
Utilisation dans les composants :
La fonction getHTMLTextDir peut être utilisée pour définir dynamiquement l'attribut dir dans un document HTML pour un rendu correct du texte en fonction de la locale.
tsx
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>);Dans l'exemple ci-dessus, l'attribut dir est défini dynamiquement en fonction de la locale.
Si vous avez une idée d’amélioration pour améliorer cette documentation, n’hésitez pas à contribuer en submitant une pull request sur GitHub.
Lien GitHub de la documentation