Skip to content

Latest commit

 

History

History
104 lines (60 loc) · 4.4 KB

README.md

File metadata and controls

104 lines (60 loc) · 4.4 KB

FigJenda

This FigJam widget allow you to create an agenda or multiple agendas for your workshop in FigJam. The widget uses FigJam's built in timer to provide a more robust experience.

🏁 Start here

🧪 I am a Beta tester 💻 I am a developer

CleanShot 2021-11-29 at 18 19 56@2x

Beta testing FigJenda

Follow the instructions below to get FigJenda running in just 4 steps! 🚀

🗃 Download the ZIP file containing the codebase by clicking here

🔍 Unzip the file wherever is convenient, but you'll need to know where it is to load it into FigJam

✨ Create a new FigJam file and right click anywhere on the canvas. Select Widgets > Development > Import widget from manifest...

CleanShot 2021-11-29 at 18 38 09@2x


🔍 Head to the folder you unzipped and select the manifest.json file

CleanShot 2021-11-29 at 19 15 18@2x


🚀 You're ready to try FigJenda! Just right click on the canvas to add it from your Widgets > Development > FigJenda!

CleanShot 2021-11-29 at 18 53 24@2x


⚡️ From here on out you can just copy paste it around to create as many agendas as you want!

CleanShot 2021-11-29 at 18 56 09@2x


Known bugs:

🐛 The numer inputs in the Add/Edit plugins are a UX nightmare and can feel pretty buggy. You can highlight and delete the number if things get ugly 😩

CleanShot 2021-11-29 at 18 57 32@2x


🪲 The widget can't listen to FigJam's built-in timer so it will get stuck when it ends. Just press next ⏭ to load the next agenda item, or stop ⏹ on the widget to reset it!!!

CleanShot 2021-11-29 at 19 02 50


⚠️ The rest of this readme is a work in progress

Developers

Code organization:

dir / path description
ui-src/ This is where the iframe code lives
ui-src/index.html Main entry point for the iframe code
widget-src/code.jsx This is the widget code
dist/ Built output goes here
  • The iframe code uses a tool called vite to bundle everything into a single html file

importing your widget

  1. "Import widget from manifest"
  2. Build code npm run build
  3. Choose your manifest

iframe development

Often the code in the iframe can get pretty complex, if helpful, you can also do

npm run dev:ui
  • This command starts a development server that will serve the iframe code at http://localhost:3000
  • The development server will also hot reload any changes to your iframe code

Scripts

script description
npm run build:watch watch-move build for both the widget and iframe code. Use this while in dev
npm run build one-off full build of both the iframe and widget
npm run build:main one-off build of the widget code
npm run build:ui one-off build of the iframe code
npm run build:main:watch watch-mode build of the widget code. rebuilds if when you save changes.
npm run build:ui:watch watch-mode build of the iframe code. rebuilds if when you save changes.