chrome.i18n

Descripción

Usa la infraestructura de chrome.i18n para implementar la internacionalización en toda tu app o extensión.

Debes colocar todas las cadenas visibles para el usuario en un archivo llamado messages.json. Cada vez una configuración regional nueva, un archivo de mensajes en un directorio llamado _locales/_localeCode_, en el que localeCode es un código como en para inglés.

Esta es la jerarquía de archivos de una extensión internacionalizada que admite español (en) y inglés (es) y coreano (ko):

En el directorio de la extensión: manifest.json, *.html, *.js, _locales directory. En el directorio _locales: los directorios en, es y ko, cada uno con un archivo messages.json.

Cómo admitir varios idiomas

Supongamos que tienes una extensión con los archivos que se muestran en la siguiente imagen:

Un archivo manifest.json y un archivo con JavaScript. El archivo .json tiene

Para internacionalizar esta extensión, asigna un nombre a cada cadena visible para el usuario y colócala en un mensaje . El manifiesto de la extensión, los archivos CSS y el código JavaScript usan el nombre de cada cadena para obtener su versión localizada.

Así se ve la extensión cuando está internacionalizada (ten en cuenta que todavía tiene Cadenas en inglés):

<img "__msg_extname__",="" "default_locale"="" “en”.="" "extname"."="" "hello="" _locales=&quot;&quot; a=&quot;&quot; alt="En el archivo manifest.json, " and=&quot;&quot; estado="" changed=&quot;&quot; chrome.i18n.getmessage("extname").="" defines=&quot;&quot; en=&quot;&quot; file=&quot;&quot; file,=&quot;&quot; has=&quot;&quot; hello=&quot;&quot; in=&quot;&quot; item=&quot;&quot; javascript=&quot;&quot; messages.json=&quot;&quot; named=&quot;&quot; nuevo="" src=&quot;/static/images/i18n-after-1.gif&quot; the=&quot;&quot; to=&quot;&quot; valor="" mundo"="" />

Notas sobre la internacionalización:

  • Puedes usar cualquiera de las configuraciones regionales compatibles. Si usas una configuración regional incompatible, Google Chrome lo ignora.
  • En los archivos manifest.json y CSS, haz referencia a una cadena llamada messagename, como la siguiente:

    __MSG_messagename__
    
  • En el código JavaScript de la extensión o app, haz referencia a una cadena llamada messagename, como la siguiente:

    chrome.i18n.getMessage("messagename")
    
  • En cada llamada a getMessage(), puedes proporcionar hasta 9 strings para incluir en el mensaje. Consulta Ejemplos: getMessage para obtener detalles.

  • Algunos mensajes, como @@bidi_dir y @@ui_locale, son proporcionados por la internacionalización en un sistema de archivos. Consulta la sección Mensajes predefinidos para ver una lista completa de los nombres de los mensajes predefinidos.

  • En messages.json, cada cadena visible para el usuario tiene un nombre, un "mensaje". elemento y un elemento &quot;description&quot; elemento. El nombre es una clave, como “extName” o "cadena_búsqueda" que identifica el una cadena vacía. El “mensaje” especifica el valor de la cadena en esta configuración regional. La columna "description" opcional les brinda ayuda a los traductores, que quizás no puedan ver cómo se usa la cadena en sus . Por ejemplo:

    {
      "search_string": {
        "message": "hello%20world",
        "description": "The string we search for. Put %20 between words that go together."
      },
      ...
    }
    

    Para obtener más información, consulta Formatos: mensajes específicos de configuración regional.

Una vez que una extensión o app se internacionaliza, es fácil traducirla. Copias messages.json, traducirla y colocar la copia en un directorio nuevo, en _locales. Por ejemplo, para respaldar Español, solo tienes que incluir una copia traducida de messages.json en _locales/es. La siguiente imagen muestra la extensión anterior con una nueva traducción al español.

Se ve igual que la imagen anterior, pero con un archivo nuevo en _locales/es/messages.json que contiene una traducción de los mensajes al español.

Mensajes predefinidos

El sistema de internacionalización proporciona algunos mensajes predefinidos para ayudarte a localizar. Estos incluir @@ui_locale para que puedas detectar la configuración regional actual de la IU, y algunos mensajes @@bidi_... que te permiten detectar la dirección del texto. Los últimos mensajes tienen nombres similares a los de las constantes en la API de BIDI (bi-direccional) de gadgets.

El mensaje especial @@extension_id se puede usar en los archivos CSS y JavaScript, ya sea que el o extensión. Este mensaje no funciona en archivos de manifiesto.

En la siguiente tabla, se describe cada mensaje predefinido.

Nombre del mensajeDescripción
@@extension_idla extensión o el ID de la aplicación podrías usar esta cadena a fin de construir URLs para recursos dentro de la extensión. Incluso las extensiones no localizadas pueden usar este mensaje.
Nota: No puedes usar este mensaje en un archivo de manifiesto.
@@ui_localeLa configuración regional actual puedes usar esta cadena para crear URL específicas de la configuración regional.
@@bidi_dirDirección del texto de la configuración regional actual, ya sea "ltr" para idiomas que se leen de izquierda a derecha, como inglés o "rtl" para idiomas que se escriben de derecha a izquierda, como el japonés.
@@bidi_reversed_dirSi @@bidi_dir es "ltr", entonces es "rtl". de lo contrario, es "ltr".
@@bidi_start_edgeSi @@bidi_dir es "ltr", entonces es "left"; de lo contrario, es "correcta".
@@bidi_end_edgeSi @@bidi_dir es "ltr", entonces es "right"; de lo contrario, es "left".

El siguiente es un ejemplo de cómo usar @@extension_id en un archivo CSS para construir una URL:

body {
  background-image:url('chrome-extension://__MSG_@@extension_id__/background.png');
}

Si el ID de extensión es abcdefghijklmnopqrstuvwxyzabcdef, la línea en negrita del código anterior snippet se convierte en lo siguiente:

  background-image:url('chrome-extension://abcdefghijklmnopqrstuvwxyzabcdef/background.png');

Este es un ejemplo del uso de mensajes @@bidi_* en un archivo CSS:

body {
  direction: __MSG_@@bidi_dir__;
}

div#header {
  margin-bottom: 1.05em;
  overflow: hidden;
  padding-bottom: 1.5em;
  padding-__MSG_@@bidi_start_edge__: 0;
  padding-__MSG_@@bidi_end_edge__: 1.5em;
  position: relative;
}

Para los idiomas que se leen de izquierda a derecha, como el inglés, las líneas en negrita se convierten en:

  dir: ltr;
  padding-left: 0;
  padding-right: 1.5em;

Configuraciones regionales

Puedes elegir entre varias configuraciones regionales, incluidas algunas (como en) que permiten una sola traducción admiten múltiples variaciones de un idioma (como en_GB y en_US).

Configuraciones regionales compatibles

Puedes usar cualquiera de las configuraciones regionales compatibles con Chrome Web Store.

Búsqueda de mensajes

No es necesario que definas cada cadena para cada configuración regional admitida. Siempre y cuando la configuración regional predeterminada messages.json tiene un valor para cada cadena; tu extensión o app se ejecutará sin importar cómo es una traducción escasa. A continuación, se muestra cómo el sistema de extensiones busca un mensaje:

  1. Busca en el archivo de mensajes (si corresponde) la configuración regional preferida del usuario. Por ejemplo, cuando Google La configuración regional de Chrome está establecida en inglés británico (en_GB). El sistema primero busca el mensaje en _locales/en_GB/messages.json Si ese archivo existe y el mensaje está allí, el sistema buscará no más.
  2. Si la configuración regional preferida del usuario tiene una región (es decir, tiene un guion bajo: _), busca la configuración regional sin esa región. Por ejemplo, si el archivo de mensajes en_GB no existe o no contiene el mensaje, el sistema busca en el archivo de mensajes en. Si ese archivo existe y aparece el mensaje, el sistema ya no busca.
  3. Busca la configuración regional predeterminada en el archivo de mensajes. Por ejemplo, si la extensión "configuración_configuración_predeterminada" está configurado en "es", y ni _locales/en_GB/messages.json ni _locales/en/messages.json contiene el mensaje, la extensión utiliza el mensaje de _locales/es/messages.json

En la siguiente imagen, el mensaje llamado “colores” es en las tres configuraciones regionales en las que la extensión admite, pero "extName" está en solo dos de las configuraciones regionales. Dondequiera que un usuario que ejecute Google Chrome en EE.UU. El inglés ve la etiqueta "Colors", un usuario de inglés británico ve "Colours". Tanto inglés de EE.UU. como Los usuarios de inglés británico ven el nombre de extensión "Hello World". Como el idioma predeterminado es español, Los usuarios que ejecuten Google Chrome en cualquier idioma que no sea inglés verán la etiqueta "Colores". y la extensión que se llama "Hola mundo".

Cuatro archivos: manifest.json y tres messages.json (para es, en y en_GB)  Los archivos es y en muestran entradas para mensajes con

Cómo establecer la configuración regional de tu navegador

Para probar las traducciones, te recomendamos que establezcas la configuración regional de tu navegador. En esta sección, se explica cómo configurar la configuración regional en Windows, Mac OS X, Linux y ChromeOS

Windows

Puedes cambiarla con una combinación de teclas específica de la configuración regional o en la IU de Google Chrome. El es más rápido, una vez que lo configuras, y te permite usar varios idiomas a la vez.

Cómo usar un acceso directo específico de la configuración regional

Para crear y usar un acceso directo que inicie Google Chrome con una configuración regional en particular:

  1. Crea una copia del acceso directo de Google Chrome que ya está en el escritorio.
  2. Cambia el nombre del atajo nuevo para que coincida con la configuración regional nueva.
  3. Cambia las propiedades del acceso directo para que el campo Target especifique el --lang y --user-data-dir. El destino debería ser similar al siguiente:

    path_to_chrome.exe --lang=locale --user-data-dir=c:\locale_profile_dir
    
  4. Haz doble clic en el acceso directo para iniciar Google Chrome.

Por ejemplo, para crear un acceso directo que inicie Google Chrome en español (es), puedes crear un con el nombre chrome-es, que tiene el siguiente destino:

path_to_chrome.exe --lang=es --user-data-dir=c:\chrome-profile-es

Puedes crear todas las combinaciones de teclas que desees, lo que facilita la prueba en varios idiomas. Por ejemplo:

path_to_chrome.exe --lang=en --user-data-dir=c:\chrome-profile-en
path_to_chrome.exe --lang=en_GB --user-data-dir=c:\chrome-profile-en_GB
path_to_chrome.exe --lang=ko --user-data-dir=c:\chrome-profile-ko
Usa la IU

A continuación, se explica cómo cambiar la configuración regional usando la IU de Google Chrome para Windows:

  1. Ícono de la app > Opciones
  2. Elige la pestaña Avanzadas.
  3. Desplázate hacia abajo hasta Contenido web.
  4. Haz clic en Cambiar la configuración de fuente e idioma.
  5. Selecciona la pestaña Idiomas.
  6. Usa el menú desplegable para establecer el idioma de Google Chrome.
  7. Reinicia Chrome

Mac OS X

Para cambiar la configuración regional en Mac, debes usar las preferencias del sistema.

  1. En el menú de Apple, elige Preferencias del sistema
  2. En la sección Personal, elige Internacional.
  3. Elige tu idioma y ubicación
  4. Reinicia Chrome

Linux

Para cambiar la configuración regional en Linux, primero sal de Google Chrome. Luego, todo en una línea, configura el LANGUAGE. variable de entorno e iniciar Google Chrome. Por ejemplo:

LANGUAGE=es ./chrome

ChromeOS

Para cambiar la configuración regional en ChromeOS, haz lo siguiente:

  1. En la bandeja del sistema, selecciona Configuración.
  2. En la sección Idiomas y entrada, elige el menú desplegable Idioma.
  3. Si tu idioma no aparece en la lista, haz clic en Agregar idiomas y agrégalo.
  4. Cuando lo hayas agregado, haz clic en el elemento de menú de 3 puntos Más acciones que se encuentra junto a tu idioma y elige Muestra ChromeOS en este idioma.
  5. Haz clic en el botón Reiniciar que aparece junto al idioma configurado para reiniciar ChromeOS.

Ejemplos

Puedes encontrar ejemplos sencillos de internacionalización en el directorio examples/api/i18n. Para un Consulta este ejemplo completo en examples/extensions/news. Si deseas consultar otros ejemplos y obtener ayuda para ver la el código fuente, consulta Muestras.

Ejemplos: getMessage

El siguiente código obtiene un mensaje localizado del navegador y lo muestra como una cadena. Integra reemplaza dos marcadores de posición dentro del mensaje con las cadenas "string1" y "string2".

function getMessage() {
  var message = chrome.i18n.getMessage("click_here", ["string1", "string2"]);
  document.getElementById("languageSpan").innerHTML = message;
}

A continuación, se muestra cómo proporcionarías y usarías una sola cadena:

  // In JavaScript code
  status.innerText = chrome.i18n.getMessage("error", errorDetails);
"error": {
  "message": "Error: $details$",
  "description": "Generic error template. Expects error parameter to be passed in.",
  "placeholders": {
    "details": {
      "content": "$1",
      "example": "Failed to fetch RSS feed."
    }
  }
}

Para obtener más información sobre los marcadores de posición, consulta la página Mensajes específicos de la configuración regional. Para obtener detalles si llamas a getMessage(), consulta la referencia de la API

Ejemplo: getAcceptLanguages

El siguiente código obtiene Accept-languages del navegador y los muestra como una string y separa cada uno de los lenguajes de aceptación con “,”.

function getAcceptLanguages() {
  chrome.i18n.getAcceptLanguages(function(languageList) {
    var languages = languageList.join(",");
    document.getElementById("languageSpan").innerHTML = languages;
  })
}

Para obtener detalles sobre cómo llamar a getAcceptLanguages(), consulta la referencia de la API.

Ejemplo: detectLanguage

El siguiente código detecta hasta 3 idiomas a partir de la cadena determinada y muestra el resultado como cadenas separadas por líneas nuevas.

function detectLanguage(inputText) {
  chrome.i18n.detectLanguage(inputText, function(result) {
    var outputLang = "Detected Language: ";
    var outputPercent = "Language Percentage: ";
    for(i = 0; i < result.languages.length; i++) {
      outputLang += result.languages[i].language + " ";
      outputPercent +=result.languages[i].percentage + " ";
    }
    document.getElementById("languageSpan").innerHTML = outputLang + "\n" + outputPercent + "\nReliable: " + result.isReliable;
  });
}

Para obtener más detalles sobre cómo llamar a detectLanguage(inputText), consulta la referencia de la API.

Tipos

LanguageCode

Chrome 47 y versiones posteriores

Un código de idioma ISO, como en o fr Para obtener una lista completa de los idiomas compatibles con este método, consulta kLanguageInfoTable. Para un idioma desconocido, se mostrará und, lo que significa que el CLD no reconoce el [percentage] del texto.

Tipo

string

Métodos

detectLanguage()

Promesa Chrome 47 y versiones posteriores .
chrome.i18n.detectLanguage(
  text: string,
  callback?: function,
)

Detecta el idioma del texto proporcionado mediante CLD.

Parámetros

  • texto

    string

    Cadena de entrada del usuario para traducir.

  • callback

    función opcional

    El parámetro callback se ve de la siguiente manera:

    (result: object) => void

    • resultado

      objeto

      Un objeto LanguageDetectionResult que conserva la confiabilidad del idioma detectado y el array de DetectedLanguage.

      • isReliable

        boolean

        El CLD detectó la confiabilidad del idioma

      • idiomas

        object[]

        conjunto de detectedLanguage

        • idioma

          string

        • porcentaje

          número

          El porcentaje del idioma detectado

Muestra

  • Promise&lt;object&gt;

    Chrome 99 y versiones posteriores

    Las promesas solo son compatibles con Manifest V3 y versiones posteriores; otras plataformas deben usar devoluciones de llamada.

getAcceptLanguages()

Promesa
chrome.i18n.getAcceptLanguages(
  callback?: function,
)

Obtiene los idiomas de aceptación del navegador. Es diferente de la configuración regional que usa el navegador. Para obtener la configuración regional, usa i18n.getUILanguage.

Parámetros

  • callback

    función opcional

    El parámetro callback se ve de la siguiente manera:

    (languages: string[]) => void

    • idiomas

      string[]

      Arreglo de LanguageCode

Muestra

  • Promise&lt;LanguageCode[]&gt;

    Chrome 99 y versiones posteriores

    Las promesas solo son compatibles con Manifest V3 y versiones posteriores; otras plataformas deben usar devoluciones de llamada.

getMessage()

chrome.i18n.getMessage(
  messageName: string,
  substitutions?: any,
  options?: object,
)

Obtiene la cadena localizada para el mensaje especificado. Si falta el mensaje, este método muestra una cadena vacía (''). Si el formato de la llamada a getMessage() es incorrecto (por ejemplo, messageName no es una string o si el array tempranos tiene más de 9 elementos), este método muestra undefined.

Parámetros

  • messageName

    string

    Es el nombre del mensaje, como se especifica en el archivo messages.json.

  • substitutions

    Cualquier opcional

    Hasta 9 cadenas de sustitución, si el mensaje requiere alguna

  • opciones

    objeto opcional

    Chrome 79 y versiones posteriores
    • escapeLt

      booleano opcional

      Escape de < en la traducción a &lt;. Esto se aplica solo al mensaje en sí y no a los marcadores de posición. Se recomienda que los desarrolladores usen esta opción si la traducción se emplea en un contexto HTML. Las plantillas de cierre que se usan con Closure Compiler lo generan automáticamente.

Muestra

  • string

    Mensaje localizado para la configuración regional actual.

getUILanguage()

chrome.i18n.getUILanguage()

Obtiene el idioma de la IU del navegador del navegador. Es diferente de i18n.getAcceptLanguages, que muestra los idiomas preferidos del usuario.

Muestra

  • string

    El código de idioma de la IU del navegador, como en-US o fr-FR