{"id":15692436,"url":"https://github.com/javierarce/figma-extractor","last_synced_at":"2025-10-30T07:18:24.351Z","repository":{"id":57235301,"uuid":"266495439","full_name":"javierarce/figma-extractor","owner":"javierarce","description":"Export all the frames of a Figma file","archived":false,"fork":false,"pushed_at":"2025-03-07T17:33:03.000Z","size":81,"stargazers_count":7,"open_issues_count":4,"forks_count":0,"subscribers_count":2,"default_branch":"master","last_synced_at":"2025-04-12T17:06:23.030Z","etag":null,"topics":["export","figma","figma-api","figma-export","node","node-module","npm-package"],"latest_commit_sha":null,"homepage":null,"language":"JavaScript","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/javierarce.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null}},"created_at":"2020-05-24T07:58:20.000Z","updated_at":"2024-12-11T09:07:01.000Z","dependencies_parsed_at":"2024-10-24T00:13:52.033Z","dependency_job_id":"d20dbb99-4f17-4dde-b0bb-29ac65a9ef00","html_url":"https://github.com/javierarce/figma-extractor","commit_stats":{"total_commits":42,"total_committers":1,"mean_commits":42.0,"dds":0.0,"last_synced_commit":"0172d318dfd4bd8f6c38ea896f15b3c5e7cfb983"},"previous_names":[],"tags_count":6,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/javierarce%2Ffigma-extractor","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/javierarce%2Ffigma-extractor/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/javierarce%2Ffigma-extractor/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/javierarce%2Ffigma-extractor/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/javierarce","download_url":"https://codeload.github.com/javierarce/figma-extractor/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":252989670,"owners_count":21836662,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["export","figma","figma-api","figma-export","node","node-module","npm-package"],"created_at":"2024-10-03T18:33:16.329Z","updated_at":"2025-10-30T07:18:24.297Z","avatar_url":"https://github.com/javierarce.png","language":"JavaScript","funding_links":[],"categories":[],"sub_categories":[],"readme":"# figma-extractor\n\nNode package that exports  all the frames of a Figma file to different files.\n\n\n## Installation\n\n  `yarn add figma-extractor`\n\n  or\n\n  `npm install figma-extractor`\n\n## How to use it\n\n```js\nconst Extractor = require('figma-extractor')\n\nlet extractor = new Extractor(FIGMA_TOKEN, FIGMA_FILE)\n\nextractor.extract().then((files) =\u003e {\n  console.log(files) \n}).catch((e) =\u003e {\n  console.error(e)\n})\n```\n\n### Result\n\nBy default Figma Extractor will export SVG files to the current directory. The `extract` command will return the list of exported files in this format:\n\n```js\n[\n  { \"filename\": \"Frame 1.svg\", \"page_id\": \"4:3\", \"page\":\"Page 1\" },\n  { \"filename\": \"Frame 2.svg\", \"page_id\": \"4:3\", \"page\":\"Page 1\" }, \n  { \"filename\": \"Frame 3.svg\", \"page_id\": \"4:3\", \"page\":\"Page 1\" }, \n  { \"filename\": \"Frame 4.svg\", \"page_id\": \"8:4\", \"page\":\"Page 2\" }\n]\n```\n\n## Customizing the export\n\n```js\nconst Extractor = require('figma-extractor')\n\nlet options = { \n  format: 'svg',                // file type (from the Figma API)\n  svg_include_id: true,         // from the Figma API\n  pageID: '123:0',              // specify a page\n  append_frame_id: true,        // appends the frame id to the filename\n  append_page_name: true,       // appends the page name to the filename\n  use_pages_as_folders: true,   // create subdirectories with the name of the page\n  dont_overwrite: true,         // don't overwrite existing files with the same name\n  get_background_color: false,  // get the background color of the page in hexidecimal format\n  get_comments: true            // get unresolved comments\n}\n\nconst extractor = new Extractor(FIGMA_TOKEN, FIGMA_FILE, OPTIONS)\n\nextractor.extract(IMAGE_PATH).then((files) =\u003e {\n  console.log(files)\n})\n\nlet destination = 'my_beautiful_designs'\n\nlet extractor = new Extractor(FIGMA_TOKEN, FIGMA_FILE, options)\n\nextractor.extract(destination).then((files) =\u003e {\n  console.log(files) \n}).catch((e) =\u003e {\n  console.error(e)\n})\n```\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fjavierarce%2Ffigma-extractor","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fjavierarce%2Ffigma-extractor","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fjavierarce%2Ffigma-extractor/lists"}