[Swift] Support nested/compound property mappings (parity with React)

Abierto
  • ¿Algo no está bien?
#376 2 comentarios 0 reacciones 0 asignados Ver en GitHub

Nadie ha tomado este issue todavía.

Evaluación

Dificultad
5/5
Tiempo estimado
Más de una semana
Aptitud para principiantes
35/100
Tipo de issue
Nueva funcionalidad
Claridad
Bastante claro
Estado de actividad
Estancado
Stack tecnológico
swift
Área
developer-experience

Línea de trabajo

Start with the SwiftUI Code Connect documentation and the existing @FigmaInstance, @FigmaBoolean, and @FigmaEnum APIs; the issue provides no source files or tests to target. Compare their behavior with the React nested property helpers and determine how Swift should represent optional instances and compound mappings. Done means Swift can express both use cases and produces valid snippets; the issue leaves the API design open.

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

Descripción

feature request

Summary

React Code Connect supports nesting property helpers inside each other — figma.boolean wrapping figma.instance, figma.enum wrapping figma.enum, etc. This enables conditional rendering and compound property mappings. Swift Code Connect has no equivalent for any of these patterns, making it impossible to express common real-world component APIs.

Use Case 1: Conditionally omitting an optional instance

In React, you can conditionally include or omit an instance property (docs):

props: {
  icon: figma.boolean("Has Icon", {
    true: figma.instance("Icon"),
    false: undefined, // omitted from snippet
  }),
}

In Swift, @FigmaInstance with an optional type renders an empty value when no instance is selected, producing invalid code:

struct MyButton_CodeConnect: FigmaConnect {
  @FigmaInstance("Icon") var icon: Icon?

  var body: some View {
    MyButton("Submit", icon: icon) { }
  }
}

When no icon is selected:

MyButton("Submit", icon: ) { }
//                  ^^^^^ empty — not valid code

Expected: The parameter should either be omitted entirely (MyButton("Submit") { }) or render as nil.

This was discussed for React in #71 and #86, where figma.boolean wrapping was the solution.

Use Case 2: Combining multiple Figma properties into one code value

In React, you can nest figma.enum inside figma.enum to map combinations of Figma properties to a single code value (docs):

props: {
  type: figma.enum("Type", {
    "Secondary": figma.enum("Theme", {
      "Light": "secondary",
      "Dark": "secondary-dark",
    }),
    "Tertiary": figma.enum("Theme", {
      "Light": "tertiary",
      "Dark": "tertiary-dark",
    }),
  }),
}

In Swift, @FigmaEnum mappings are flat — each maps a single Figma property independently. There's no way to express "when Type=Secondary AND Theme=Dark, use .secondary(variation: .dark)":

// Forced to ignore Theme entirely:
@FigmaEnum("Type", mapping: [
  "Secondary": CookbookButton.Style.secondary(),
  "Tertiary": CookbookButton.Style.tertiary(),
])
var type: CookbookButton.Style = .primary()

Attempted Workaround: Variant-specific structs

The docs describe variant for mapping one Figma component to different code components (e.g. PrimaryButton vs DangerButton). We attempted using multiple FigmaConnect structs with the same component type but different variant restrictions to work around both use cases above.

This does not work — Figma only ever displays one of the snippets, regardless of which variant is active. The variant property appears to only function when each struct declares a different component type, as shown in the docs.

Proposal

Support nested/compound property mappings in Swift, bringing parity with React's composable helpers.

For optional instances (Use Case 1)

Option A: Automatically omit the parameter when a @FigmaInstance with an optional type resolves to nothing — consistent with how falsy props are omitted in React.

Option B: Add hideDefault to @FigmaInstance, consistent with the existing @FigmaEnum API:

@FigmaInstance("Icon", hideDefault: true) var icon: Icon?

Option C: Allow @FigmaBoolean to wrap @FigmaInstance:

@FigmaBoolean("Has Icon", mapping: [
  true: FigmaInstance("Icon"),
  false: nil,
])
var icon: Icon?
For compound property mappings (Use Case 2)

Allow nesting @FigmaEnum (or similar) inside @FigmaEnum mapping values:

@FigmaEnum("Type", mapping: [
  "Secondary": FigmaEnum("Theme", mapping: [
    "Light": CookbookButton.Style.secondary(),
    "Dark": CookbookButton.Style.secondary(variation: .dark),
  ]),
  "Tertiary": FigmaEnum("Theme", mapping: [
    "Light": CookbookButton.Style.tertiary(),
    "Dark": CookbookButton.Style.tertiary(variation: .dark),
  ]),
])
var type: CookbookButton.Style = .primary()

Environment

  • Code Connect version: 1.4.1
  • Platform: Swift (SwiftUI)
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.