ignite-payload-plugin

Ignite Video Cloud plugin for Payload CMS. This plugin provides a ready to use field for Payload CMS, to fetch video data from Ignite Video Cloud.

Installation

npm install ignite-payload-plugin

yarn add ignite-payload-plugin

Payload Integration

Import and insert the field component

import { igniteVideoSelect } from 'ignite-payload-plugin'

const Pages: CollectionConfig = {
 slug: 'pages',
 fields: [
   {
     ...other fields...
   },
   igniteVideoSelect({
     name: '[FIELD-NAME]',
     token: '[YOUR-IGNITE-API-TOKEN]',
     apiUrl: 'https://app.ignitevideo.cloud',
   }),
   {
     ...other fields...
   },
 ],
}

Properties / paramenters

name (string)

the name of your video field in payload

token (string)

your Ignite Video Cloud API access token. Can be found under "API Integrations" in your Ignite admin UI

apiUrl (string)

your Ignite Video Cloud API URL. For all account, except for enterprise accounts this is https://app.ignitevideo.cloud

show ('public' | 'private' | 'all')

(optional) Defines the visibility status of the videos to show in the selection (Default: "public")

label (string)

(optional) Overwrites the default field label (Default: "Select video")

required (boolean)

(optional) Sets payload default field required attribute. (Default: false)

categories (string[])

(optional) Can be set to query the API for specific categories only. Categories provided in this array have an OR relationship.

tags (string[])

(optional) Can be set to query the API for specific tags only. Tags provided in this array have an OR relationship.

Example

igniteVideoSelect({
  name: 'hoverVideo',
  token: '[YOUR-IGNITE-API-TOKEN]',
  apiUrl: 'https://app.ignitevideo.cloud',
  label: 'Choose the hover video',
  required: true,
  categories: ['website', 'app'],
  tags: ['loops', 'muted']
})