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

Aperta
  • Qualcosa non va?
#398 1 commento 0 reazioni 0 assegnatari Vedi su GitHub

Nessuno ha ancora preso questa issue.

Valutazione

Difficoltà
4/5
Tempo stimato
3-5 giorni
Idoneità per principianti
48/100
Tipo di issue
Bug
Chiarezza
Abbastanza chiara
Stato di attività
Tranquilla
Stack tecnologico
react, typescript
Ambito
tooling

Direzione di ricerca

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.

Scritto dal modello di indicizzazione a partire dal testo della issue.

Descrizione

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.

Lingua principale
TypeScript
Stelle
1.6k
Fork
126
Nessuna PR unita negli ultimi 30g

Preparare l'ambiente

Questo progetto non fornisce container di sviluppo, Dockerfile né guida per i contributori, quindi l'ambiente è a tuo carico: parti dal suo README e consulta la nostra guida al primo contributo per i passaggi generali.

Come iniziare

  1. Leggi tutta la issue e poi la guida ai contributi del progetto.
  2. Commenta sulla issue per dire che te ne occupi tu — evita che due persone facciano lo stesso lavoro.
  3. Fai un fork del repository e lavora su un branch.
  4. Apri una pull request che faccia riferimento al numero della issue.

Altre issue di figma/code-connect

Tutte le issue di figma/code-connect

Issue simili

Altre issue su TypeScript

Ricevi le nuove issue nella tua casella

Un breve riepilogo di issue GitHub adatte ai principianti.