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

Abierto
  • ¿Algo no está bien?
#398 1 comentario 0 reacciones 0 asignados Ver en GitHub

Nadie ha tomado este issue todavía.

Evaluación

Dificultad
4/5
Tiempo estimado
3-5 días
Aptitud para principiantes
48/100
Tipo de issue
Error
Claridad
Bastante claro
Estado de actividad
Tranquilo
Stack tecnológico
react, typescript
Área
tooling

Línea de trabajo

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.

Escrito por el modelo de indexación a partir del texto del issue.

Descripción

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.

Lenguaje dominante
TypeScript
Estrellas
1.6k
Forks
126
Sin PR fusionados en 30 d

Preparar el entorno

Este proyecto no incluye contenedor de desarrollo, Dockerfile ni guía de contribución, así que la configuración corre por tu cuenta: empieza por su README y consulta nuestra guía para la primera contribución para los pasos generales.

Primeros pasos

  1. Lee el issue completo y luego la guía de contribución del proyecto.
  2. Comenta en el issue que vas a ocuparte — evita que dos personas hagan lo mismo.
  3. Haz un fork del repositorio y trabaja en una rama.
  4. Abre un pull request que haga referencia al número del issue.

Más de figma/code-connect

Todos los issues de figma/code-connect

Issues similares

Más issues de TypeScript

Recibe los nuevos issues en tu correo

Un resumen breve de issues de GitHub para principiantes.