Available from: 2.0.0
Import
import { DesignComponent } from "@supernovaio/sdk"
Properties
- id: The unique identifier of the design component. This ID provides a constant and unchanging reference to the component entity.
- brandId: The unique identifier of the brand to which the design component belongs.
- thumbnailUrl: A URL pointing to a thumbnail image representing the design component, providing a visual preview or representation of the component's appearance. This URL may be null if no thumbnail is available, but it is generally safe to rely on it.
- svgUrl: A URL pointing to an SVG image representing the design component. This URL may be null if no SVG representation is available. svgUrl will be available on all components that were imported (or re-imported) to Supernova after Nov 7, 2023.
- name: The name of the design component, offering a human-readable label to identify it easily and distinguish it from other design components within the same design system version.
- description: A brief description that provides insights into the design component's purpose, characteristics, or unique visual elements.
- origin: An object representing the origin of the design component, indicating the source data or object from which the component was derived. For design components, this will always be Figma source as they can't be created any other way.
- createdAt: The timestamp indicating when the design component was first created within the design system version.
- updatedAt: The timestamp indicating the most recent date and time when the design component was updated or modified within the design system version.