Template API: executeTemplate() fails on instances found via findLayers and findConnectedInstances

オープン
  • 何か問題がありますか？
#398 コメント 1 件 リアクション 0 件 担当者 0 名 GitHub で見る

まだ誰も着手していません。

評価

難易度
4/5
見積もり時間
3〜5日
初心者へのやさしさ
48/100
issue の種類
バグ
明瞭さ
おおむね明確
活発さ
静か
技術スタック
react, typescript
領域
tooling

調査の方向性

Compare how the Template API handles instances returned by findInstance, findLayers, and findConnectedInstances, focusing on why only the single result renders through executeTemplate().example. Reproduce with the reported nested component case using the React parser and Template API; done means instances found by the multi-result methods render their expected snippets. The issue does not name source files or tests, so locate the relevant implementation and test entry points first.

索引モデルが issue の本文から書いたものです。

説明

API question
Description

When using the Figma Template API for nested component rendering (Code Connect), there is a significant inconsistency between discovery methods. While findInstance successfully allows for snippet generation of a child component, methods that support multiple results (findLayers, findConnectedInstances) fail to render the underlying templates.

Environment

  • @figma/code-connect CLI: v1.4.4

  • Parser: React

  • Template Format: Template API (.figma.ts with id, imports, example)

Test Case & Findings

Goal: Dynamically find and render all child components (Buttons, Selects, Inputs) within a parent component (Modal) using the Template API.

1. findInstance(layerName) — Working (Limited)

  • Result: Success, but limited to a single instance.

  • Behavior: Correctly finds the layer and executeTemplate().example returns the full, expected code snippet.

  • Limitation: It only returns the first match. If a Modal has two Buttons, the second one is inaccessible.

2. findLayers(selectorFn) — Broken Rendering

  • Result: Finds layers, but cannot render.

  • Behavior: It correctly identifies the number of children (e.g., layers.length = 6). However, calling executeTemplate().example on these handles returns empty/null.

  • Suspected Bug: The handles returned by findLayers seem to be "unresolved" compared to those from findInstance.

3. findConnectedInstances() — Fails to Locate

  • Result: Failed (0 results found).

  • Behavior: Despite documentation suggesting this for nested compositions, it returns an empty array even when traverseInstances: true is set and children have valid Code Connect files.

4. getInstanceSwap(propName) — Partial Failure

  • Result: Returns reference only.

  • Behavior: It finds the swap instance but fails to render the internal structure of the swapped component, returning only a placeholder name or layer name instead of the code snippet.

Comparison Table

Method: findInstance | Discovery: ✅ | executeTemplate Works?: ✅ | Multi-instance Support?: ❌ (Single only)

Method: findLayers | Discovery: ✅ | executeTemplate Works?: ❌ (Empty result) | Multi-instance Support?: ✅

Method: findConnectedInstances | Discovery: ❌ | executeTemplate Works?: — | Multi-instance Support?: ✅

Method: getInstanceSwap | Discovery: ✅ | executeTemplate Works?:⚠️ (Name only) | Multi-instance Support?:❌

Impact

This issue makes dynamic nested composition impossible. Currently, we cannot dynamically loop through and render a variable number of children (e.g., form elements in a Modal body or multiple buttons in a footer) because the methods that find multiple children do not support rendering.

The only "workaround" is manually calling findInstance for every known layer name, which is not scalable and fails when multiple instances share the same name.

Steps to Reproduce

  1. Create a parent component using the Template API format.

  2. Create multiple child components also using the Template API format (including id and metadata: { nestable: true }).

  3. Attempt to use findLayers to map through children and call executeTemplate().example on each.

  4. Observe that the returned value is empty.

Expected Behavior

Any component handle returned by findLayers or findConnectedInstances should behave identically to the handle returned by findInstance, allowing executeTemplate() to produce the correct code snippet.

Proposed Fix/Action

  • Investigate why handles from findLayers lose their template context.

  • Ensure findConnectedInstances correctly identifies children using the Template API format.

主要言語
TypeScript
スター
1.6k
フォーク
126
30日以内にマージされた PR はありません

環境構築

このプロジェクトには開発コンテナ、Dockerfile、コントリビューションガイドがありません。まず README を読み、一般的な手順ははじめてのコントリビューションガイドを参照してください。

はじめの一歩

  1. issue を最後まで読み、次にプロジェクトのコントリビューションガイドを読みます。
  2. 着手することを issue にコメントします — 二人が同じ作業をするのを防げます。
  3. リポジトリをフォークし、ブランチを切って変更します。
  4. issue 番号を参照したプルリクエストを送ります。

figma/code-connect のほかの issue

figma/code-connect の issue をすべて見る

似ている issue

TypeScript の issue をもっと見る

新しい issue をメールで受け取る

初心者向けの GitHub issue を短くまとめたダイジェスト。