Utility FunctionsLocales

getLocaleDirection

Referencia de API de la función getLocaleDirection

Descripción general

La función getLocaleDirection determina la dirección del texto (de izquierda a derecha o de derecha a izquierda) para un locale sin requerir una instancia de la GT class. Utiliza la API Intl.Locale para ofrecer una detección precisa de la dirección para cualquier código de configuración regional BCP-47 válido.

Esta función se usa con mayor frecuencia para establecer el atributo dir de un elemento HTML según el locale.

import { getLocaleDirection } from 'generaltranslation';

const direction = getLocaleDirection('ar-SA');
console.log(direction); // "rtl"

const englishDirection = getLocaleDirection('en-US');
console.log(englishDirection); // "ltr"

Referencia

Parámetros

Prop

Type

Descripción de los parámetros

ParámetroDescripción
localeCódigo de configuración regional BCP-47 para comprobar la dirección del texto

Devuelve

'ltr' | 'rtl' - Dirección del texto para el locale:

  • 'ltr': De izquierda a derecha (la mayoría de los idiomas, incluidos el inglés, el español, el francés, el alemán, el chino, el japonés, etc.)
  • 'rtl': De derecha a izquierda (árabe, hebreo, persa, urdu y otros idiomas semíticos/del Medio Oriente)

Comportamiento

Algoritmo de detección de dirección

La función utiliza la propiedad textInfo.direction de la API Intl.Locale:

  1. Crea un objeto Intl.Locale para el locale proporcionado
  2. Accede a la propiedad textInfo.direction para obtener la dirección específica del idioma
  3. Devuelve 'rtl' para idiomas de derecha a izquierda y 'ltr' para los demás
  4. De forma predeterminada, devuelve 'ltr' si el locale no es válido o provoca un Error

Reconocimiento de idiomas RTL

Detecta automáticamente los idiomas RTL, incluidos:

  • Árabe (ar, ar-SA, ar-EG, ar-AE, etc.)
  • Hebreo (he, he-IL)
  • Persa/farsi (fa, fa-IR)
  • Urdu (ur, ur-PK, ur-IN)
  • Pastún (ps)
  • Sindhi (sd)
  • Kurdo soraní (ckb)
  • Y otros sistemas de escritura RTL

Gestión de errores

  • Los códigos de configuración regional inválidos o malformados usan 'ltr' por defecto
  • No se lanzan excepciones ante entradas inválidas
  • Comportamiento de contenido de respaldo predeterminado sólido para casos extremos

Ejemplos

Detección básica de la dirección

import { getLocaleDirection } from 'generaltranslation';

// Lenguas con escritura de izquierda a derecha
console.log(getLocaleDirection('en-US')); // "ltr"
console.log(getLocaleDirection('es-ES')); // "ltr"
console.log(getLocaleDirection('fr-FR')); // "ltr"
console.log(getLocaleDirection('ja-JP')); // "ltr"
console.log(getLocaleDirection('zh-CN')); // "ltr"

// Lenguas con escritura de derecha a izquierda
console.log(getLocaleDirection('ar-SA')); // "rtl"
console.log(getLocaleDirection('he-IL')); // "rtl"
console.log(getLocaleDirection('fa-IR')); // "rtl"
console.log(getLocaleDirection('ur-PK')); // "rtl"

Notas

  • Devuelve 'ltr' para todos los idiomas con escritura de izquierda a derecha (la mayoría de los idiomas en el mundo)
  • Devuelve 'rtl' para los idiomas con escritura de derecha a izquierda (árabe, hebreo, persa, etc.)
  • Utiliza la API moderna Intl.Locale para una detección precisa
  • Funciona con todos los códigos de configuración regional BCP-47

Próximos pasos

¿Qué te ha parecido esta guía?

getLocaleDirection