Skip to content

Create userscripts-api.md #711

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
wants to merge 4 commits into
base: master
Choose a base branch
from
Open

Create userscripts-api.md #711

Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
66abee8
Create usercripts-api.md
puglieri Jun 23, 2025
08b300a
Update usercripts-api.md
puglieri Jun 23, 2025
f071a44
Update usercripts-api.md
puglieri Jun 23, 2025
9aa1430
update userscripts-api.md
puglieri Jun 23, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
26 changes: 26 additions & 0 deletions docs/adguard-browser-extension/userscripts-api.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,26 @@
---
title: User Scripts API
sidebar_position: 8
---

:::info

This article is about AdGuard Browser Extension, which safeguards only your browser. To protect your entire device, [download the AdGuard app](https://adguard.com/download.html?auto=true)
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
This article is about AdGuard Browser Extension, which safeguards only your browser. To protect your entire device, [download the AdGuard app](https://adguard.com/download.html?auto=true)
This article is about AdGuard Browser Extension, which safeguards only your browser. To protect your entire device, [download the AdGuard app](https://adguard.com/download.html?auto=true).


:::

When adding a custom filter or a user rule, you will encounter a notification message asking you to turn on the developer mode to use these features on the extension:
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
When adding a custom filter or a user rule, you will encounter a notification message asking you to turn on the developer mode to use these features on the extension:
When adding a custom filter or user rule, a notification will appear asking you to enable developer mode to use these features in the extension:


![Notification *border](https://cdn.adtidy.org/content/Kb/ad_blocker/browser_extension/dev-mode-ext.png)

This is because, from v5.2, AdGuard Browser Extension has migrated to the User Scripts API. In other words, the extension now uses script-based rules.
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
This is because, from v5.2, AdGuard Browser Extension has migrated to the User Scripts API. In other words, the extension now uses script-based rules.
This is because, starting with version 5.2, AdGuard Browser Extension has migrated to the User Scripts API. In other words, the extension now uses script-based rules.


## What is the User Scripts API?

The User Scripts API is a set of browser-provided functions and capabilities that allow extensions to run custom JavaScript scripts on web pages. These are often used to modify or enhance websites in ways that aren’t originally provided by the website itself.

With the shift to Chrome’s Manifest V3, many older methods of injecting scripts are limited or delayed. However, there is an exception for the User Scripts API.

## What happens when you enable the developer mode

You must enable either the developer mode (for Chrome versions prior to 138) or the *Allow User Scripts* toggle (for Chrome version 138 and more recent ones). When you do it, you give the extension a reliable and secure method of injecting scripts into web pages at an optimal time. This allows you to use **custom filters** and JavaScript rules in **User rules**.
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
You must enable either the developer mode (for Chrome versions prior to 138) or the *Allow User Scripts* toggle (for Chrome version 138 and more recent ones). When you do it, you give the extension a reliable and secure method of injecting scripts into web pages at an optimal time. This allows you to use **custom filters** and JavaScript rules in **User rules**.
You must either enable developer mode (for Chrome versions prior to 138) or the *Allow User Scripts* toggle (for Chrome version 138 and later). Doing so gives the extension a reliable and secure method of injecting scripts into web pages at the optimal time. This allows you to use custom filters and JavaScript rules in *User Rules*.