Nierusan / figma-api-plugin-starter

A starter kit for creating a Figma Plugin with an API to search for products and insert data into a Figma component.

Figma API Plugin Starter

Introduction

A starter kit for creating a Figma Plugin with an API to search for products and insert data into a Figma component. This starter is based on the boilerplate Figsvelte. For this starter, I used the API of boardgameatlas.com, but you can use whatever API you want.

To get started

cd figma-api-plugin-starter
npm install

Note that you will need to have Node.js installed.

Connecting your plugin to Figma

Connecting your plugin to Figma After installing, go to Plugins / Development / New Plugin in the Figma desktop app for Mac OS or Windows and choose the option "Link existing plugin".

You also can just type "New Plugin" in Figma global search to go there

From there you need to link a manifest.json file located at public folder in your directory:

/figma-api-plugin-starter/public/manifest.json

Now edit this file to give a new name for your plugin, and you will be able call it from Figma: Plugins / Development / Your Plugin Name

Development

During development, watch your project for changes with the following command.

npm run dev

Start building your plugin UI in 'src/PluginUI.svelte'.

To use the Boardgameatlas API you have to create your own client_id here: https://www.boardgameatlas.com/api/docs/apps

Build

When ready to package up your final Figma Plugin:

npm run build

Useful info

To include an external CSS file:

import styles from "./styles.css";

To include an SVG:

import SvgName from './image.svg';

//use in your markup
{@html SvgName}

For more info on using the Icon component system with SVGs from Figma Plugin DS Svelte, refer to the repo.

For info about Figma API visit Figma API Overview