framer-plugin

Framer Plugin API

Quickstart

Getting started with building a plugin: https://github.com/framer/plugin

git clone [e-mail]:framer/plugin.git; cd plugin; yarn; yarn run dev

This is a template for using the Framer Plugin API in a TypeScript project.

• You need a special branch of Framer to use this library: features/plugin.
• You can run the plugin in a local server by running yarn dev. It might ask you for a password so it can make https work using mkcert.
• You can load the plugin in Framer by clicking Plugins in the toolbar and entering the local URL of the plugin (like https://localhost:5173).

Notes

• This is a work in progress. The API is not stable yet.
• You can follow the work here on Notion
• The API lives in the template for now, but will be moved to a separate package in the future.
• framer/plugin is a mirror of the main repository. If it's out of date, please run make publish to update it.

Publishing API changes to existing packages

1. Run make publish-examples BRANCH="your-branch-name" to publish new API package to all plugins in the Plugins examples repo.
2. Run yarn typecheck in the plugins repo to detect breaking changes

Publishing API changes to template

1. Run `make publish BRANCH="branch_name" to publish latest changes to Plugins repo.

Local development for existing plugins

1. You can add a resolution in the Plugins examples repo to your FramerStudio src directory.

"resolutions": {
    "@framerjs/framer-plugin-api": "file:../FramerStudio/src/plugin-api"
},