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 la extensión de Terraform. Por ejemplo:

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

Conceptos y uso

Chrome permite que algunas configuraciones de fuente dependan de ciertos idiomas y familias de fuentes genéricos secuencias de comandos. Por ejemplo, la fuente utilizada para el chino simplificado sans-serif puede ser diferente de la fuente que se usa para la serif japonesa.

Las familias de fuentes genéricas compatibles con Chrome se basan en familias de fuentes genéricas de CSS y son se muestran en GenericReference. Cuando una página web especifica una familia de fuentes genérica, Chrome selecciona la fuente según la configuración correspondiente. Si no se especifica una familia de fuentes genérica, Chrome usa del parámetro de configuración una familia de fuentes genéricas.

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

Las secuencias de comandos del idioma admitido se especifican mediante el código de secuencia de comandos ISO 15924 y se enumeran en ScriptCode Técnicamente, la configuración de Chrome no es estrictamente por secuencia de comandos, sino que también depende de idioma. Por ejemplo, Chrome elige la fuente para el alfabeto cirílico (código de secuencia de comandos ISO 15924 "Cyrl") cuando un elemento especifica el idioma ruso y utiliza esta fuente no solo para el alfabeto cirílico, sino también para todo lo que cubre la fuente, como el latín.

Ejemplos

El siguiente código obtiene la fuente estándar para el árabe.

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

El siguiente fragmento establece la fuente Sans Serif para el japonés.

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

Para probar esta API, instala el ejemplo de la API de fontSettings desde chrome-extension-samples en un repositorio de confianza.

Tipos

FontName

Representa el nombre de una fuente.

Propiedades

  • displayName

    string

    Es el nombre visible de la fuente.

  • fontId

    string

    Es el ID de la fuente.

GenericFamily

Una familia de fuentes genéricas de CSS.

Enum

“estándar”

“sansserif”

“serif”

“corregido”

“cursiva”

“fantasía”

“matemática”

LevelOfControl

Uno de not\_controllable: No se puede controlar con ninguna extensión. controlled\_by\_other\_extensions: Se controla por extensiones con mayor precedencia. controllable\_by\_this\_extension: Se puede controlar con esta extensión. controlled\_by\_this\_extension: controlado por esta extensión

Enum

"not_controllable"

"controlled_by_other_extensions"

"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 "Zyyy".

Enum

“Afak”

“Árabe”

“Armi”

“Armn”

“Avst”

“Balí”

“Bamu”

"Bajo"

“Batk”

“Beng”

“Blis”

“Bopo”

“Bravo”

“Brai”

“Bugi”

“Buhd”

“Cakm”

"Latas"

“Cari”

“Cham”

“Cher”

“Cirt”

“Copt”

“Cprt”

“Cyrl”

“Cyrs”

“Deva”

“Dsrt”

"Dupl"

“Egyd”

“Egyh”

“Egyp”

“Elba”

“Ethi”

“Geor”

“Geok”

“Glag”

“Goth”

“Gran”

“Grek”

“Gujr”

“Gurú”

“Colgar”

“Hani”

“Hano”

"Hans"

“Hant”

"Hebr"

“Hluw”

“Hmng”

“Hung”

“Índices”

“Ital”

“Java”

“Jpan”

“Jurc”

“Kali”

“Khar”

"Khmr"

"Khoj"

“Knda”

“Kpel”

“Kthi”

“Lana”

“Laoo”

"Latf"

“Latg”

“Latn”

“Lepc”

“Miembro”

“Lina”

“Linb”

“Lisu”

“Loma”

“Lyci”

“Lydi”

“Mand”

“Mani”

“Mónica”

“mencionar”

“Merc”

“Mario”

“Mlym”

“Luna”

“Mongo”

“Mroo”

“Mtei”

“Mymr”

“Narb”

“Nbat”

"Nkgb"

“Nkoo”

“Nshu”

“Ogam”

“Olck”

“Orkh”

“Orya”

“Osma”

“Palm”

“Perm”

“Phag”

“Phli”

“Phlp”

“Phlv”

“Phnx”

“Plrd”

“Prti”

“Rjng”

“Roro”

“Ejecutor”

“Samr”

“Sara”

“Sarb”

“Saur”

"Sgnw"

“Shaw”

"Shrd"

“Sind”

“Sinh”

“Sora”

"Sund"

“Sylo”

“Syrc”

“Syre”

“Syrj”

“Syrn”

"Etiqueta"

“Takr”

“Cuento”

“Talu”

“Taml”

“Tang”

“Tavt”

“Telu”

“Teng”

“Tfng”

“Tglg”

“Thaa”

“Tailandés”

"Tibt"

“Tirh”

“Ugar”

"Vaii"

“Visp”

“Wara”

“Wole”

“Xpeo”

“Xsux”

"Yiii"

“Zmth”

“Zsym”

“Zyyy”

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

Muestra

  • Promesa<void>

    Chrome 96 y versiones posteriores

    Las promesas son compatibles con Manifest V3 y versiones posteriores, pero se proporcionan devoluciones de llamada para retrocompatibilidad. No puedes usar ambos en la misma llamada a función. El 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 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

Muestra

  • Promesa<void>

    Chrome 96 y versiones posteriores

    Las promesas son compatibles con Manifest V3 y versiones posteriores, pero se proporcionan devoluciones de llamada para retrocompatibilidad. No puedes usar ambos en la misma llamada a función. El 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 corresponde.

Parámetros

  • detalles

    objeto

    • genericFamily

      GenericFamily

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

    • secuencia de comandos

      ScriptCode opcional

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

  • callback

    función opcional

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

    () => void

Muestra

  • Promesa<void>

    Chrome 96 y versiones posteriores

    Las promesas son compatibles con Manifest V3 y versiones posteriores, pero se proporcionan devoluciones de llamada para retrocompatibilidad. No puedes usar ambos en la misma llamada a función. El 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 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

Muestra

  • Promesa<void>

    Chrome 96 y versiones posteriores

    Las promesas son compatibles con Manifest V3 y versiones posteriores, pero se proporcionan devoluciones de llamada para retrocompatibilidad. No puedes usar ambos en la misma llamada a función. El 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 para 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.

Muestra

  • Promise&lt;object&gt;

    Chrome 96 y versiones posteriores

    Las promesas son compatibles con Manifest V3 y versiones posteriores, pero se proporcionan devoluciones de llamada para retrocompatibilidad. No puedes usar ambos en la misma llamada a función. El 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.

Muestra

  • Promise&lt;object&gt;

    Chrome 96 y versiones posteriores

    Las promesas son compatibles con Manifest V3 y versiones posteriores, pero se proporcionan devoluciones de llamada para retrocompatibilidad. No puedes usar ambos en la misma llamada a función. El 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 de una secuencia de comandos y una familia de fuentes genéricas determinadas.

Parámetros

  • detalles

    objeto

    • genericFamily

      GenericFamily

      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

        string

        Es el ID de la fuente. En lugar del valor de preferencia de ID de fuente literal, puede ser el ID de la fuente a 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 resguardo en la configuración de fuente global de la secuencia de comandos.

      • levelOfControl

        LevelOfControl

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

Muestra

  • Promise&lt;object&gt;

    Chrome 96 y versiones posteriores

    Las promesas son compatibles con Manifest V3 y versiones posteriores, pero se proporcionan devoluciones de llamada para retrocompatibilidad. No puedes usar ambos en la misma llamada a función. El 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

Muestra

  • Promise&lt;FontName[]&gt;

    Chrome 96 y versiones posteriores

    Las promesas son compatibles con Manifest V3 y versiones posteriores, pero se proporcionan devoluciones de llamada para retrocompatibilidad. No puedes usar ambos en la misma llamada a función. El 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.

Muestra

  • Promise&lt;object&gt;

    Chrome 96 y versiones posteriores

    Las promesas son compatibles con Manifest V3 y versiones posteriores, pero se proporcionan devoluciones de llamada para retrocompatibilidad. No puedes usar ambos en la misma llamada a función. El 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 de las fuentes con 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

Muestra

  • Promesa<void>

    Chrome 96 y versiones posteriores

    Las promesas son compatibles con Manifest V3 y versiones posteriores, pero se proporcionan devoluciones de llamada para retrocompatibilidad. No puedes usar ambos en la misma llamada a función. El 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

Muestra

  • Promesa<void>

    Chrome 96 y versiones posteriores

    Las promesas son compatibles con Manifest V3 y versiones posteriores, pero se proporcionan devoluciones de llamada para retrocompatibilidad. No puedes usar ambos en la misma llamada a función. El 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 de una secuencia de comandos y una familia de fuentes genéricas determinadas.

Parámetros

  • detalles

    objeto

    • fontId

      string

      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

      Familia de fuentes genéricas para la que se debe configurar la fuente.

    • secuencia de comandos

      ScriptCode opcional

      El código de la secuencia de comandos que se debe configurar la fuente. Si se omite, se establece 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: 

    () => void

Muestra

  • Promesa<void>

    Chrome 96 y versiones posteriores

    Las promesas son compatibles con Manifest V3 y versiones posteriores, pero se proporcionan devoluciones de llamada para retrocompatibilidad. No puedes usar ambos en la misma llamada a función. El 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

Muestra

  • Promesa<void>

    Chrome 96 y versiones posteriores

    Las promesas son compatibles con Manifest V3 y versiones posteriores, pero se proporcionan devoluciones de llamada para retrocompatibilidad. No puedes usar ambos en la misma llamada a función. El 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 del tamaño de fuente fijo.

Parámetros

  • callback

    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 la fuente.

Parámetros

  • callback

    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 la configuración de una fuente.

Parámetros

  • callback

    función

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

    (details: object) => void

    • detalles

      objeto

      • fontId

        string

        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ó el parámetro de 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 la secuencia de comandos para el que se cambió la configuración de fuente

onMinimumFontSizeChanged

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

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

Parámetros

  • callback

    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.