Giter Club home page Giter Club logo

figma-vue-boilerplate's Introduction

figma-vue-boilerplate

Features:

Vue components implemented on figma-plugin-ds styles.

RPC

Connect to UI from Plugin side:

uiApi = await connectToUI<PluginMethods, UIMethods>(figma, {
    createRectangle(width, height) {
        const rect = figma.createRectangle();
        rect.resize(width, height);
        figma.currentPage.appendChild(rect);
        return rect.id;
    },

    // ...
});

Connect to Plugin from UI and invoke createRectangle:

api = proxyMapRemote(
    await connectToPlugin<PluginMethods, UIMethods>({})
);

createdNodeId = await api.createRectangle(100, 50);

api.listenSelectionChange((selectedIds: string[]) => {
    console.warn('selection change', selectedIds);
});

RPC is fully typed.

How to use?

  1. Clone this repo
  2. Save plugin's manifest to /plugin-public
  3. Set plugin directory in figma to /dist
  4. Run npm run build to rebuild plugin

Write UI code in /ui-src
Write Plugin code in /plugin-src

How to use RPC?

  1. Specify your protocol in /plugin-src/iapi.d.ts file
  2. Implement it in /plugin-src/index.ts & /ui-src/App.vue

Learn more about RPC (you can pass callbacks as args!)

Attention

Do not use libraries depends on pollyfils such as 'core-js' (pug templates too), because Figma's plugin environment doesnt support global pollyfils used in 'core-js'.

figma-vue-boilerplate's People

Contributors

morglod avatar

Watchers

 avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.