Huge News!Announcing our $40M Series B led by Abstract Ventures.Learn More
Socket
Sign inDemoInstall
Socket

framer-plugin

Package Overview
Dependencies
Maintainers
2
Versions
37
Alerts
File Explorer

Advanced tools

Socket logo

Install Socket

Detect and block malicious and high-risk dependencies

Install

framer-plugin - npm Package Compare versions

Comparing version 0.1.0 to 0.1.1

2

package.json
{
"name": "framer-plugin",
"version": "0.1.0",
"version": "0.1.1",
"type": "module",

@@ -5,0 +5,0 @@ "main": "src/index.ts",

@@ -1,41 +0,5 @@

# Framer Plugin API
# Framer Plugins
## Quickstart
coming soon.
Getting started with building a plugin: https://github.com/framer/plugin
```
git clone git@github.com: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](https://features-plugin.beta.framer.com/projects/) 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](https://www.notion.so/framer/Plugin-Documentation-f0b858563f2c46259906216fe42abfd7)
- 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](https://github.com/framer/FramerStudio/tree/features/plugin/src/plugin-api). 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](https://github.com/framer/plugins) 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](https://github.com/framer/plugin) repo.
## Local development for existing plugins
1. You can add a resolution in the [Plugins examples](https://github.com/framer/plugins) repo to your FramerStudio src directory.
```
"resolutions": {
"@framerjs/framer-plugin-api": "file:../FramerStudio/src/plugin-api"
},
```
Follow us on [X](https://twitter.com/framer) for updates.
SocketSocket SOC 2 Logo

Product

  • Package Alerts
  • Integrations
  • Docs
  • Pricing
  • FAQ
  • Roadmap
  • Changelog

Packages

npm

Stay in touch

Get open source security insights delivered straight into your inbox.


  • Terms
  • Privacy
  • Security

Made with ⚡️ by Socket Inc