https://github.com/jake-figma/component-inspector
A Figma plugin for inspecting Figma components
https://github.com/jake-figma/component-inspector
figma-plugin
Last synced: about 1 year ago
JSON representation
A Figma plugin for inspecting Figma components
- Host: GitHub
- URL: https://github.com/jake-figma/component-inspector
- Owner: jake-figma
- Created: 2022-09-24T18:33:28.000Z (almost 4 years ago)
- Default Branch: main
- Last Pushed: 2024-03-20T19:45:17.000Z (over 2 years ago)
- Last Synced: 2025-03-25T01:51:13.488Z (over 1 year ago)
- Topics: figma-plugin
- Language: TypeScript
- Homepage: https://www.figma.com/community/plugin/1162860898904210114
- Size: 1.34 MB
- Stars: 106
- Watchers: 3
- Forks: 12
- Open Issues: 4
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# Component Inspector
A [Figma plugin](https://www.figma.com/community/plugin/1162860898904210114) for inspecting Figma components.
This plugin provides a look at Figma component properties similar to how they are described in code. This plugin does _not_ generate style code. It generates code that describes component properties.
Currently supporting instance and component code generation for:
- React function components
- Angular components
- Vue components (both option and composition APIs)
- Web components
As well as:
- JSON
Would love to hear from you about what works and what doesn't.
## Conventions / Pro Tips
### Slots
Currently, this plugin supports tag-named slots. Add the `--SLOT[tagname]` suffix to the name of a text component property in Figma and it will generate a slot for that attribute. For example, if you create a component with a text property named `"heading--SLOT[h2]"`, it would generate the following React instance and definition code:
```tsx
My slot content} />
```
```tsx
const Component: FC<{
heading: ReactNode;
}> = ({ heading }) => <>{heading}>;
```
The tagname will default to `span` if you use the suffix `--SLOT` without a tagname.
If your Figma component has a single text property, it will be treated as a generic slot.
> This can be configured by running the Component Inspector > Configuration command.
### Boolean visibility
If you have a boolean Figma component property that controls visibility of a text or instance swap property (or one of their ancestors), that boolean property will be ignored in generated code and the text or instance swap property will disappear when the boolean is false.
### `"undefined"` variant options and instance swaps
If you have a variant option property that defaults to the string `"undefined"`, that property will be treated as truly optional (no default).
If you have an instance swap property that defaults to a component named `"undefined"`, that property will be treated as truly optional (no default).
> This can be configured by running the Component Inspector > Configuration command.
### Ignored property prefix
You can configure the component inspector to ignore properties named with a provided prefix.
> This can be configured by running the Component Inspector > Configuration command.
### Numeric variant options
If your variant options are all numeric or if the default value for a text property is numeric, the generated code will treat it like a number type property.