Skip to content

Event ​

ArgFreeEventType ​

typescript
type ArgFreeEventType =
  "selectionchange" |
  "currentpagechange" |
  "librarychange" |
  "viewportchange" |
  "close" |

RunEvent ​

typescript
interface RunEvent {
  parameters?: ParameterValues;
  command: string;
}

DropEvent ​

typescript
interface DropEvent {
  node: BaseNode | SceneNode;
  x: number;
  y: number;
  absoluteX: number;
  absoluteY: number;
  items: DropItem[];
  files: DropFile[];
  dropMetadata?: any;
}

EditTypeChangeEvent ​

typescript
interface EditTypeChangeEvent {
  id: string;
  type: "FOCUS" | "BLUR";
}

DetachInstanceEvent ​

typescript
interface DetachInstanceEvent {
  id: string;
  componentId: string;
}

DetachStyleEvent ​

typescript
interface DetachStyleEvent {
  id: string;
  styleId: string;
}

ToptoolselectEvent ​

typescript
interface ToptoolselectEvent {
  command: string;
}

TopLeftToolSelectEvent ​

typescript
interface TopLeftToolSelectEvent {
  command: string;
}

TopLeftGuideCloseEvent ​

typescript
interface TopLeftGuideCloseEvent {
  command: string;
}

BottomToolSelectEvent ​

typescript
interface BottomToolSelectEvent {
  command: string;
}

ContextMenuSelectEvent ​

typescript
interface ContextMenuSelectEvent {
  command: string;
}

ShortcutHitEvent ​

typescript
interface ShortcutHitEvent {
  command: string;
}

ThemeChangeEvent ​

typescript
interface ThemeChangeEvent {
  theme: ThemeType;
}
type ThemeType = "DARK" | "LIGHT";

DocumentChangeEvent ​

typescript
interface DocumentChangeEvent {
  documentChanges: DocumentChange[];
}

type DocumentChange =
  | CreateChange
  | DeleteChange
  | PropertyChange
  | StyleCreateChange
  | StyleDeleteChange
  | StylePropertyChange;

interface BaseDocumentChange {
  id: string;
}
interface CreateChange extends BaseDocumentChange {
  type: "CREATE";
}
interface DeleteChange extends BaseDocumentChange {
  type: "DELETE";
}
interface PropertyChange extends BaseDocumentChange {
  type: "PROPERTY_CHANGE";
  properties: NodeChangeProperty[];
}
interface StyleCreateChange extends BaseDocumentChange {
  type: "STYLE_CREATE";
}
interface StyleDeleteChange extends BaseDocumentChange {
  type: "STYLE_DELETE";
  style: null;
}
interface StylePropertyChange extends BaseDocumentChange {
  type: "STYLE_PROPERTY_CHANGE";
  properties: StyleChangeProperty[];
}

LibraryEvent ​

typescript
interface LibraryEvent {
  key: string;
}