0.1.18 • Published 6 months ago

@monetumo/react-ad-component v0.1.18

Weekly downloads
-
License
MIT
Repository
-
Last release
6 months ago

Monetumo React Ad Component

A React component for displaying ads with Google Publisher Tags (GPT) and Prebid.js integration. Designed for easy integration with remote configuration support.

Installation

npm install @monetumo/react-ad-component

Features

  • 🚀 Lazy loading with Intersection Observer
  • 📱 Responsive ad sizes via remote configuration
  • 🔄 Auto-refresh capability
  • 🎯 GPT & Prebid.js integration
  • TypeScript support
  • 🌐 Remote configuration driven

Basic Usage

import { MonetumoAdSlot } from '@monetumo/react-ad-component';

function MyComponent() {
  return (
    <MonetumoAdSlot
      prefix="23169492389/DK"
      adUnit="mpu_atf_listings"
      refreshInterval={30000}
      onLoad={() => console.log('Ad loaded')}
      onError={(error) => console.error('Ad error:', error)}
    />
  );
}

Advanced Usage

import { MonetumoAdSlot } from '@monetumo/react-ad-component';

function MyComponent() {
  return (
    <MonetumoAdSlot
      prefix="23169492389/DK"
      adUnit="banner_top"
      sizes={[[728, 90], [970, 250]]} // Optional size override
      label="Advertisement"
      className="my-custom-ad-class"
      refreshInterval={60000}
      onLoad={() => console.log('Ad loaded successfully')}
      onError={(error) => console.error('Ad failed to load:', error)}
    />
  );
}

Sticky Footer Ad

The package also includes a specialized sticky footer ad component:

import { StickyFooterAd } from '@monetumo/react-ad-component';

function App() {
  return (
    <div>
      {/* Your app content */}
      
      <StickyFooterAd
        prefix="23169492389/DK"
        adUnit="sticky_footer"
        disabledRoutes={['/privacy', '/terms']}
        autoHideAfter={30000} // Auto-hide after 30 seconds
        onClose={() => console.log('Sticky ad closed')}
      />
    </div>
  );
}

StickyFooterAd Props

PropertyTypeDefaultDescription
prefixstring"23169492389/DK"Ad unit prefix
adUnitstring"sticky_footer"Ad unit identifier
sizes[number, number][]OptionalAd size override
disabledRoutesstring[][]Routes where the ad shouldn't appear
onClose() => voidOptionalCallback when user closes the ad
autoHideAfternumberOptionalAuto-hide after X milliseconds

Configuration Options

PropertyTypeDefaultDescription
prefixstringRequiredThe prefix for your ad unit path (e.g., "23169492389/DK")
adUnitstringRequiredThe ad unit identifier
sizes[number, number][]OptionalAd size override (uses remote config if not provided)
labelstring"Advertisement"Label displayed above the ad
classNamestring""Additional CSS class names
refreshIntervalnumber30000Auto-refresh interval in milliseconds
onLoad() => voidOptionalCallback when ad loads successfully
onError(error: Error) => voidOptionalCallback when ad fails to load

Remote Configuration

The component primarily uses remote configuration for ad sizes and settings via window.monetumoRemoteSettings:

window.monetumoRemoteSettings = {
  slotSizes: {
    "banner_top": {
      "xs": [[320, 50]],
      "sm": [[728, 90]],
      "lg": [[970, 250]]
    }
  },
  tealPlacementPrefix: "your-prefix-"
};

Prerequisites

Ensure that Google Publisher Tags (GPT) and Prebid.js are loaded in your application before using this component. These should typically be loaded in your application's head section.

TypeScript Support

The component includes full TypeScript definitions. Import types as needed:

import { MonetumoAdSlot } from '@monetumo/react-ad-component';

type AdSize = [number, number];

interface MyAdProps {
  adUnit: string;
  customSizes?: AdSize[];
}

Development

# Install dependencies
npm install

# Start development server
npm run dev

# Build for production
npm run build

# Publish to npm
npm publish

License

MIT

0.1.18

6 months ago

0.1.16

6 months ago

0.1.15

6 months ago

0.1.14

6 months ago

0.1.13

6 months ago

0.1.11

6 months ago

0.1.10

6 months ago

0.1.9

6 months ago

0.1.8

6 months ago

0.1.7

6 months ago

0.1.6

7 months ago

0.1.5

7 months ago

0.1.4

7 months ago

0.1.3

7 months ago

0.1.2

7 months ago

0.1.1

7 months ago

0.1.0

7 months ago