@scthakuri/adblock-detector
TypeScript icon, indicating that this package has built-in type declarations

1.0.7 • Public • Published

Ad Block Detector

CHPADBLOCK is the adblock detector package for react. Our package detects most of the adblock extension such as ublock, adblock plus and many more.

View Live Demo on Sandbox

NPM NPM TypeScript Known Vulnerabilities

Features

✅ Adblock Detector Modal

✅ Ease of use

✅ Well-tested

✅ Lightweight

✅ MIT license

Installation

# Via npm:
npm i @scthakuri/adblock-detector

# Via yarn:
yarn add @scthakuri/adblock-detector

Usage:

import { DetectAdblock } from '@scthakuri/adblock-detector';

DetectAdblock((detected) => {
    if( detected ){
        // Adblock is detected
    }else{
        // Adblock is not detected
    }
});

<DetectorModal>

Modal to show if adblock is detected

Props

  • [theme] (String): (optional) Any form of valid color code
  • [title] (String): (optional) Adblock Detected title
  • [message] (String): (optional) Adblock Detected title
  • [closeBtn] (Boolean): (optional) Whether to include close button on modal or not
  • [onModalClose] (Function): Modal doesn't automatically close. You have to manually close the modal as show in example below
  • [reloadBtnText] (String): (Optional) Text for Reload Button

Example

View Live Demo on Sandbox

import { useState, useEffect } from 'react';
import './App.css';
import DetectorModal, { DetectAdblock } from '@scthakuri/adblock-detector'

function App() {

    const [startDetect, setStartDetect] = useState(true);
    const [detected, setDetected] = useState(false);
    const [showModal, setShowModal] = useState(false);

    useEffect(() => {
        if( startDetect ){
            DetectAdblock((enable) => {
                setStartDetect(false);
                setDetected(enable);

                if( enable ){
                    setShowModal(true);
                }
            });
        }
    }, [startDetect])

    return (
        <div className="App">
            <div style={{
                flex : 1,
                display : "flex",
                justifyContent : "center",
                alignItems:"center",
                height : "100vh",
                fontSize : "2rem",
                fontWeight:"bold"
            }}>
                {
                    startDetect ? "Detecting . . ." :
                    detected ? "Detected" : "Not Detected"
                }
            </div>

            {
                showModal && <DetectorModal
                    onModalClose={() => setShowModal(false)}
                    closeBtn
                />
            }
        </div>
    );
}

export default App;

Tested With

  • ☞ Adblock Plus
  • ☞ Adblock
  • ☞ Adguard
  • ☞ Adremover
  • ☞ Adblock for Chrome™
  • ☞ Brave
  • ☞ Ghostery
  • ☞ uBlocker
  • ☞ uBlock
  • ☞ Ultrablock
  • ☞ Privacy Badger
  • ☞ DuckDuckGo
  • ☞ Disconnect
  • ☞ Microsoft Edge AdBlock extension
  • ☞ Firefox Tracking Protection
  • ☞ uBlock Origin
  • ☞ Fair AdBlocker
  • ☞ Hola ad remover
  • ☞ Comodo AdBlocker
  • ☞ Opera Built-in AdBlock extension

Package Sidebar

Install

npm i @scthakuri/adblock-detector

Weekly Downloads

53

Version

1.0.7

License

MIT

Unpacked Size

27.5 kB

Total Files

16

Last publish

Collaborators

  • scthakuri
  • ukesh-dev