@poductivity/poductivity-sdk-js
TypeScript icon, indicating that this package has built-in type declarations

0.11.0 • Public • Published

Poductivity SDK - JavaScript

Tests

Installation

Simple: From CDN

Include the below script tags in the <head> section of your web page. The HTML tags <poductivity-player> and <poductivity-client> will be instantly ready to use in your application.

<script type="module" src="https://cdn.jsdelivr.net/npm/@poductivity/poductivity-sdk-js@0/dist/poductivity-sdk-js/poductivity-sdk-js.esm.js"></script>
<script nomodule src="https://cdn.jsdelivr.net/npm/@poductivity/poductivity-sdk-js@0/dist/poductivity-sdk-js/poductivity-sdk-js.js"></script>

Advanced: From npm

Install via NPM:

npm install --save @poductivity/poductivity-sdk-js

Apply polyfills as necessary and register the custom elements: (The call to applyPolyfills is optional)

import { applyPolyfills, defineCustomElements } from '@poductivity/poductivity-sdk-js/loader';
applyPolyfills().then(() => {
  defineCustomElements();
});

If using a framework such as Angular/React/Vue, you may have to register the components with the framework. Please see here for details.


Usage

Poductivity Embed Player

A HTML embeddable podcast player with Poductivity interaction. Read documentation

Poductivity Client

Add Poductivity interaction to your own podcast player. Read documentation


Development

  • Run npm install
  • Run npm start - default host is at localhost:3333
  • Run tests with npm run test or npm test.watch
  • Run linter with npm run lint

Releasing

  • Increment the version with npm version patch|minor|major
  • Run npm publish. If lint or tests fail, will not publish.

Package Sidebar

Install

npm i @poductivity/poductivity-sdk-js

Weekly Downloads

481

Version

0.11.0

License

SEE LICENSE IN LICENSE

Unpacked Size

1.59 MB

Total Files

140

Last publish

Collaborators

  • poductivityltd
  • edtownend