Skip to content

jalonsogo/figma-crane

Repository files navigation

Crane - Figma Page Scaffolding Plugin

Version: 1.1.0

Crane is a powerful Figma plugin designed to streamline your design workflow by automatically creating structured page layouts for your projects. Whether you're starting a new design project or organizing an existing one, Crane helps you maintain consistency and save time.

🚀 Features

📋 Scaffold Tab

  • Quick Page Creation: Generate multiple pages with emoji icons and custom labels
  • Smart Detection: Automatically detects existing pages to prevent duplicates
  • Selective Creation: Choose which pages to create with individual checkboxes
  • Visual Preview: See exactly what pages will be created before scaffolding

⚙️ Settings Tab

  • Custom Layout Editor: Fully customizable page structure with drag-and-drop reordering
  • Emoji Picker: Modern emoji selector with search and category filtering
  • Page Management: Add, duplicate, delete, and modify pages and separators
  • Live Preview: Changes reflect immediately in the scaffold tab
  • Auto-Insert Cover Component: Automatically add a library component to the Cover page when scaffolding

📤 Import/Export Tab

  • URL Import: Import layouts from remote JSON files
  • File Import: Import layouts from local JSON files
  • JSON Export: View and copy layout configurations
  • Download Export: Save layouts as JSON files for sharing or backup

🎯 Default Layout Structure

Crane comes with a thoughtfully designed default layout perfect for design projects:

  • 🚧 Task or feature name - Project overview page
  • 🧩 Components - Design system components
  • 📐 Specs - Technical specifications
  • 🧠 Moodboard - Visual inspiration
  • 💡 Ideas - Brainstorming and concepts
  • ☣️ Discarded - Archived ideas
  • 📄 Cover - Project presentation

🛠️ How to Use

  1. Open the Plugin: Go to Plugins → Crane in your Figma file
  2. Choose Pages: In the Scaffold tab, select which pages you want to create
  3. Create: Click the "Create" button to generate your page structure
  4. Customize: Use the Settings tab to modify the layout for future projects
  5. Share: Export your custom layouts to share with your team

📊 Advanced Features

Auto-Insert Cover Component

Automatically add a component from your published library to the Cover page every time you scaffold. This is perfect for maintaining consistent cover designs across all your Figma files.

One-time setup:

  1. Open your library file that contains the cover component
  2. Select the component on the canvas
  3. Run Crane plugin → go to Settings tab
  4. Toggle ON "Enable auto-insert on Cover page"
  5. Click "Get from Selection" - the component key will be captured and verified
  6. Click Save

Usage:

Once configured, every time you run the scaffold (in any Figma file), the cover component will automatically be inserted on the Cover page at position (0, 0).

  • Settings are saved globally across all Figma files
  • Works whether the Cover page is newly created or already exists
  • The component must be from a published library

Drag & Drop Reordering

Easily reorganize your page structure by dragging items in the Settings tab.

Context Menu

Right-click any item in the Settings tab to:

  • Duplicate items
  • Delete unwanted pages

Emoji Categories

The emoji picker includes organized categories:

  • 😀 Faces & People
  • 🐶 Animals & Nature
  • 🍏 Food & Drink
  • ⚽ Activities & Sports
  • 🚗 Travel & Places
  • ⌚ Objects & Symbols

Import/Export Formats

Layouts are saved in a simple JSON format:

[
  {
    "emoji": "🚧",
    "label": "Task or feature name",
    "type": "page"
  },
  {
    "emoji": "",
    "label": "─────────────",
    "type": "separator"
  }
]

🎨 Benefits

  • Consistency: Maintain uniform project structure across teams
  • Efficiency: Save time setting up new projects
  • Organization: Keep your Figma files well-structured
  • Flexibility: Customize layouts for different project types
  • Collaboration: Share standardized layouts with your team

🔧 Technical Details

  • API Version: Figma Plugin API 1.0.0
  • UI Framework: HTML/CSS/JavaScript
  • Storage: Plugin data persistence for custom layouts
  • Compatibility: Works with all Figma plans

📝 License

This plugin is provided as-is for design workflow enhancement.

LOLcense

For {root} sake I'm a designer. Mostly all the code has been written by Claude and ad latere.

About

Docker Crane - Utility plugin for Figma

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

 
 
 

Contributors