chrome.fontSettings

Descripción

Usa la API de chrome.fontSettings para administrar la configuración de fuentes de Chrome.

Permisos

fontSettings

Para usar la API de Font Settings, debes declarar el permiso "fontSettings" en el manifiesto de extensión. Por ejemplo:

{
  "name": "My Font Settings Extension",
  "description": "Customize your fonts",
  "version": "0.2",
  "permissions": [
    "fontSettings"
  ],
  ...
}

Conceptos y uso

Chrome permite que algunos parámetros de configuración de fuentes dependan de ciertas familias de fuentes genéricas y secuencias de comandos de idiomas. Por ejemplo, la fuente que se usa para el chino simplificado sans-serif puede ser diferente de la que se usa para el japonés serif.

Las familias de fuentes genéricas compatibles con Chrome se basan en familias de fuentes genéricas de CSS y se enumeran en GenericReference. Si una página web especifica una familia de fuentes genérica, Chrome la selecciona en función de la configuración correspondiente. Si no se especifica una familia de fuentes genéricas, Chrome utilizará la configuración de la familia de fuentes "estándar".

Cuando en una página web se especifica un idioma, Chrome selecciona la fuente según la configuración de la secuencia de comandos del idioma correspondiente. Si no se especifica ningún idioma, Chrome usará la configuración de la secuencia de comandos predeterminada o global.

El código de secuencia de comandos ISO 15924 especifica las secuencias de comandos de lenguajes compatibles y se enumeran en ScriptCode. Técnicamente, la configuración de Chrome no es estrictamente por secuencia de comandos, sino que también depende del idioma. Por ejemplo, Chrome elige la fuente del cirílico (código de secuencia de comandos ISO 15924 "Cyrl") cuando una página web especifica el idioma ruso y usa esta fuente no solo para el alfabeto cirílico, sino para todo lo que cubre la fuente, como el latín.

Ejemplos

En el siguiente código, se obtiene la fuente estándar para el árabe.

chrome.fontSettings.getFont(
  { genericFamily: 'standard', script: 'Arab' },
  function(details) { console.log(details.fontId); }
);

En el siguiente fragmento, se configura la fuente sans-serif para japonés.

chrome.fontSettings.setFont(
  { genericFamily: 'sansserif', script: 'Jpan', fontId: 'MS PGothic' }
);

Para probar esta API, instala el ejemplo de la API de fontSettings del repositorio chrome-extension-samples.

Tipos

FontName

Representa un nombre de fuente.

Propiedades

  • displayName

    cadena

    Es el nombre visible de la fuente.

  • fontId

    cadena

    Es el ID de la fuente.

GenericFamily

Una familia de fuentes genérica de CSS.

Enum

LevelOfControl

Uno de not\_controllable: no se puede controlar con ninguna extensión controlled\_by\_other\_extensions: se controla mediante extensiones con mayor precedencia controllable\_by\_this\_extension: se puede controlar con esta extensión controlled\_by\_this\_extension: se puede controlar con esta extensión

Enum

"not_controllable":

"controllable_by_this_extension"

"controlled_by_this_extension"

ScriptCode

Un código de secuencia de comandos ISO 15924. La secuencia de comandos predeterminada, o global, se representa con el código de secuencia de comandos "Zyyy".

Enum

"Buhd"

"Copt"

"Cprt"

"Glag"

"Goth"

"Hmng"

"Khmr"

"Latf"

"Latg"

"Latn"

"Lyci"

"Olck"

"Orkh"

"Phag"

"Plrd"

"Sgnw"

"Sind"

"Sinh"

"Tagb"

"Tfng"

Métodos

clearDefaultFixedFontSize()

Promesa 
chrome.fontSettings.clearDefaultFixedFontSize(
  details?: object,
  callback?: function,
)

Borra el tamaño de fuente fijo predeterminado que establece esta extensión, si corresponde.

Parámetros

  • detalles

    objeto opcional

    Este parámetro no se usa actualmente.

  • callback

    Función opcional

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

    ()=>void

Devuelve

  • Promise<void>

    Chrome 96 y versiones posteriores

    Las promesas son compatibles con Manifest V3 y versiones posteriores, pero se proporcionan devoluciones de llamada para brindar retrocompatibilidad. No puedes usar ambos en la misma llamada a función. La promesa se resuelve con el mismo tipo que se pasa a la devolución de llamada.

clearDefaultFontSize()

Promesa 
chrome.fontSettings.clearDefaultFontSize(
  details?: object,
  callback?: function,
)

Borra el tamaño de fuente predeterminado establecido por esta extensión, si existe.

Parámetros

  • detalles

    objeto opcional

    Este parámetro no se usa actualmente.

  • callback

    Función opcional

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

    ()=>void

Devuelve

  • Promise<void>

    Chrome 96 y versiones posteriores

    Las promesas son compatibles con Manifest V3 y versiones posteriores, pero se proporcionan devoluciones de llamada para brindar retrocompatibilidad. No puedes usar ambos en la misma llamada a función. La promesa se resuelve con el mismo tipo que se pasa a la devolución de llamada.

clearFont()

Promesa 
chrome.fontSettings.clearFont(
  details: object,
  callback?: function,
)

Borra la fuente establecida por esta extensión, si la hay.

Parámetros

  • detalles

    objeto

    • genericFamily

      GenericFamily

      Es la familia de fuentes genéricas para la que se debe borrar la fuente.

    • secuencia de comandos

      ScriptCode opcional

      Es la secuencia de comandos para la que se debe borrar la fuente. Si se omite, se borrará la configuración de fuente de la secuencia de comandos global.

  • callback

    Función opcional

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

    ()=>void

Devuelve

  • Promise<void>

    Chrome 96 y versiones posteriores

    Las promesas son compatibles con Manifest V3 y versiones posteriores, pero se proporcionan devoluciones de llamada para brindar retrocompatibilidad. No puedes usar ambos en la misma llamada a función. La promesa se resuelve con el mismo tipo que se pasa a la devolución de llamada.

clearMinimumFontSize()

Promesa 
chrome.fontSettings.clearMinimumFontSize(
  details?: object,
  callback?: function,
)

Borra el tamaño de fuente mínimo establecido por esta extensión, si corresponde.

Parámetros

  • detalles

    objeto opcional

    Este parámetro no se usa actualmente.

  • callback

    Función opcional

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

    ()=>void

Devuelve

  • Promise<void>

    Chrome 96 y versiones posteriores

    Las promesas son compatibles con Manifest V3 y versiones posteriores, pero se proporcionan devoluciones de llamada para brindar retrocompatibilidad. No puedes usar ambos en la misma llamada a función. La promesa se resuelve con el mismo tipo que se pasa a la devolución de llamada.

getDefaultFixedFontSize()

Promesa 
chrome.fontSettings.getDefaultFixedFontSize(
  details?: object,
  callback?: function,
)

Obtiene el tamaño predeterminado de las fuentes de ancho fijo.

Parámetros

  • detalles

    objeto opcional

    Este parámetro no se usa actualmente.

  • callback

    Función opcional

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

    (details: object)=>void

    • detalles

      objeto

      • levelOfControl

        LevelOfControl

        El nivel de control que tiene esta extensión sobre la configuración.

      • pixelSize

        número

        Es el tamaño de la fuente en píxeles.

Devuelve

  • Promise<object>

    Chrome 96 y versiones posteriores

    Las promesas son compatibles con Manifest V3 y versiones posteriores, pero se proporcionan devoluciones de llamada para brindar retrocompatibilidad. No puedes usar ambos en la misma llamada a función. La promesa se resuelve con el mismo tipo que se pasa a la devolución de llamada.

getDefaultFontSize()

Promesa 
chrome.fontSettings.getDefaultFontSize(
  details?: object,
  callback?: function,
)

Obtiene el tamaño de fuente predeterminado.

Parámetros

  • detalles

    objeto opcional

    Este parámetro no se usa actualmente.

  • callback

    Función opcional

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

    (details: object)=>void

    • detalles

      objeto

      • levelOfControl

        LevelOfControl

        El nivel de control que tiene esta extensión sobre la configuración.

      • pixelSize

        número

        Es el tamaño de la fuente en píxeles.

Devuelve

  • Promise<object>

    Chrome 96 y versiones posteriores

    Las promesas son compatibles con Manifest V3 y versiones posteriores, pero se proporcionan devoluciones de llamada para brindar retrocompatibilidad. No puedes usar ambos en la misma llamada a función. La promesa se resuelve con el mismo tipo que se pasa a la devolución de llamada.

getFont()

Promesa 
chrome.fontSettings.getFont(
  details: object,
  callback?: function,
)

Obtiene la fuente para una secuencia de comandos determinada y la familia de fuentes genéricas.

Parámetros

  • detalles

    objeto

    • genericFamily

      GenericFamily

      La familia de fuentes genéricas para la que se debe recuperar la fuente.

    • secuencia de comandos

      ScriptCode opcional

      La secuencia de comandos para la que se debe recuperar la fuente. Si se omite, se recupera la configuración de fuente para la secuencia de comandos global (código de secuencia de comandos "Zyyy").

  • callback

    Función opcional

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

    (details: object)=>void

    • detalles

      objeto

      • fontId

        cadena

        Es el ID de la fuente. En lugar del valor de preferencia de ID de fuente literal, este puede ser el ID de la fuente en la que el sistema resuelve el valor de preferencia. Por lo tanto, fontId puede diferir de la fuente que se pasa a setFont si, por ejemplo, la fuente no está disponible en el sistema. La cadena vacía significa recurrir a la configuración de fuente de la secuencia de comandos global.

      • levelOfControl

        LevelOfControl

        El nivel de control que tiene esta extensión sobre la configuración.

Devuelve

  • Promise<object>

    Chrome 96 y versiones posteriores

    Las promesas son compatibles con Manifest V3 y versiones posteriores, pero se proporcionan devoluciones de llamada para brindar retrocompatibilidad. No puedes usar ambos en la misma llamada a función. La promesa se resuelve con el mismo tipo que se pasa a la devolución de llamada.

getFontList()

Promesa 
chrome.fontSettings.getFontList(
  callback?: function,
)

Obtiene una lista de fuentes en el sistema.

Parámetros

  • callback

    Función opcional

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

    (results: FontName[])=>void

Devuelve

  • Promise<FontName[]>

    Chrome 96 y versiones posteriores

    Las promesas son compatibles con Manifest V3 y versiones posteriores, pero se proporcionan devoluciones de llamada para brindar retrocompatibilidad. No puedes usar ambos en la misma llamada a función. La promesa se resuelve con el mismo tipo que se pasa a la devolución de llamada.

getMinimumFontSize()

Promesa 
chrome.fontSettings.getMinimumFontSize(
  details?: object,
  callback?: function,
)

Obtiene el tamaño de fuente mínimo.

Parámetros

  • detalles

    objeto opcional

    Este parámetro no se usa actualmente.

  • callback

    Función opcional

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

    (details: object)=>void

    • detalles

      objeto

      • levelOfControl

        LevelOfControl

        El nivel de control que tiene esta extensión sobre la configuración.

      • pixelSize

        número

        Es el tamaño de la fuente en píxeles.

Devuelve

  • Promise<object>

    Chrome 96 y versiones posteriores

    Las promesas son compatibles con Manifest V3 y versiones posteriores, pero se proporcionan devoluciones de llamada para brindar retrocompatibilidad. No puedes usar ambos en la misma llamada a función. La promesa se resuelve con el mismo tipo que se pasa a la devolución de llamada.

setDefaultFixedFontSize()

Promesa 
chrome.fontSettings.setDefaultFixedFontSize(
  details: object,
  callback?: function,
)

Establece el tamaño predeterminado para las fuentes de ancho fijo.

Parámetros

  • detalles

    objeto

    • pixelSize

      número

      Es el tamaño de la fuente en píxeles.

  • callback

    Función opcional

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

    ()=>void

Devuelve

  • Promise<void>

    Chrome 96 y versiones posteriores

    Las promesas son compatibles con Manifest V3 y versiones posteriores, pero se proporcionan devoluciones de llamada para brindar retrocompatibilidad. No puedes usar ambos en la misma llamada a función. La promesa se resuelve con el mismo tipo que se pasa a la devolución de llamada.

setDefaultFontSize()

Promesa 
chrome.fontSettings.setDefaultFontSize(
  details: object,
  callback?: function,
)

Establece el tamaño de fuente predeterminado.

Parámetros

  • detalles

    objeto

    • pixelSize

      número

      Es el tamaño de la fuente en píxeles.

  • callback

    Función opcional

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

    ()=>void

Devuelve

  • Promise<void>

    Chrome 96 y versiones posteriores

    Las promesas son compatibles con Manifest V3 y versiones posteriores, pero se proporcionan devoluciones de llamada para brindar retrocompatibilidad. No puedes usar ambos en la misma llamada a función. La promesa se resuelve con el mismo tipo que se pasa a la devolución de llamada.

setFont()

Promesa 
chrome.fontSettings.setFont(
  details: object,
  callback?: function,
)

Establece la fuente para una secuencia de comandos determinada y la familia de fuentes genérica.

Parámetros

  • detalles

    objeto

    • fontId

      cadena

      Es el ID de la fuente. La cadena vacía significa recurrir a la configuración de fuente de la secuencia de comandos global.

    • genericFamily

      GenericFamily

      Corresponde a la familia de fuentes genéricas para la que se debe establecer la fuente.

    • secuencia de comandos

      ScriptCode opcional

      Es el código de secuencia de comandos que se debe establecer en la fuente. Si se omite, se establece la configuración de fuente para la secuencia de comandos global (código de la secuencia de comandos "Zyyy").

  • callback

    Función opcional

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

    ()=>void

Devuelve

  • Promise<void>

    Chrome 96 y versiones posteriores

    Las promesas son compatibles con Manifest V3 y versiones posteriores, pero se proporcionan devoluciones de llamada para brindar retrocompatibilidad. No puedes usar ambos en la misma llamada a función. La promesa se resuelve con el mismo tipo que se pasa a la devolución de llamada.

setMinimumFontSize()

Promesa 
chrome.fontSettings.setMinimumFontSize(
  details: object,
  callback?: function,
)

Establece el tamaño de fuente mínimo.

Parámetros

  • detalles

    objeto

    • pixelSize

      número

      Es el tamaño de la fuente en píxeles.

  • callback

    Función opcional

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

    ()=>void

Devuelve

  • Promise<void>

    Chrome 96 y versiones posteriores

    Las promesas son compatibles con Manifest V3 y versiones posteriores, pero se proporcionan devoluciones de llamada para brindar retrocompatibilidad. No puedes usar ambos en la misma llamada a función. La promesa se resuelve con el mismo tipo que se pasa a la devolución de llamada.

Eventos

onDefaultFixedFontSizeChanged

chrome.fontSettings.onDefaultFixedFontSizeChanged.addListener(
  callback: function,
)

Se activa cuando cambia la configuración predeterminada de tamaño de fuente fijo.

Parámetros

  • callback

    la función

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

    (details: object)=>void

    • detalles

      objeto

      • levelOfControl

        LevelOfControl

        El nivel de control que tiene esta extensión sobre la configuración.

      • pixelSize

        número

        Es el tamaño de la fuente en píxeles.

onDefaultFontSizeChanged

chrome.fontSettings.onDefaultFontSizeChanged.addListener(
  callback: function,
)

Se activa cuando cambia la configuración predeterminada del tamaño de fuente.

Parámetros

  • callback

    la función

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

    (details: object)=>void

    • detalles

      objeto

      • levelOfControl

        LevelOfControl

        El nivel de control que tiene esta extensión sobre la configuración.

      • pixelSize

        número

        Es el tamaño de la fuente en píxeles.

onFontChanged

chrome.fontSettings.onFontChanged.addListener(
  callback: function,
)

Se activa cuando cambia un parámetro de configuración de fuente.

Parámetros

  • callback

    la función

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

    (details: object)=>void

    • detalles

      objeto

      • fontId

        cadena

        Es el ID de la fuente. Consulta la descripción en getFont.

      • genericFamily

        GenericFamily

        La familia de fuentes genéricas para la que se modificó la configuración de fuentes.

      • levelOfControl

        LevelOfControl

        El nivel de control que tiene esta extensión sobre la configuración.

      • secuencia de comandos

        ScriptCode opcional

        El código de secuencia de comandos para el que se modificó la configuración de fuente

onMinimumFontSizeChanged

chrome.fontSettings.onMinimumFontSizeChanged.addListener(
  callback: function,
)

Se activa cuando cambia la configuración de tamaño de fuente mínimo.

Parámetros

  • callback

    la función

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

    (details: object)=>void

    • detalles

      objeto

      • levelOfControl

        LevelOfControl

        El nivel de control que tiene esta extensión sobre la configuración.

      • pixelSize

        número

        Es el tamaño de la fuente en píxeles.