Interface AsukaDesigner

Public runtime instance returned by createAsukaDesigner.

It groups the API into focused namespaces:

interface AsukaDesigner {
    api: AsukaDesignerApi;
    assembly: AsukaAssemblyApi;
    destroy: (() => void);
    engine: AsukaRenderEngine;
    getColor: ((token: ThemeToken) => null | string);
    layout: AsukaLayoutApi;
    measureLayer: ((id: string, options?: AsukaLayerMeasurementOptions) => null | AsukaLayerMeasurement);
    registerModule: ((definition: AsukaModuleDefinition, options?: AsukaRegisterModuleOptions) => void);
    resetColors: ((preset?: ThemePresetId) => ThemeColorMap);
    rootElement: HTMLElement;
    setColor: ((token: ThemeToken, value: string) => boolean);
    setColors: ((colors: Partial<ThemeColorMap>) => string[]);
    store: UseBoundStore<StoreApi<AsukaState>>;
    theme: AsukaThemeApi;
    ui: AsukaModuleUiHelpers;
    util: AsukaUtilApi;
    variations: AsukaVariationsApi;
}

Properties

api assembly destroy engine getColor layout measureLayer registerModule resetColors rootElement setColor setColors store theme ui util variations

Properties

api

api: AsukaDesignerApi

Canvas, views, exports, fonts and history helpers.

assembly

assembly: AsukaAssemblyApi

Generic plans, anchors, snapping, validation, BOM and production exports for 3D assemblies.

destroy

destroy: (() => void)

Unmount the UI and release global resources associated with the instance.

engine

engine: AsukaRenderEngine

Active render-engine facade. Fabric by default, 3D when the active view uses the 3D engine.

getColor

getColor: ((token: ThemeToken) => null | string)

Shorthand for designer.theme.getColor(...).

layout

layout: AsukaLayoutApi

Layout and contextual menu controls.

measureLayer

measureLayer: ((id: string, options?: AsukaLayerMeasurementOptions) => null | AsukaLayerMeasurement)

Shorthand for designer.api.measureLayer(...).

registerModule

registerModule: ((definition: AsukaModuleDefinition, options?: AsukaRegisterModuleOptions) => void)

Register a custom module at runtime and optionally add it to the current layout.

resetColors

resetColors: ((preset?: ThemePresetId) => ThemeColorMap)

Shorthand for designer.theme.reset().

rootElement

rootElement: HTMLElement

Root DOM element used by the designer instance.

setColor

setColor: ((token: ThemeToken, value: string) => boolean)

Shorthand for designer.theme.setColor(...).

setColors

setColors: ((colors: Partial<ThemeColorMap>) => string[])

Shorthand for designer.theme.setColors(...).

store

store: UseBoundStore<StoreApi<AsukaState>>

Expose the zustand store for advanced integrations (read-only usage recommended).

theme

theme: AsukaThemeApi

Theme token helpers for live UI customization.

ui

ui: AsukaModuleUiHelpers

Vanilla-friendly UI helpers to build custom modules without importing every component manually.

util

util: AsukaUtilApi

State, permissions, translations and low-level runtime helpers.

variations

variations: AsukaVariationsApi

Typed element-variation catalog and synchronized 2D/3D mutations.

Settings

Member Visibility

On This Page

Properties