web-monetization-ad-hider

<💰> Web Monetization Components </💰>

<wm-ad-hider>

A web component that hides ads if it determines the user is sending payments via web monetization.

Installation

npm

You can install with npm.

npm install web-monetization-ad-hider

Once installed, you can either use the minified version by referencing it from the dist directory.

<script src="./node_modules/web-monetization-ad-hider/dist/wm-ad-hider.min.js"></script>

Or if you have a build step, you can require the module.

const WebMonetizationAdHider = require("web-monetization-ad-hider");

unpkg

If you want to use the component from the unpkg CDN then you can.

You can get the latest version using the bare URL. See more options on https://unpkg.com/.

<script src="https://unpkg.com/web-monetization-ad-hider"></script>

Usage

Wrap your ad code inside a <template> element then in the <wm-ad-hider> component.

<wm-ad-hider>
  <template>
    <script src="https://www.ad-company.com/myAds"></script> 
  </template>
</wm-ad-hider>

The <template> makes the ad code inert (it doesn't render or fetch any linked resources). If the browser doesn't support web monetization (because document.monetization is not present) the ad code will be rendered immediately.

If the browser does support Web Monetization the <wm-ad-hider> will wait for 3 seconds and if no payment is detected the ads will be shown. If payment is detected before that time then no ads will be shown. If payment starts after that time, then ads will be removed from the page.

Attributes

• timeout: The amount of time, in milliseconds the component will wait for monetization to start.

  Default: 3000 (3 seconds)

  Example:

  <wm-ad-hider timeout="5000"><!-- Ad template --></wm-ad-hider>

• template: A CSS selector that points to a <template> elsewhere on the page.

  If your ad code lives elsewhere on the page, you can point to it with the template attribute.

  Example:

  <wm-ad-hider template="#ad-code"></wm-ad-hider>
   
  <!-- later down the page -->
   
  <template id="ad-code">
    <!-- ad template -->
  </template>

LICENSE

MIT (c) 2020 Phil Nash