Skip to main content

Figma

Smart Importer can import Figma data. This page explains how to to import Figma data with Smart Importer and how to work with the results. 

Please note that you cannot import Figma data for which you do not have editing privileges.


Preparations for Importing Figma Data

Software Environment

The following software is needed in order to perform Figma data imports with Smart Importer:

 Node.js (Supported versions: Only 18.x.x and 19.x.x)

Preparing the URL/Access Token

In order to perform Figma data imports with Smart Importer, a URL and Access Token that corresponds with the Figma Data needs to be acquired in advance. 

The URL and Access Token can be acquired using the Figma desktop application as below.

Please ensure you have access to the Figma REST API (https://api.figma.com). In case of connectivity issue, please contact your IT as it might be blocked by a firewall.

Acquiring the URL

At the topmost bar in the Figma desktop application, right-click the relevant project tab and from the context menu select [Copy  Link]. 

drawing-7-1740621465.pngdrawing-7-1740621465.png
Acquiring the Access Token
  1. In the Figma desktop app, select [ Figma Icon > Help and Account > Account Settings ] to open the dialog.
    drawing-7-1740621587.pngdrawing-7-1740621587.png

  2. In the Security tab of the dialog, click [ Generate new token ] under Personal access tokens.
    drawing-7-1740621955.pngdrawing-7-1740621955.png

  3. In the "Generate new token" dialog, set the Token name, Expiration, and Scopes, and then click [ Generate token ].
    drawing-7-1768380041.pngdrawing-7-1768380041.png

  4. The created access token will be displayed under Personal access tokens on the Security tab of the dialog.
    drawing-7-1740622348.pngdrawing-7-1740622348.png

The instructions on how to obtain the URL and access token are for Figma Desktop App version 125.10.8.


How to Import Figma Data

1. From the Scene Composer toolbar select [Import] > [Smart Importer] > [From Cloud Resource...], and a new dialog panel titled [Import from cloud resource] will be displayed. 

drawing-7-1729497030.pngdrawing-7-1729497030.png

2. Enter the URL and Access Token in the respective fields and click [OK]. Please refer to「Preparing the URL/Access Token」 for acquiring the URL and Access Token. 

drawing-7-1729496909.pngdrawing-7-1729496909.png

3. The Smart Importer dialog panel will open. Operating Smart Importer here is no different to when importing other filetypes. For details, please see 「3. Scene Composer > Import of Resources > Smart Importer > How to Use the Smart Importer」. After making the necessary setting adjustments and clicking [OK], the data will be imported into the folder designated in [Import to folder: ].

drawing-7-1729497265.pngdrawing-7-1729497265.png

If the URL or Access Token entered in the "Import from cloud resource" dialog is incorrect (or inappropriate), the import will be interrupted, and the following error dialog will appear.

drawing-7-1764920266.pngdrawing-7-1764920266.png

API access limits vary depending on your subscription plan. Therefore, if that limit is exceeded, the import will be interrupted and the following error dialog will be displayed. Please check Figma’s official website for details on each plan.

drawing-7-1764920285.pngdrawing-7-1764920285.png

Importing Figma Data - Advanced

Importing as a scene

The topmost item of each page included in the Figma data will be imported into Smart Importer as a scene. For this, use the following naming convention: <Page name>_<Parent item name>

drawing-7-1729498578.pngdrawing-7-1729498578.png

Relationship between Figma items and Scene Composer Nodes 

When importing Figma items with Smart Importer, each item will be imported as a specific type of node, as seen in the table below.


Scene Composer node type
Group Bitmap Text
Figma item type
Component ✓

ComponentSet ✓

Ellipse
✓
Frame ✓

Group ✓

Instance ✓

Line
✓
Polygon
✓
Rectangle
✓
Section ✓

Slice
✓
Star
✓
Text

✓
Vector
✓

Bitmaps and texts can only be imported when their render data is made available. For example, should a Figma item be set to "hidden", it cannot be imported. 

Importing as Controls or Bitmaps

It is possible with Smart Importer to import as a control or bitmap any Figma items that can hold the following child items:

  • Component
  • ComponentSet
  • Frame
  • Group
  • Instance
  • Section
Importing as a control

An item can be imported as a control when it is named [SC_<control name>]. Furthermore, property values can also be set when using the names of control properties for the names of child items.

drawing-7-1729499805.pngdrawing-7-1729499805.png

This functionality is only supported with Touchable and Common controls.

Importing as bitmaps

Smart Importer can import group items with child items as bitmaps when the the group item name is prefixed with [SC_Bmp].

drawing-7-1729501904.pngdrawing-7-1729501904.png

Import as state machine

FlowsWhen Figma flow functionality (screen transitions) is defined. Smart Importer imports the structure representing screen transitions
into CGI Studio as a state machine.
The imported state machine can be reviewed in the State Machine Editor within Scene Composer.

Settings on the Figma Side (Scenes and Flows)

On the Figma side, multiple scenes and the flows (screen transitions) connecting them are defined. Screen transitions are constructed starting from the scene specified as the flow start point.

drawing-7-1776928546.png
Import Result on the Scene Composer Side

The flow structure defined in Figma areis imported into CGI Studio as a state machines.machine
by Smart Importer.

    After import, the flow name will be prefixed with [StateMachine<flow name>].
    After import, names of states will be the same as the Figma items that were imported as scenes. 
    drawing-7-1729502771.pngdrawing-7-1776928764.png
    drawing-7-1729502742.png

    The

      state Transitionsmachine will beginstarts from the state that iscorresponds to the scene set to beas the Flowflow Startingstart Point.
      point in Figma. After importing, for each generated state, a screenshot of the corresponding Figma scene is automatically set, and the screenshot is displayed as a Scene Image in the State Machine Editor.
      drawing-7-1729575408.pngdrawing-7-1776929717.png
      drawing-7-1729502982.png

      When

        multiple Multipleflows Flowsare candefined, beeach flow is imported as multiplean independent state machines. 
        machine.
        drawing-7-1729503521.pngdrawing-7-1729503521.png
        drawing-7-1729503495.pngdrawing-7-1729503495.png

        Should a transition in one Flow be included in a separate Flow (ie. when a transition is duplicated), the separate Flow will not be imported. 

        Although

        Names inand Behavior After Importing as a State Machine
          About Names After Import
            The name of the state machine after import is “StateMachine<Flow Name>”. The name of each state after import is the same as the Figma item name imported as a scene. In Figma, it is possible to select the type of interaction that triggers ascreen transition can be selectedtransitions (such as click, drag, mouse hover,over, etc.),; however, regardless of which interaction is set, when importing with Smart Importer, the properties of the Transition that triggers screen transitions in Scene Composer will upon importare set these transition triggers in the following way:to Event = "Clicked", and Condition = "Check Click".

            Importing a Layout

            Auto layout

            If a Figma Frame has an "Auto layout" set, it will be imported as a "Stack Layout" in Scene Composer, and each setting value of the Auto layout will be inherited as a Stack Layout property.

            drawing-7-1740634409.pngdrawing-7-1740634409.png

            Figma Auto layout settings are inherited as properties of the Stack Layout of Scene Composer:

            drawing-7-1729578499.pngdrawing-7-1729578499.png

            Auto layout

            (Figma)

            Stack Layout propertise

            (Scene Coposer)

            1



            Direction

            Stack Layout

            [ Layouter > Arrangement ]

            Direction Arrangement
            Vertical layout Vertical
            Horizontal layout Horizontal
            Wrap
            2

            Gap

            The node that is placed second or later in the Stack Layout
             [Layout > Margin > Left or Top ]

            Direction Margin
            Vertical layout Top
            Horizontal layout Left
            Wrap
            3 Alignment

            Nodes included in a Stack Layout

            [ Layout > VerticalAlignment and HorizontalAlignment ] 

            4 Padding (Horizontal)

            The node to be placed at the leftmost position of the Stack Layout
            [ Layout > Margin > Left ] 

            5 Padding (Vertical)

            The node to be placed at the most top of the Stack Layout
            [ Layout > Margin > Top ]

            Below is an example of Auto layout (horizontal) from Figma imported into Scene Composer.

            drawing-7-1730094273.pngdrawing-7-1730094273.png
            Text Layout

            When Figma text layer is imported in Scene Composer, a Group node with LayoutType "Overlay" is created, and a text node is created under it. 

            drawing-5-1732891835.pngdrawing-5-1732891835.png

            Also, the Typography Alignment of the text layer from Figma is inherited as a layout property of the text node in Scene Composer.

            drawing-5-1732891908.pngdrawing-5-1732891908.png