Motif API

API used to build Motif extensions

Note that this npm package is configured to use PowerShell shell.

API Documentation

Use this documentation to understand how to build a Motif Extension using this Motif API:

https://plxtra.org/motif-api/Overview/

Install

npm i @plxtra/motif-api
Copy

Build API

This generates the API documentation directly from the Motif repository. This is useful if you are using Motif to debug an extension and want to ensure that the Motif API exactly matches the Motif being used to debug the extension.

1. Install the Plxtra motif repository and this motif-api repository in the same folder.
2. Set the version in this @plxtra/motif-api package so that it matches the @plxtra/motif (Motif) package version.
3. Run the dist script in this @plxtra/motif-api package:

   npm run dist
   Copy

Publish API

1. Build the API:
2. Review files to be published with:

   npm pack
   Copy

3. Publish to npm

   npm publish
   Copy

Build API documentation

1. Install the following Plxtra repositories in the same folder:
   • @plxtra/motif-api
   • motif
   • TsDemo Motif Extension
   • Website embed Motif Extension
   • Highcharts Extension
2. Build the API:
3. Run the docs:build script in this @plxtra/motif-api repository:

   npm run docs:build
   Copy

View the built API documentation

1. Build the API documentation
2. Run the docs:serve script in this @plxtra/motif-api repository:

   npm run docs:serve
   Copy