chrome.fontSettings

Description

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

Autorisations

fontSettings

Fichier manifeste

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"
  ],
  ...
}

Familles de polices et scripts génériques

Chrome permet de définir certains paramètres de police en fonction de certaines familles de polices génériques et de certains scripts linguistiques. 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 dans la référence de l'API ci-dessous. 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 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 acceptés sont spécifiés par le code de script ISO 15924 et sont listés dans la référence de l'API ci-dessous. 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. Il utilise cette police non seulement pour le script cyrillique, mais aussi pour tout ce qu'elle couvre, comme le 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 générique CSS.

Énumération

"standard"

"sansserif"

"serif"

"fixed"

"cursive"

"fantasy"

"math"

LevelOfControl

L'une des valeurs suivantes :not\_controllable : ne peut être contrôlé par aucune extensioncontrolled\_by\_other\_extensions : contrôlé par des extensions avec une priorité plus élevéecontrollable\_by\_this\_extension : peut être contrôlé par cette extensioncontrolled\_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"

"Arabe"

"Armi"

"Armn"

"Avst"

"Bali"

"Bamu"

"Basse"

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

"Membre"

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

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

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

Paramètres

  • détails

    object facultatif

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

  • callback

    function facultatif

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

    () => void

Renvoie

  • Promise<void>

    Chrome 96 et versions ultérieures

    Les promesses ne sont compatibles qu'avec Manifest V3 et les versions ultérieures. Les autres plates-formes doivent utiliser des rappels.

clearDefaultFontSize()

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

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

Paramètres

  • détails

    object facultatif

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

  • callback

    function facultatif

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

    () => void

Renvoie

  • Promise<void>

    Chrome 96 et versions ultérieures

    Les promesses ne sont compatibles qu'avec Manifest V3 et les versions ultérieures. Les autres plates-formes doivent utiliser des rappels.

clearFont()

Promise 
chrome.fontSettings.clearFont(
  details: object,
  callback?: function,
): 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 cette option est omise, le paramètre de police de script global est effacé.

  • callback

    function facultatif

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

    () => void

Renvoie

  • Promise<void>

    Chrome 96 et versions ultérieures

    Les promesses ne sont compatibles qu'avec Manifest V3 et les versions ultérieures. Les autres plates-formes doivent utiliser des rappels.

clearMinimumFontSize()

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

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

Paramètres

  • détails

    object facultatif

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

  • callback

    function facultatif

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

    () => void

Renvoie

  • Promise<void>

    Chrome 96 et versions ultérieures

    Les promesses ne sont compatibles qu'avec Manifest V3 et les versions ultérieures. Les autres plates-formes doivent utiliser des rappels.

getDefaultFixedFontSize()

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

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

Paramètres

  • détails

    object facultatif

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

  • callback

    function facultatif

    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

        Total

        Taille de la police en pixels.

Renvoie

  • Promise<object>

    Chrome 96 et versions ultérieures

    Les promesses ne sont compatibles qu'avec Manifest V3 et les versions ultérieures. Les autres plates-formes doivent utiliser des rappels.

getDefaultFontSize()

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

Obtient la taille de police par défaut.

Paramètres

  • détails

    object facultatif

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

  • callback

    function facultatif

    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

        Total

        Taille de la police en pixels.

Renvoie

  • Promise<object>

    Chrome 96 et versions ultérieures

    Les promesses ne sont compatibles qu'avec Manifest V3 et les versions ultérieures. Les autres plates-formes doivent utiliser des rappels.

getFont()

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

Récupère la police pour un script et une famille de polices génériques 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 elle est omise, le paramètre de police du script global (code de script "Zyyy") est récupéré.

  • callback

    function facultatif

    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 laquelle le système résout la valeur de préférence, plutôt que de la valeur de préférence littérale de l'ID de police. Par conséquent, fontId peut différer de la police transmise à setFont, par exemple si la police n'est pas disponible sur le système. La chaîne vide signifie un retour au paramètre de police de script global.

      • levelOfControl

        LevelOfControl

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

Renvoie

  • Promise<object>

    Chrome 96 et versions ultérieures

    Les promesses ne sont compatibles qu'avec Manifest V3 et les versions ultérieures. Les autres plates-formes doivent utiliser des rappels.

getFontList()

Promise 
chrome.fontSettings.getFontList(
  callback?: function,
): Promise<FontName[]>

Obtient la liste des polices du système.

Paramètres

  • callback

    function facultatif

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

    (results: FontName[]) => void

Renvoie

  • Promise<FontName[]>

    Chrome 96 et versions ultérieures

    Les promesses ne sont compatibles qu'avec Manifest V3 et les versions ultérieures. Les autres plates-formes doivent utiliser des rappels.

getMinimumFontSize()

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

Obtient la taille de police minimale.

Paramètres

  • détails

    object facultatif

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

  • callback

    function facultatif

    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

        Total

        Taille de la police en pixels.

Renvoie

  • Promise<object>

    Chrome 96 et versions ultérieures

    Les promesses ne sont compatibles qu'avec Manifest V3 et les versions ultérieures. Les autres plates-formes doivent utiliser des rappels.

setDefaultFixedFontSize()

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

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

Paramètres

  • détails

    objet

    • pixelSize

      Total

      Taille de la police en pixels.

  • callback

    function facultatif

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

    () => void

Renvoie

  • Promise<void>

    Chrome 96 et versions ultérieures

    Les promesses ne sont compatibles qu'avec Manifest V3 et les versions ultérieures. Les autres plates-formes doivent utiliser des rappels.

setDefaultFontSize()

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

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

Paramètres

  • détails

    objet

    • pixelSize

      Total

      Taille de la police en pixels.

  • callback

    function facultatif

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

    () => void

Renvoie

  • Promise<void>

    Chrome 96 et versions ultérieures

    Les promesses ne sont compatibles qu'avec Manifest V3 et les versions ultérieures. Les autres plates-formes doivent utiliser des rappels.

setFont()

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

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

Paramètres

  • détails

    objet

    • fontId

      chaîne

      ID de la police. La chaîne vide signifie que le paramètre de police de script global doit être utilisé.

    • genericFamily

      GenericFamily

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

    • écriture

      ScriptCode facultatif

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

  • callback

    function facultatif

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

    () => void

Renvoie

  • Promise<void>

    Chrome 96 et versions ultérieures

    Les promesses ne sont compatibles qu'avec Manifest V3 et les versions ultérieures. Les autres plates-formes doivent utiliser des rappels.

setMinimumFontSize()

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

Définit la taille de police minimale.

Paramètres

  • détails

    objet

    • pixelSize

      Total

      Taille de la police en pixels.

  • callback

    function facultatif

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

    () => void

Renvoie

  • Promise<void>

    Chrome 96 et versions ultérieures

    Les promesses ne sont compatibles qu'avec Manifest V3 et les versions ultérieures. Les autres plates-formes doivent utiliser des rappels.

Événements

onDefaultFixedFontSizeChanged

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

Déclenché 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

        Total

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

        Total

        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,
)

Déclenché 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

        Total

        Taille de la police en pixels.