@agnoplay/vue

Introduction

This package provides a vue component to render a Agnoplay player in any vue project. This package makes the assumption that the window.AGNO object is available to be consumed. This can be done by adding the following script tag to the page:

<script crossorigin="anonymous" src="https://player.agnoplay.com/static/agnoplay/js/agnoplay.js"></script>

Development

Package development

In the /dev folder, there are files to setup a small local dev environment. To get started, run npm run serve.

External projects

You can import the vue component like so:

import { Agnoplay } from '@agnoplay/vue';

Don't forget to register the component:

{
    components: { Agnoplay }, 
}

You can now use the component in your template:

<template>
    <Agnoplay
        id="very-unique-id"
        brand="agnoplay"
        video-id="Mbdskc9KsAii"
        :options="{ ...options }"
    /> 
</template>

For a complete list of options, see the src/types/BaseParams.d.ts file, or refer to your Agnoplay control panel.

Deployment

To build the component, simply run npm run build

Publish to npm

1. Make sure you've build your new version and you are signed into an npm account linked to the Agnoplay organisation.
2. Update the version number in package.json.
3. Run npm publish to publish the new version to npm.