Available from: 2.0.0
Import
import { ComponentGroup } from "@supernovaio/sdk"
Properties
- id: The unique identifier of the component group. This ID provides a constant and unchanging reference to the group entity.
- idInVersion: The unique identifier of the component group within this particular design system version.
- brandId: The unique identifier of the brand to which the component group belongs.
- designSystemVersionId: The identifier of the design system version in which the component group is located.
- name: The name of the 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 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 component groups that are subgroups of this group.
- isRoot: A boolean value indicating whether the component group is a root-level group within the design system version. There is always only one root group.
- childrenIds: An array of unique identifiers representing the component groups or components itself that are direct children of this group. The array is sorted in the order in which the components/groups are sorted within this group.
- componentIds: An array of unique identifiers representing the components that belong to this 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 component group was first created within the design system version.