Git Product home page Git Product logo

nitropay's Introduction

Nuxt Nitropay

npm version npm downloads License Nuxt

A Nitropay Ads module for nuxt

Features

  • ✨   One stop shop for setting up Nitropay on your site
  • 📦   NitroAd.vue component
  • 📦   useNitropay composable

Quick Setup

Install the module to your Nuxt application with one command:

npx nuxi module add nuxt-nitropay
// nuxt.config.ts

{
  modules: ['nuxt-nitropay'],

  nitropay: {
    siteId: '####'
    test: true, // optional, default=true in dev mode

  }
}

That's it! You can now use Nitropay ads in your Nuxt app ✨

Usage

  • NitroAd.vue component accepts a prop config. Config must have a unique ad id and optionally include any of nitropay's ad configuration options.

  • The ad will load & refresh automatically. To trigger manually, the component exposes the refreshAd & loadAd functions with defineExpose.

<template>
  <div>
    <NitroAd :config="{
        id: 'home-leaderboard',
        refreshTime: 30,
        renderVisibleOnly: false,
        demo: true,
        sizes: [
          [
            '970',
            '90',
          ],
        ],
        report: {
          enabled: true,
          icon: true,
          wording: 'Report Ad',
          position: 'top-right',
        },
      }" />
  </div>
</template>
  • Under the hood, the component uses the useNitropay composable. You can use the composable to create your own component.

Contribution

Local development
# Install dependencies
npm install

# Generate type stubs
npm run dev:prepare

# Develop with the playground
npm run dev

# Build the playground
npm run dev:build

# Run ESLint
npm run lint

# Run Vitest
npm run test
npm run test:watch

# Release new version
npm run release

nitropay's People

Contributors

kylegl avatar

Watchers

 avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    🖖 Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. 📊📈🎉

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google ❤️ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.