Skip to main content

sdk.designapi

Home > @kittl/sdk > DesignAPI

DesignAPI interface

Main API interface for design manipulation operations. Provides access to all design-related APIs including artboards, objects, text, shapes, images, guides, and canvas operations.

Signature:

export interface DesignAPI 

Properties

Property

Modifiers

Type

Description

board

BoardAPI

API for creating and managing artboards

canvas

CanvasAPI

API for canvas operations (preview images)

config

ConfigAPI

API for updating design configuration

guide

GuideAPI

API for creating and managing guides (alignment lines)

illustration

IllustrationAPI

API for adding and updating illustrations

image

ImageAPI

API for adding and updating images

loadingCard

LoadingCardAPI

API for creating and managing loading card placeholders

object

ObjectAPI

API for managing design objects (locking, removal)

shape

ShapeAPI

API for creating and managing basic geometric shapes

state

StateAPI

API for design state operations (sub-state implementation)

text

TextAPI

API for creating and managing text elements

video

VideoAPI

API for adding and updating videos