chrome.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 à certains paramètres de police de dépendre 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 répertoriées sous GenericReference. Lorsqu'une page Web spécifie une famille de polices générique, Chrome la sélectionne en fonction du paramètre correspondant. Si aucune famille de polices génériques n'est spécifiée, Chrome utilise le paramètre correspondant à 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 du script de langue correspondant. Si aucune langue n'est spécifiée, Chrome utilise le paramètre du script par défaut ou global.

Les scripts de langue compatibles sont spécifiés par le code ISO 15924 et répertoriés sous ScriptCode. Techniquement, les paramètres Chrome ne sont pas strictement spécifiques au script, mais dépendent également de la langue. Par exemple, Chrome choisit la police pour l'alphabet cyrillique (code de script ISO 15924 "Cyrl") lorsqu'une page Web spécifie la langue russe, et l'utilise non seulement pour le script cyrillique, mais aussi pour tout ce qui est recouvert par la police comme l'alphabet latin.

Exemples

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

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

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

chrome.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

Famille de polices CSS générique.

Enum

"standard"

"sansserif"

"serif"

"cursive"

"fantasy"

"math"

LevelOfControl

L'une des not\_controllable: ne peut être contrôlé par aucune extension controlled\_by\_other\_extensions: contrôlée par des extensions ayant une priorité plus élevée controllable\_by\_this\_extension: peut être contrôlée par cette extension controlled\_by\_this\_extension: contrôlée par cette extension

Enum

"not_controllable"

"controllable_by_this_extension"

ScriptCode

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

Enum

"Afak"

"Avst"

"Bali"

"Bamu"

"Batk"

"Beng"

"Blis"

"Bopo"

"Brah"

"Brai"

"Bugi"

"Buhd"

"Cakm"

"Cari"

"Cham"

"Cher"

"Cirt"

"Cprt"

"Cyrl"

"Cyrs"

"Deva"

"Dsrt"

"Dupl"

"Egyd"

"Egyh"

"Egyp"

"Elba"

"Ethi"

"Geor"

"Geok"

"Goth"

"Grek"

"Gujr"

"Hani"

"Hano"

"Hans"

"Hant"

"Hebr"

"Hluw"

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

"Mong"

"Mroo"

"Mtei"

"Mymr"

"Narb"

"Nbat"

"Nkgb"

"Nkoo"

"Nshu"

"Ogam"

"Olck"

"Orya"

"Osma"

"Phag"

"Phli"

"Phlp"

"Phlv"

"Phnx"

"Plrd"

"Prti"

"Rjng"

"Roro"

"Runr"

"Samr"

"Sara"

"Sarb"

"Sgnw"

"Shaw"

"Shrd"

"Sind"

"Sinh"

"Sora"

"Sylo"

"Syrc"

"Syre"

"Syrj"

"Syrn"

"Takr"

"Tale"

"Taml"

"Tang"

"Tavt"

"Teng"

"Tfng"

"Tglg"

"Thaa"

"Tibt"

"Tirh"

"Ugar"

"Vaii"

"Visp"

"Wara"

"Wole"

"Xpeo"

"Xsux"

"Yiii"

"Zmth"

"Zsym"

"Zyyy"

Méthodes

clearDefaultFixedFontSize()

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

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é actuellement.

  • rappel

    fonction facultative

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

    ()=>void

Renvoie

  • Promise<void>

    Chrome 96 et versions ultérieures

    Les promesses sont compatibles avec Manifest V3 et les versions ultérieures, mais des rappels sont fournis pour assurer la rétrocompatibilité. Vous ne pouvez pas utiliser les deux dans le même appel de fonction. La promesse est résolue avec le même type que celui transmis au rappel.

clearDefaultFontSize()

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

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é actuellement.

  • rappel

    fonction facultative

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

    ()=>void

Renvoie

  • Promise<void>

    Chrome 96 et versions ultérieures

    Les promesses sont compatibles avec Manifest V3 et les versions ultérieures, mais des rappels sont fournis pour assurer la rétrocompatibilité. Vous ne pouvez pas utiliser les deux dans le même appel de fonction. La promesse est résolue avec le même type que celui transmis au rappel.

clearFont()

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

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. En cas d'omission, le paramètre général de police du script est effacé.

  • rappel

    fonction facultative

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

    ()=>void

Renvoie

  • Promise<void>

    Chrome 96 et versions ultérieures

    Les promesses sont compatibles avec Manifest V3 et les versions ultérieures, mais des rappels sont fournis pour assurer la rétrocompatibilité. Vous ne pouvez pas utiliser les deux dans le même appel de fonction. La promesse est résolue avec le même type que celui transmis au rappel.

clearMinimumFontSize()

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

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é actuellement.

  • rappel

    fonction facultative

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

    ()=>void

Renvoie

  • Promise<void>

    Chrome 96 et versions ultérieures

    Les promesses sont compatibles avec Manifest V3 et les versions ultérieures, mais des rappels sont fournis pour assurer la rétrocompatibilité. Vous ne pouvez pas utiliser les deux dans le même appel de fonction. La promesse est résolue avec le même type que celui transmis au rappel.

getDefaultFixedFontSize()

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

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

Paramètres

  • détails

    objet facultatif

    Ce paramètre n'est pas utilisé actuellement.

  • rappel

    fonction facultative

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

    (details: object)=>void

    • détails

      objet

      • levelOfControl

        LevelOfControl

        Niveau de contrôle de cette extension sur le paramètre.

      • pixelSize

        number

        Taille de la police en pixels.

Renvoie

  • Promise<object>

    Chrome 96 et versions ultérieures

    Les promesses sont compatibles avec Manifest V3 et les versions ultérieures, mais des rappels sont fournis pour assurer la rétrocompatibilité. Vous ne pouvez pas utiliser les deux dans le même appel de fonction. La promesse est résolue avec le même type que celui transmis au rappel.

getDefaultFontSize()

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

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

Paramètres

  • détails

    objet facultatif

    Ce paramètre n'est pas utilisé actuellement.

  • rappel

    fonction facultative

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

    (details: object)=>void

    • détails

      objet

      • levelOfControl

        LevelOfControl

        Niveau de contrôle de cette extension sur le paramètre.

      • pixelSize

        number

        Taille de la police en pixels.

Renvoie

  • Promise<object>

    Chrome 96 et versions ultérieures

    Les promesses sont compatibles avec Manifest V3 et les versions ultérieures, mais des rappels sont fournis pour assurer la rétrocompatibilité. Vous ne pouvez pas utiliser les deux dans le même appel de fonction. La promesse est résolue avec le même type que celui transmis au rappel.

getFont()

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

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

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. S'il est omis, le paramètre de police du script global (code de script "Zyyy") est récupéré.

  • rappel

    fonction facultative

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

    (details: object)=>void

    • détails

      objet

      • fontId

        chaîne

        ID de la police. Il peut s'agir de l'ID de la police vers lequel le système résout la valeur de préférence, et non la valeur littérale de préférence de l'ID de police. Ainsi, fontId peut différer de la police transmise à setFont si, par exemple, la police n'est pas disponible sur le système. La chaîne vide signifie que le paramètre global de police du script sera utilisé à nouveau.

      • levelOfControl

        LevelOfControl

        Niveau de contrôle de cette extension sur le paramètre.

Renvoie

  • Promise<object>

    Chrome 96 et versions ultérieures

    Les promesses sont compatibles avec Manifest V3 et les versions ultérieures, mais des rappels sont fournis pour assurer la rétrocompatibilité. Vous ne pouvez pas utiliser les deux dans le même appel de fonction. La promesse est résolue avec le même type que celui transmis au rappel.

getFontList()

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

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

Paramètres

  • rappel

    fonction facultative

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

    (results: FontName[])=>void

Renvoie

  • Promise<FontName[]>

    Chrome 96 et versions ultérieures

    Les promesses sont compatibles avec Manifest V3 et les versions ultérieures, mais des rappels sont fournis pour assurer la rétrocompatibilité. Vous ne pouvez pas utiliser les deux dans le même appel de fonction. La promesse est résolue avec le même type que celui transmis au rappel.

getMinimumFontSize()

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

Récupère la taille de police minimale.

Paramètres

  • détails

    objet facultatif

    Ce paramètre n'est pas utilisé actuellement.

  • rappel

    fonction facultative

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

    (details: object)=>void

    • détails

      objet

      • levelOfControl

        LevelOfControl

        Niveau de contrôle de cette extension sur le paramètre.

      • pixelSize

        number

        Taille de la police en pixels.

Renvoie

  • Promise<object>

    Chrome 96 et versions ultérieures

    Les promesses sont compatibles avec Manifest V3 et les versions ultérieures, mais des rappels sont fournis pour assurer la rétrocompatibilité. Vous ne pouvez pas utiliser les deux dans le même appel de fonction. La promesse est résolue avec le même type que celui transmis au rappel.

setDefaultFixedFontSize()

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

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

Paramètres

  • détails

    objet

    • pixelSize

      number

      Taille de la police en pixels.

  • rappel

    fonction facultative

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

    ()=>void

Renvoie

  • Promise<void>

    Chrome 96 et versions ultérieures

    Les promesses sont compatibles avec Manifest V3 et les versions ultérieures, mais des rappels sont fournis pour assurer la rétrocompatibilité. Vous ne pouvez pas utiliser les deux dans le même appel de fonction. La promesse est résolue avec le même type que celui transmis au rappel.

setDefaultFontSize()

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

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

Paramètres

  • détails

    objet

    • pixelSize

      number

      Taille de la police en pixels.

  • rappel

    fonction facultative

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

    ()=>void

Renvoie

  • Promise<void>

    Chrome 96 et versions ultérieures

    Les promesses sont compatibles avec Manifest V3 et les versions ultérieures, mais des rappels sont fournis pour assurer la rétrocompatibilité. Vous ne pouvez pas utiliser les deux dans le même appel de fonction. La promesse est résolue avec le même type que celui transmis au rappel.

setFont()

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

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

Paramètres

  • détails

    objet

    • fontId

      chaîne

      ID de la police. Une chaîne vide signifie qu'il s'agit d'un 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 dans lequel la police doit être définie. Si cette valeur est omise, le paramètre de police du script global (code de script "Zyyy") est défini.

  • rappel

    fonction facultative

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

    ()=>void

Renvoie

  • Promise<void>

    Chrome 96 et versions ultérieures

    Les promesses sont compatibles avec Manifest V3 et les versions ultérieures, mais des rappels sont fournis pour assurer la rétrocompatibilité. Vous ne pouvez pas utiliser les deux dans le même appel de fonction. La promesse est résolue avec le même type que celui transmis au rappel.

setMinimumFontSize()

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

Définit la taille de police minimale.

Paramètres

  • détails

    objet

    • pixelSize

      number

      Taille de la police en pixels.

  • rappel

    fonction facultative

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

    ()=>void

Renvoie

  • Promise<void>

    Chrome 96 et versions ultérieures

    Les promesses sont compatibles avec Manifest V3 et les versions ultérieures, mais des rappels sont fournis pour assurer la rétrocompatibilité. Vous ne pouvez pas utiliser les deux dans le même appel de fonction. La promesse est résolue avec le même type que celui transmis au rappel.

Événements

onDefaultFixedFontSizeChanged

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

Déclenché lorsque le paramètre de taille de police fixe par défaut est modifié.

Paramètres

  • rappel

    function

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

    (details: object)=>void

    • détails

      objet

      • levelOfControl

        LevelOfControl

        Niveau de contrôle de cette extension sur le paramètre.

      • pixelSize

        number

        Taille de la police en pixels.

onDefaultFontSizeChanged

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

Déclenché lorsque le paramètre de taille de police par défaut est modifié.

Paramètres

  • rappel

    function

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

    (details: object)=>void

    • détails

      objet

      • levelOfControl

        LevelOfControl

        Niveau de contrôle de cette extension sur le paramètre.

      • pixelSize

        number

        Taille de la police en pixels.

onFontChanged

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

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

Paramètres

  • rappel

    function

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

    (details: object)=>void

    • détails

      objet

      • fontId

        chaîne

        ID de la police. Voir 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 cette 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,
)

Déclenché lorsque la taille de police minimale est modifiée.

Paramètres

  • rappel

    function

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

    (details: object)=>void

    • détails

      objet

      • levelOfControl

        LevelOfControl

        Niveau de contrôle de cette extension sur le paramètre.

      • pixelSize

        number

        Taille de la police en pixels.