Design component group

DesignComponentGroup mirrors the structure of grouping of the design components in the Figma files they were imported from.

Available from: 2.0.0

Import


                                                        
                                                        
                                                            import { DesignComponentGroup } from "@supernovaio/sdk"
                                                        
                                                            

Properties

  • id: The unique identifier of the design component group. This ID provides a constant and unchanging reference to the group entity.
  • brandId: The unique identifier of the brand to which the design component group belongs.
  • name: The name of the design component group, offering a human-readable label to identify it easily and distinguish it from other groups within the same design system version.
  • description: A brief description that provides insights into the design component group's purpose, characteristics, or unique organization.
  • path: An array of strings representing the hierarchical path of the group within the design system version's organizational structure. Useful when constructing names.
  • subgroupIds: An array of unique identifiers representing the design component groups that are subgroups of this group. These subgroups form a hierarchical structure under the current group.
  • isRoot: A boolean value indicating whether the design component group is a root-level group within the design system version. There will always be only one root component.
  • childrenIds: An array of unique identifiers representing the design component groups that are direct children of this group. These children groups are directly contained within the current group.
  • componentIds: An array of unique identifiers representing the design components that belong to this group. These components are organized and grouped under this specific design component group.
  • parentGroupId: The identifier of the parent group to which this group belongs within the design system version's hierarchy. This field will be null if the group is a root-level group.
  • createdAt: The timestamp indicating when the design component group was first created within the design system version.
  • updatedAt: The timestamp indicating the most recent date and time when the design component group was updated or modified within the design system version.