PhiJS Φ

PhiJS - The Figma API Javascript Wrapper

Installation

$ npm i --save phi-js

$ yarn add phi-js

This library depends on fetch to make requests to the Figma API. For environments that don't support fetch, you'll need to provide a polyfill.

To create a single PhiJS instance, you'll need to an object with your key and secret.

// Import syntax
import PhiJS from 'phi-js'

// Using require syntax
const PhiJS = require('phi-js');

const phi = PhiJS(YOUR_ACCESS_TOKEN);

That's it! Now you can play with your Figma Documents.

TODO: Improve file doc.

Returns the document refered to as a JSON object. The file key can be parsed from any Figma file url: https://www.figma.com/file/:key/

phi.file(FILE_URL)
  .then(json => {
    // Your code
  });

TODO: Improve team projects doc

TODO: Improve project files doc

MIT License, for more info check LICENSE file.