Role of Component name

Open
  • Is something wrong?
#355 0 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Assessment

Difficulty
2/5
Estimated time
1-3 hours
Newbie friendliness
45/100
Issue type
Documentation
Clarity
Mostly clear
Activity status
Stale
Tech stack
kotlin, typescript
Domain
developer-experience, documentation

Research direction

Start with the Compose Code Connect documentation linked in the issue and trace how the Composable function name is used in suggested imports and as the Figma component name. The issue asks for the suggested import to resolve correctly and for the component name's role to be explained; confirm the relevant documentation and suggestion behavior before deciding what change is needed.

Written by the indexing model from the issue text.

Description

API question

I realised that the name of the function annotated with @Composable is used in two places :

  • in the import inside suggest code (see screenshot)
  • as the component name (I'm not sure what the component name is used for anyway in Compose)
Image

The import in the suggested code should be fixed, and point to the real import
The role of the component name in Figma should be better explained in https://developers.figma.com/docs/code-connect/compose/

Please provide:

  • Code Connect CLI version 1.3.13
  • Operating system MacOS 26.2
  • Code Connect file
@file:Suppress("unused")

package com.mycomapny.designsystem

import androidx.compose.runtime.Composable
import com.figma.code.connect.FigmaConnect
import com.figma.code.connect.FigmaVariant
import com.navico.argonsdk.compose.slider.Slider

@FigmaConnect(url = "https://www.figma.com/design/4Lp9RNH2jS1KmFqwFNJlXZ/TestFile?node-id=1-35&t=gFRxObRkPosXZapP-4")
@FigmaVariant("Style", "Horizontal")
private class TestFigma {

    @Composable
    fun Slider1() {
        Slider.Horizontal(
            value = 1f,
            onValueChange = {},
        )
    }
}

@FigmaConnect(url = "https://www.figma.com/design/4Lp9RNH2jS1KmFqwFNJlXZ/TestFile?node-id=1-35&t=gFRxObRkPosXZapP-4")
@FigmaVariant("Style", "Vertical")
private class TestVerticalFigma {

    @Composable
    fun Slider2() {
        Slider.Horizontal(
            value = 1f,
            onValueChange = {},
        )
    }
}
Dominant language
TypeScript
Stars
1.6k
Forks
126
No merged PRs in 30d

Getting set up

This project ships no dev container, Dockerfile or contributing guide, so setting up is up to you: start from its README, and see our first-contribution guide for the general steps.

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

More from figma/code-connect

All issues in figma/code-connect

Similar issues

More TypeScript issues

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.