options_ui

Type Object
Obligatoire Non
Exemple




"options_ui": {
  "page": "options/options.html"
}

Utilisez la clé options_ui pour définir une page d'options pour votre extension.

La page d'options contient des paramètres pour l'extension. L'utilisateur peut accéder à partir du gestionnaire des extensions du navigateur, et vous pouvez l'ouvrir à partir de votre extension à l'aide de runtime.openOptionsPage().

Vous spécifiez options_ui comme un chemin vers un fichier HTML emballé avec votre extension. Le fichier HTML peut inclure des fichiers CSS and JavaScript, tout comme une page Web normale. Contrairement à une page normale, le JavaScript peut utiliser toutes les APIs WebExtension auxquelles l'extension possède des permissions for. Cependant, il fonctionne dans une portée différente de celle de vos scripts d'arriève plan.

Si vous souhaitez partager des données ou des fonctions entre JavaScript sur votre page d'options et vos scripts d'arrière-plan, vous pouvez le faire directement en obtenant une référence à la fenêtre de vos scripts d'arrière-plan en utilisant extension.getBackgroundPage(), Ou une référence à Window de l'une des pages exécutant dans votre extension avec extension.getViews(). Alternativement, vous pouvez communiquer entre le JavaScript de votre page d'options et vos script (s) en arrière-plan à l'aide de runtime.sendMessage(), runtime.onMessage, et/ou runtime.connect().

En général, vous souhaitez stocker les options modifiées sur les pages d'options à l'aide de l'API de stockage soit dans storage.sync (si vous souhaitez que les paramètres soient synchronisés sur toutes les instances du navigateur dans lequel l'utilisateur est connecté), ou storage.local (si le Les paramètres sont locaux à la machine/profil actuel). Si vous le faites et que votre (vos) script(s) d'arrière-plan doit connaître le changement, votre script d'arrière plan pourrait choisir d'ajouter un auditeur à storage.onChanged.

Syntaxe

La clé options_ui est un objet avec le contenu suivant :

Name Type Description
browser_style Boolean

Facultatif, par défaut à True.

Utilisez cette option pour inclure une feuille de style dans votre page qui la rendra compatible avec l'interface utilisateur du navigateur et avec d'autres extensions qui utilisent la propriété browser_style. Bien qu'il soit par défaut, il est recommandé d'inclure cette propriété.

Dans Firefox, la feuille de style peut être vue sur chrome://browser/content/extension.css, ou chrome://browser/content/extension-mac.css sur OS X.

Le guide de style Firefox décrit les classes que vous pouvez appliquer aux éléments de la fenêtre contextuelle afin d'obtenir des styles particuliers.

open_in_tab Boolean

facultatif, par défaut à false.

Si c'est vrai, la page options s'ouvrira dans un onglet du navigateur normal, plutôt que d'être intégrée au gestionnaire des extensions du navigateur.

page String

Obligatoire

Le chemin d'accès au fichier HTML contenant la spécification de votre page d'options.

Le chemin est relatif à l'emplacement du manifest.json nui-même.

Exemple

  "options_ui": {
    "page": "options/options.html"
  }

Compatibilité du navigateur

ChromeEdgeFirefoxFirefox for AndroidOpera
Basic supportYesNo52NoYes
chrome_styleYesNoNoNoYes
browser_styleNoNo55NoNo

Étiquettes et contributeurs liés au document

Étiquettes : 
 Contributeurs à cette page : hellosct1
 Dernière mise à jour par : hellosct1,