Documentazione: getHTMLTextDir Funzione in intlayer
Descrizione:
La funzione getHTMLTextDir determina la direzione del testo (ltr, rtl o auto) in base alla locale fornita. È progettata per aiutare gli sviluppatori a impostare l'attributo dir in HTML per un corretto rendering del testo.
Parametri:
locale?: Locales
- Descrizione: La stringa della locale (ad esempio, Locales.ENGLISH, Locales.ARABIC) utilizzata per determinare la direzione del testo.
- Tipo: Locales (opzionale)
Restituisce:
- Tipo: Dir ('ltr' | 'rtl' | 'auto')
- Descrizione: La direzione del testo corrispondente alla locale:
- 'ltr' per le lingue da sinistra a destra.
- 'rtl' per le lingue da destra a sinistra.
- 'auto' se la locale non è riconosciuta.
Esempio di Utilizzo:
Determinazione della Direzione del Testo:
typescript
import { getHTMLTextDir } from "intlayer";getHTMLTextDir(Locales.ENGLISH); // Output: "ltr"getHTMLTextDir(Locales.FRENCH); // Output: "ltr"getHTMLTextDir(Locales.ARABIC); // Output: "rtl"Casi di Estremi:
Nessuna Locale Fornita:
- La funzione restituisce 'auto' quando locale è undefined.
Locale non Riconosciuta:
- Per le locale non riconosciute, la funzione predefinisce 'auto'.
Utilizzo nei Componenti:
La funzione getHTMLTextDir può essere utilizzata per impostare dinamicamente l'attributo dir in un documento HTML per un corretto rendering del testo in base alla 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>);Nell'esempio sopra, l'attributo dir è impostato dinamicamente in base alla locale.
Se hai un’idea per migliorare questa documentazione, non esitare a contribuire inviando una pull request su GitHub.
Collegamento GitHub alla documentazione