Stash UI plugin template

Plugins Plugin Development
1

I’ve created a GitHub repository template for creating new UI plugins. It includes some simple demo code that new plugin developers may find useful, and this is easy enough to remove or update to your requirements. Scripts for creating development and production bundles are also included.

The template is built with the Stash plugin API in mind, but it’s not a requirement if you don’t want to use it.

Installation

  1. In the repo, click the green Use this template button on the right-hand side of the page.
  2. Click Create a new repository, and fill out the form as usual when creating a new repo.
  3. Clone the newly created repo to your computer.
  4. Check the readme for starter instructions.
  5. Get coding!

Stack

  • TypeScript
    • The repo includes a stashGQL.d.ts types definition file generated from Stash. These may be outdated depending on when I last generated them, but you can generate new ones using my developer tools repo.
    • The repo also includes a stashPlugin.d.ts types definition file. These are manually written type definitions relating primarily to the plugin API. I’ve only defined the types I’ve used, so they are far from exhaustive. If you find any errors or have any additions, please raise an issue on the template repository.
  • React (optional but recommended)
  • SCSS
  • Webpack (for compiling Typescript)
1 Like