@ynput/ayon-react-addon-provider
TypeScript icon, indicating that this package has built-in type declarations

0.1.1 • Public • Published

Ayon React Addon Provider

A React component that streamlines the development of frontend features for Ayon addons in React.

It simplifies basic styling and dependencies, establishes a connection to the parent app via a simple context manager, and allows for a stand-alone mode for use with a development server.

Addon development

Use .env file to provide necessary variables normally passed to the addon using window.onmessage:

Addon

SERVER_URL="http://localhost:5000"
VITE_ADDON_NAME="test"
VITE_ADDON_VERSION="0.0.1"
VITE_ADDON_SCOPE="project"
VITE_PROJECT_NAME="demo_Commercial"

When

TODO

  • Addon itself should define, in which scope it can run.
  • Project should be selectable from the standalone mode toolbar.

Preparing for production

Addon frontend must use relative paths to its static dependencies. In case of vite, add base: '' to your vite.config.js.

Readme

Keywords

none

Package Sidebar

Install

npm i @ynput/ayon-react-addon-provider

Weekly Downloads

2

Version

0.1.1

License

none

Unpacked Size

123 kB

Total Files

11

Last publish

Collaborators

  • martastain
  • mkolar
  • ynput_admin