https://github.com/iziuqo/figma-nodes
Community-driven documentation of Figma's internal JSON format for clipboard, plugins, and design automation
https://github.com/iziuqo/figma-nodes
clipboard community design-automation design-tools documentation figma figma-api json plugin-development reverse-engineering
Last synced: about 1 month ago
JSON representation
Community-driven documentation of Figma's internal JSON format for clipboard, plugins, and design automation
- Host: GitHub
- URL: https://github.com/iziuqo/figma-nodes
- Owner: iziuqo
- License: mit
- Created: 2025-05-29T20:40:54.000Z (about 1 year ago)
- Default Branch: main
- Last Pushed: 2025-05-29T23:38:07.000Z (about 1 year ago)
- Last Synced: 2025-06-06T12:06:33.690Z (about 1 year ago)
- Topics: clipboard, community, design-automation, design-tools, documentation, figma, figma-api, json, plugin-development, reverse-engineering
- Language: Shell
- Homepage: https://figma-nodes.vercel.app
- Size: 25.4 KB
- Stars: 0
- Watchers: 0
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- Contributing: CONTRIBUTING.md
- License: LICENSE
Awesome Lists containing this project
README
# Figma Internal JSON Format Documentation
> **๐ Community-driven documentation of Figma's internal node JSON structure**
[](https://github.com/iziuqo/figma-nodes)
[](https://opensource.org/licenses/MIT)
[](http://makeapullrequest.com)
## ๐ฏ What is this?
This repository contains comprehensive documentation of Figma's internal JSON format used for:
- **Clipboard operations** (`application/x-figma-design` MIME type)
- **Plugin API interactions**
- **Design automation and tooling**
- **Cross-platform design data exchange**
## ๐ Documentation
- **[Complete Format Guide](docs/format-guide.md)** - Comprehensive documentation of all node types and properties
- **[Quick Reference](docs/quick-reference.md)** - Cheat sheet for common properties
- **[Plugin Examples](examples/plugins/)** - Working plugin code examples
- **[JSON Samples](examples/json/)** - Real-world JSON structure examples
## ๐ Quick Start
### For Plugin Developers
```javascript
// Read node properties
const node = figma.currentPage.selection[0];
console.log({
type: node.type,
name: node.name,
dimensions: { width: node.width, height: node.height },
position: { x: node.x, y: node.y }
});
```
### For Clipboard Analysis
```javascript
// In browser console (Figma web)
navigator.clipboard.readText().then(text => {
if (text.includes('application/x-figma-design')) {
const data = JSON.parse(text);
console.log('Figma nodes:', data);
}
});
```
## ๐ค Contributing
We welcome contributions! See [CONTRIBUTING.md](CONTRIBUTING.md) for guidelines.
**Ways to contribute:**
- ๐ **Documentation** - Improve existing docs or add missing sections
- ๐ **Discovery** - Find and document new properties or node types
- ๐ก **Examples** - Add real-world JSON samples or plugin code
- ๐งช **Testing** - Create test cases for different scenarios
## โ ๏ธ Important Notes
- **Unofficial Documentation** - This is community research, not official Figma docs
- **Format Changes** - Figma's internal format may change without notice
- **Use at Own Risk** - Always test thoroughly in production environments
## ๐ License
This project is licensed under the MIT License - see the [LICENSE](LICENSE) file for details.
## ๐ Motivation
This project was created by [izaias](http://izaias.vercel.app) while trying to understand **Google Stitch's Copy to Figma** feature.
---
**๐ก Found this useful?** Give it a star โญ and share with other Figma developers!