browser.fontSettings

Description

Utilisez l'API chrome.fontSettings pour gérer les paramètres de police de Chrome.

Autorisations

fontSettings

Pour utiliser l'API Font Settings, vous devez déclarer l'autorisation "fontSettings" dans le fichier manifeste de l'extension. Exemple :

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

Concepts et utilisation

Chrome permet de faire dépendre certains paramètres de police de certaines familles de polices génériques et de certains scripts de langue. Par exemple, la police utilisée pour le chinois simplifié sans empattement peut être différente de celle utilisée pour le japonais avec empattement.

Les familles de polices génériques compatibles avec Chrome sont basées sur les familles de polices génériques CSS et sont listées sous GenericReference. Lorsqu'une page Web spécifie une famille de polices générique, Chrome sélectionne la police en fonction du paramètre correspondant. Si aucune famille de polices générique n'est spécifiée, Chrome utilise le paramètre de la famille de polices générique "standard".

Lorsqu'une page Web spécifie une langue, Chrome sélectionne la police en fonction du paramètre de l'écriture de la langue correspondante. Si aucune langue n'est spécifiée, Chrome utilise le paramètre du script par défaut ou global.

Les scripts de langue acceptés sont spécifiés par le code de script ISO 15924 et listés sous ScriptCode. Techniquement, les paramètres Chrome ne sont pas strictement définis par script, mais dépendent également de la langue. Par exemple, Chrome choisit la police pour le cyrillique (code de script ISO 15924 "Cyrl") lorsqu'une page Web spécifie la langue russe, et utilise cette police non seulement pour le script cyrillique, mais aussi pour tout ce que la police couvre, comme le latin.

Exemples

Le code suivant permet d'obtenir la police standard pour l'arabe.

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

L'extrait de code suivant définit la police sans-serif pour le japonais.

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

Pour essayer cette API, installez l'exemple d'API fontSettings à partir du dépôt chrome-extension-samples.

Types

FontName

Représente un nom de police.

Propriétés

• displayName

  chaîne

  Nom à afficher de la police.

• fontId

  chaîne

  ID de la police.

GenericFamily

Une famille de polices CSS générique.

Énumération

"standard"

"sansserif"

"serif"

"fixed"

"cursive"

"fantasy"

"math"

LevelOfControl

Une des valeurs suivantes : not\_controllable : ne peut être contrôlé par aucune extension controlled\_by\_other\_extensions : contrôlé par des extensions de priorité supérieure controllable\_by\_this\_extension : peut être contrôlé par cette extension controlled\_by\_this\_extension : contrôlé par cette extension

Énumération

"not_controllable"

"controlled_by_other_extensions"

"controllable_by_this_extension"

"controlled_by_this_extension"

ScriptCode

Code de script ISO 15924. Le script par défaut, ou global, est représenté par le code de script "Zyyy".

Énumération

"Afak"

"Arab"

"Aran"

"Armi"

"Armn"

"Avst"

"Bali"

"Bamu"

"Basses"

"Batk"

"Beng"

"Blis"

"Bopo"

"Brah"

"Brai"

"Bugi"

"Buhd"

"Cakm"

"Cans"

"Cari"

"Cham"

"Cher"

"Cirt"

"Copt"

"Cprt"

"Cyrl"

"Cyrs"

"Deva"

"Dsrt"

"Dupl"

"Egyd"

"Egyh"

"Egyp"

"Elba"

"Ethi"

"Geor"

"Geok"

"Glag"

"Goth"

"Gran"

"Grek"

"Gujr"

"Guru"

"Hang"

"Hani"

"Hano"

"Hans"

"Hant"

"Hebr"

"Hluw"

"Hmng"

"Hung"

"Inds"

"Ital"

"Java"

"Jpan"

"Jurc"

"Kali"

"Khar"

"Khmr"

"Khoj"

"Knda"

"Kpel"

"Kthi"

"Lana"

"Laoo"

"Latf"

"Latg"

"Latn"

"Lepc"

"Limb"

"Lina"

"Linb"

"Lisu"

"Loma"

"Lyci"

"Lydi"

"Mand"

"Mani"

"Maya"

"Mend"

"Merc"

"Mero"

"Mlym"

"Lune"

"Mong"

"Mroo"

"Mtei"

"Mymr"

"Narb"

"Nbat"

"Nkgb"

"Nkoo"

"Nshu"

"Ogam"

"Olck"

"Orkh"

"Orya"

"Osma"

"Palm"

"Perm"

"Phag"

"Phli"

"Phlp"

"Phlv"

"Phnx"

"Plrd"

"Prti"

"Rjng"

"Roro"

"Runr"

"Samr"

"Sara"

"Sarb"

"Saur"

"Sgnw"

"Shaw"

"Shrd"

"Sind"

"Sinh"

"Sora"

"Sund"

"Sylo"

"Syrc"

"Syre"

"Syrj"

"Syrn"

"Tagb"

"Takr"

"Tale"

"Talu"

"Taml"

"Tang"

"Tavt"

"Telu"

"Teng"

"Tfng"

"Tglg"

"Thaa"

"Thaï"

"Tibt"

"Tirh"

"Ugar"

"Vaii"

"Visp"

"Wara"

"Wole"

"Xpeo"

"Xsux"

"Yiii"

"Zmth"

"Zsym"

"Zyyy"

Méthodes

clearDefaultFixedFontSize()

chrome.fontSettings.clearDefaultFixedFontSize(
  details?: object,
): Promise<void>

Efface la taille de police fixe par défaut définie par cette extension, le cas échéant.

Paramètres

• détails

  objet facultatif

  Ce paramètre n'est pas utilisé pour le moment.

Renvoie

• Promise<void>

  Chrome 96 ou version ultérieure

clearDefaultFontSize()

chrome.fontSettings.clearDefaultFontSize(
  details?: object,
): Promise<void>

Efface la taille de police par défaut définie par cette extension, le cas échéant.

Paramètres

• détails

  objet facultatif

  Ce paramètre n'est pas utilisé pour le moment.

Renvoie

• Promise<void>

  Chrome 96 ou version ultérieure

clearFont()

chrome.fontSettings.clearFont(
  details: object,
): Promise<void>

Efface la police définie par cette extension, le cas échéant.

Paramètres

• détails

  objet

  • genericFamily

    GenericFamily

    Famille de polices générique pour laquelle la police doit être effacée.

  • écriture

    ScriptCode facultatif

    Script pour lequel la police doit être effacée. Si ce paramètre est omis, le paramètre de police de script global est effacé.

Renvoie

• Promise<void>

  Chrome 96 ou version ultérieure

clearMinimumFontSize()

chrome.fontSettings.clearMinimumFontSize(
  details?: object,
): Promise<void>

Efface la taille de police minimale définie par cette extension, le cas échéant.

Paramètres

• détails

  objet facultatif

  Ce paramètre n'est pas utilisé pour le moment.

Renvoie

• Promise<void>

  Chrome 96 ou version ultérieure

getDefaultFixedFontSize()

chrome.fontSettings.getDefaultFixedFontSize(
  details?: object,
): Promise<object>

Récupère la taille par défaut des polices à largeur fixe.

Paramètres

• détails

  objet facultatif

  Ce paramètre n'est pas utilisé pour le moment.

Renvoie

• Promise<object>

  Chrome 96 ou version ultérieure

getDefaultFontSize()

chrome.fontSettings.getDefaultFontSize(
  details?: object,
): Promise<object>

Récupère la taille de police par défaut.

Paramètres

• détails

  objet facultatif

  Ce paramètre n'est pas utilisé pour le moment.

Renvoie

• Promise<object>

  Chrome 96 ou version ultérieure

getFont()

chrome.fontSettings.getFont(
  details: object,
): Promise<object>

Récupère la police d'un script et d'une famille de polices générique donnés.

Paramètres

• détails

  objet

  • genericFamily

    GenericFamily

    Famille de polices générique pour laquelle la police doit être récupérée.

  • écriture

    ScriptCode facultatif

    Script pour lequel la police doit être récupérée. Si ce paramètre est omis, le paramètre de police pour le script global (code de script "Zyyy") est récupéré.

Renvoie

• Promise<object>

  Chrome 96 ou version ultérieure

getFontList()

chrome.fontSettings.getFontList(): Promise<FontName[]>

Récupère la liste des polices du système.

Renvoie

• Promise<FontName[]>

  Chrome 96 ou version ultérieure

getMinimumFontSize()

chrome.fontSettings.getMinimumFontSize(
  details?: object,
): Promise<object>

Récupère la taille de police minimale.

Paramètres

• détails

  objet facultatif

  Ce paramètre n'est pas utilisé pour le moment.

Renvoie

• Promise<object>

  Chrome 96 ou version ultérieure

setDefaultFixedFontSize()

chrome.fontSettings.setDefaultFixedFontSize(
  details: object,
): Promise<void>

Définit la taille par défaut des polices à largeur fixe.

Paramètres

• détails

  objet

  • pixelSize

    nombre

    Taille de la police en pixels.

Renvoie

• Promise<void>

  Chrome 96 ou version ultérieure

setDefaultFontSize()

chrome.fontSettings.setDefaultFontSize(
  details: object,
): Promise<void>

Définit la taille de police par défaut.

Paramètres

• détails

  objet

  • pixelSize

    nombre

    Taille de la police en pixels.

Renvoie

• Promise<void>

  Chrome 96 ou version ultérieure

setFont()

chrome.fontSettings.setFont(
  details: object,
): Promise<void>

Définit la police pour un script et une famille de polices générique donnés.

Paramètres

• détails

  objet

  • fontId

    chaîne

    ID de la police. La chaîne vide signifie qu'il faut utiliser le paramètre de police de script global.

  • genericFamily

    GenericFamily

    Famille de polices générique pour laquelle la police doit être définie.

  • écriture

    ScriptCode facultatif

    Code du script pour lequel la police doit être définie. Si ce paramètre est omis, le paramètre de police du script global (code de script "Zyyy") est défini.

Renvoie

• Promise<void>

  Chrome 96 ou version ultérieure

setMinimumFontSize()

chrome.fontSettings.setMinimumFontSize(
  details: object,
): Promise<void>

Définit la taille de police minimale.

Paramètres

• détails

  objet

  • pixelSize

    nombre

    Taille de la police en pixels.

Renvoie

• Promise<void>

  Chrome 96 ou version ultérieure

Événements

onDefaultFixedFontSizeChanged

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

Se déclenche lorsque le paramètre de taille de police fixe par défaut change.

Paramètres

• callback

  fonction

  Le paramètre callback se présente comme suit :

  (details: object) => void

  • détails

    objet

    • levelOfControl

      LevelOfControl

      Niveau de contrôle de l'extension sur le paramètre.

    • pixelSize

      nombre

      Taille de la police en pixels.

onDefaultFontSizeChanged

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

Se déclenche lorsque le paramètre de taille de police par défaut change.

Paramètres

• callback

  fonction

  Le paramètre callback se présente comme suit :

  (details: object) => void

  • détails

    objet

    • levelOfControl

      LevelOfControl

      Niveau de contrôle de l'extension sur le paramètre.

    • pixelSize

      nombre

      Taille de la police en pixels.

onFontChanged

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

Déclenché lorsqu'un paramètre de police change.

Paramètres

• callback

  fonction

  Le paramètre callback se présente comme suit :

  (details: object) => void

  • détails

    objet

    • fontId

      chaîne

      ID de la police. Consultez la description dans getFont.

    • genericFamily

      GenericFamily

      Famille de polices générique pour laquelle le paramètre de police a été modifié.

    • levelOfControl

      LevelOfControl

      Niveau de contrôle de l'extension sur le paramètre.

    • écriture

      ScriptCode facultatif

      Code du script pour lequel le paramètre de police a été modifié.

onMinimumFontSizeChanged

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

Se déclenche lorsque le paramètre de taille de police minimale change.

Paramètres

• callback

  fonction

  Le paramètre callback se présente comme suit :

  (details: object) => void

  • détails

    objet

    • levelOfControl

      LevelOfControl

      Niveau de contrôle de l'extension sur le paramètre.

    • pixelSize

      nombre

      Taille de la police en pixels.