userScripts

Utilisez cette API pour enregistrer les scripts utilisateur, un type spécial de script d'extension de contenu. L'enregistrement d'un userScript demande au navigateur d'insérer le script donné dans les pages qui correspondent aux modèles d'URL passés à register().

Pour utiliser l'API, appelez register() passing in an object en passant un objet définissant le script à enregistrer. La méthode retourne une promesse qui est résolue avec un objet RegisteredUserScript.

Scripts d'utilisateur :

  • s'exécuter dans les processus de contenu de l'extension
  • avoir accès à la fenêtre et documenter les valeurs globales relatives à la page Web à laquelle elle est rattachée
  • ont accès au même sous-ensemble d'API WebExtension qu'un script de contenu.

Un userScript doit être déclaré dans le fichier manifeste de l'extension à l'aide de la clé manifest "user_scripts".

Une fois chargé et enregistré, le script utilisateur est exécuté automatiquement sur n'importe quelle page Web correspondant à userScript enregistrée par la même extension, avant que l'userScript soit exécuté.

Une fois enregistré, un script utilisateur a accès à l'événement beforeScript, que l'APIScript peut utiliser pour ajouter un écouteur d'événement qui sera appelé juste avant l'exécution d'un RegisteredUserScript correspondant. Cela permet au script utilisateur d'exporter un ensemble de méthodes d'API personnalisées à mettre à la disposition de l'userScript.

Les scripts utilisateur sont désenregistrés lorsque la page d'extension correspondante (à partir de laquelle les scripts utilisateur ont été enregistrés) est déchargée, vous devez donc enregistrer un script utilisateur depuis une page d'extension qui persiste au moins aussi longtemps que vous voulez que les scripts utilisateur restent enregistrés

Gestionnaires d'événements

onBeforeScript
Représente le code du gestionnaire d'événement qui sera exécuté avant l'exécution du userScript associé.

Types

RegisteredUserScript
Un object de ce type est retourné par la méthode  register(). Il représente les scripts utilisateur qui ont été enregistrés par cet appel et peut être utilisé pour désenregistrer le script utilisateur.

Méthodes

register()
Enregistre les scripts utilisateur donnés.

Compatibilité du navigateur

Update compatibility data on GitHub
OrdinateurMobile
ChromeEdgeFirefoxOperaFirefox pour Android
RegisteredUserScriptChrome Aucun support NonEdge Aucun support NonFirefox Support complet 68
Support complet 68
Support complet 66
Désactivée
Désactivée From version 66: this feature is behind the extensions.webextensions.userScripts.enabled preference (needs to be set to true). To change preferences in Firefox, visit about:config.
Opera Aucun support NonFirefox Android Support complet 68
unregisterChrome Aucun support NonEdge Aucun support NonFirefox Support complet 68
Support complet 68
Support complet 66
Désactivée
Désactivée From version 66: this feature is behind the extensions.webextensions.userScripts.enabled preference (needs to be set to true). To change preferences in Firefox, visit about:config.
Opera Aucun support NonFirefox Android Support complet 68

Légende

Support complet  
Support complet
Aucun support  
Aucun support
Une action explicite de l'utilisateur est nécessaire pour activer cette fonctionnalité.
Une action explicite de l'utilisateur est nécessaire pour activer cette fonctionnalité.

Voir aussi