aliasio / demodal Goto Github PK

Demodal is a browser extension that automatically removes content blocking modals including paywalls, discount offers, promts to sign up or enter your email address and more.

Home Page: https://www.demodal.com

License: MIT License

JavaScript 72.15% HTML 15.53% CSS 9.66% Shell 2.65%

browser-extension modal-blocker

demodal's Introduction

Demodal

Demodal is a browser extension that automatically removes content blocking modals including paywalls, discount offers, promts to sign up or enter your email address and more.

Modal dialogues such as paywalls, discount offers, cookie prompts and GDPR banners are user-hostile interfaces that demand your attention and interrupt your browsing experience. Demodal puts you back in control, letting you focus on the content.

Installation

Google Chrome

https://chrome.google.com/webstore/detail/demodal/fjhbdkfknppikobblnjibmkmogjeffcf

Install locally:

Clone this repository
Run ./run manifest v3 or copy manifest-v3.json to manifest.json
Go to about:extensions
Enable 'Developer mode'
Click 'Load unpacked'
Select the project folder

Mozilla Firefox

https://addons.mozilla.org/firefox/addon/demodal

Install locally:

Clone this repository
Run ./run manifest v2 or copy manifest-v2.json to manifest.json
Go go about:debugging#/runtime/this-firefox
Click 'Load Temporary Add-on'
Select manifest.json

Contributing

This extension is in early development. You can help by reporting websites with modals that didn't get blocked, or by creating your own definitions and sharing them with us and the community. The aim is to build up a comprehensive set of rules over time to block modals anywhere.

Demodal is not an ad-blocker. Only create definitions for UI elements that intefere with reading of content.

When submitting a pull request, please include a screenshot of the element that's being blocked and a link to a website to test.

Every definition should clearly match one modal type (e.g. consent request or paywall). Don't create overly broad definitions (e.g. div.modal) that could block legimitate modals.

Specification

Modal types

Type	Description
`consent`	Cookie and GDPR notices.
`donate`	Prompts to make a donation.
`email`	Prompts to enter your email address.
`message`	General messages and notifications.
`offer`	Promotions and discounts.
`paywall`	Prompts to sign up for a paid subscription.
`signup`	Prompts to create an account.

Definitions

Definitions are located in /definitions, file-separated by modal type. Definitions are grouped by URL pattern.

{
  "<glob> [ <glob> ... ]": { // URL pattern
    // Definition
    "if <function> [ <function> ... ]": { // Condition
      "<selector>": "<function> [ <argument> ... ]" // Action
    },
    // Definition (shorthand, no condition)
    "<selector>": "<function> [ <argument> ... ]" // Action
  }
}

Examples

{
  "*.example.com *.example.org": {
    "if $(.modal)": {
      ".modal": "remove" // Remove element if present
    },
    ".modal": "addClass hide" // Remove element (shorthand)
    "if defined(ModalDialog)": {
      "ModalDialog.close": "call" // Call function if defined
    },
    "if defined(ModalDialog)": {
      "ModalDialog.setClosed": "call true" // Call function with arguments
    },      
  }
}

URL pattern

URL patterns are defined as globs, allowing wildcards (*).

Glob	Matches
`*`	Any URL.
`*.example.com`	Apex domain and any subdomain, e.g. `example.com`, `www.example.com`.
`example.com example.org`	`example.com` and `example.org`.
`.example.com//about`	E.g. `www.example.com/en/about`.

Conditions

Conditions start with if, followed by one or more functions. If all functions evaluate to true, the specified actions are run.

Functions

Function	Argument	Description
`$()`	Query selector	Tests if an HTML element exists.
`defined()`	JavaScript property	Tests if a JavaScript property exists.
`sleep()`	Time in milliseconds	Returns true after the specified time has passed

Actions

Actions are run when the condition is met, or if no condition is specified.

Functions

Function	Argument	Description
`remove`		Remove the HTML element.
`removeParent`	Number	Remove parent node.
`removeIf`	String	Remove the HTML element if its text content matches a string.
`addClass`	Class name	Add a class.
`removeClass`	Class name	Remove a class.
`addStyle`	Styles	Appends CSS to the style attribute.
`removeStyle`		Clears the style attribute.
`click`		Click the HTML element.
`call`		Call the function. Any arguments will be passed to the function.

demodal's People

Contributors

Stargazers

Watchers

demodal's Issues

Demodal is no longer being developed?

@AliasIO, have you stopped developing Demodal? I'm asking this question since you don't close open pull requests.

Simply Wall Street's paywall is not blocked

Unfortunately instructions for me are unclear how to create rule for removing paywall, so I ask somebody to do this.

Link (it's showing paywall only when stock is chosen) - https://simplywall.st/stocks/us/tech/nasdaq-aapl/apple

reporting modal on action.com

On action.com, an email newsletter modal with class=ReactModalPortal is not blocked.

site: https://www.action.com/pl-pl/promocja-tygodnia/?page=5#promocja-tygodnia

Glassdoor Still requiring wall

https://www.glassdoor.com/ requires guests to leave a review.

modals on ultimate-guitar.com

There are at least two obnoxious time-delayed modals that appear on the popular song chords website ultimate-guitar.com:

Example link: https://tabs.ultimate-guitar.com/tab/in-extremo/ai-vis-lo-lop-chords-1101970

The first is a sign-up modal that appears after about 20 seconds:

The second is an app advertising modal that appears after about about 60 seconds:

model overlay on coasttocoastam.com

There's a modal overlay on coasttocoastam.com that demodal doesn't handle.
It blocks page views a couple of seconds after the page loads until clicked.
Pretty annoying, the main reason I picked up your addon.

The majority of assets this page loads come from either iheart.com or adobedtm.com, if that makes any difference.

The Wall Street Journal

The wall street journal
paywall still there

ex:
https://www.wsj.com
https://www.wsj.com/articles/states-file-new-suits-against-google-over-location-tracking-11643037890

Great addon !

TypeError: node.dataset is undefined

I noticed this extension logs an error whenever an element containing only text is updated.
This issue appears to be Firefox only. I observed this issue in v112.

The problem comes from this section of content.js line 154-156

mutations.every((mutation) =>
  Array.from(mutation.addedNodes).every((node) => node.dataset.demodal)
)

In firefox, when a node containing just text is updated, node.dataset is null, and the attempt to read .demodal causes a type error.

I think the above code could be changed as follows to filter out text-only mutations.

mutations.every((mutation) =>
  Array.from(mutation.addedNodes).every((node) => node.dataset == null || node.dataset.demodal)
)

Here is a minimal html file which triggers the issue once per second.
npx http-server --port 8000 and navigate to http://localhost:8000/issue.html

<html>
<head>
  <script>
    document.addEventListener('DOMContentLoaded', () => {
      const content = document.getElementById("content");
      let count = 0;
      setInterval(() => {
        count++;
        content.innerText = `Some Content ${count}`;
      }, 1000);
    });
  </script>
</head>

<body>
  <div id="content">Some Content 0</div>
</body>
</html>

modal not blocked on celticseasalt.com

The modal on this website isn't being blocked: https://www.celticseasalt.com/
Instructions for replication: Enter the site, wait about 5 seconds, and it pops up.

I modified your code you suggested to me from my previous issue into this, but it doesn't remove it:

{
  "celticseasalt.com": {
    "body div[style*='z-index']": "removeIf 'Join'"
  }
}

By the way, is reporting unblocked modals here in the issues page the way we improve Demodal for future versions?

Thanks either way. Cookie and newsletter modals are the bane of my internet experience and your addon helps restore some sanity.

aliasio / demodal Goto Github PK

demodal's Introduction

Demodal

Installation

Google Chrome

Mozilla Firefox

Contributing

Specification

Modal types

Definitions

URL pattern

Conditions

Functions

Actions

Functions

demodal's People

Contributors

Stargazers

Watchers

Forkers

demodal's Issues

Recommend Projects

Recommend Topics

Recommend Org