slawomirkolodziej/figma-api-exporter

Export assets from Figma API, sync your SVG files.

Figma API Exporter

Allows you to export assets from Figma files automatically and use it in your project.

Features:

• download all components as SVGs from Figma file or Frame

Examples

const figmaApiExporter = require('figma-api-exporter').default;

const exporter = figmaApiExporter(YOUR_FIGMA_API_TOKEN);

exporter
  .getSvgs({
    fileId: YOUR_FIGMA_FILE_ID,
    canvas: 'Icons',
  })
  .then(svgsData =>
    exporter.downloadSvgs({
      saveDirectory: './svgsFiles',
      svgsData: svgsData.svgs,
      lastModified: svgsData.lastModified,
    })
  );

API

getSvgs

Function which fetches urls of component exports as svgs.

Arguments:

• fileId (required) (string) - id of figma files you want to extract svgs from
• canvas (optional) (string|function) - filter exported components by Page name, you can use a custom filter function with additional information about page
• component (optional) (string|function) - filter by exported components by Component name, you can use a custom filter function with additional information about component

downloadSvgs

Function which downloads svg files to your directory. It checks Figma File modification date and component ids to find out if your local copy is up to date before downloading everything. You can replace this function with your own script.

Arguments:

• saveDirectory (required) (string) - path to save svg files
• svgsData (required) (array) - '.svgs' values returned from .getSvgs()
• lastModified (required) (string) - .lastModified value returned from .getSvgs(), used to check if Figma file was modified and it should continue downloading
• clearDirectory (optional) (boolean) (defaults to: false) - change to true if you want to clear the saveDirectory before downloading files, it comes handy when you want to delete old icons, which don't exist in Figma anymore

figma-api-exporter's Issues

[Request] License Clarification

Hey, thanks for the great library! I started playing around with it for an icon exporter I'm working on at @brave but I just realised you don't have a license on the project.

I was wondering if you'd be able to add an open source one?

(also, I have a PR for batching (#4), if you're accepting contributions)

FWIW, most of the stuff at Brave is using the MIT or Mozilla Public License

Breaking changes between 0.0.2 and 1.0.0?

Hi there,

I have your package via some Storybook dependencies, and they rely on 0.0.2. I'm wondering if the API changed at all when you bumped the package to 1.0.0, because 0.0.2 uses an old axios version that dependabot is complaining about.

it looks like you updated packages in 1.0.0 but other projects haven't updated to that yet.

It'd be good for me (and also those other packages) to know if anything interesting changed between the two versions!

thanks

update package

Hello,
Your package is used in storybook, congrats !
Could you please update your npm registry with the latest version (lots of update of dependancies, including a big bump of axios deps)
Thank you :)