Figma · Schema

Component

Metadata about a main component in a Figma file. Components are reusable design elements.

CollaborationDesignGraphicsInterfacesPrototypesPrototypingUI/UX

Properties

Name Type Description
key string The globally unique key of the component.
name string Name of the component.
description string The description of the component as entered in the editor.
componentSetId ['string', 'null'] The ID of the component set this component belongs to, if any.
documentationLinks array An array of documentation links attached to this component.
remote boolean Whether this component is a remote component that was pulled from an external library.
View JSON Schema on GitHub

JSON Schema

figma-rest-component-schema.json Raw ↑ 
{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "title": "Component",
  "type": "object",
  "description": "Metadata about a main component in a Figma file. Components are reusable design elements.",
  "properties": {
    "key": {
      "type": "string",
      "description": "The globally unique key of the component."
    },
    "name": {
      "type": "string",
      "description": "Name of the component."
    },
    "description": {
      "type": "string",
      "description": "The description of the component as entered in the editor."
    },
    "componentSetId": {
      "type": "['string', 'null']",
      "description": "The ID of the component set this component belongs to, if any."
    },
    "documentationLinks": {
      "type": "array",
      "description": "An array of documentation links attached to this component."
    },
    "remote": {
      "type": "boolean",
      "description": "Whether this component is a remote component that was pulled from an external library."
    }
  }
}