Interface AsukaDesignerOptions

Options accepted by createAsukaDesigner(...).

interface AsukaDesignerOptions {
    agency?: AsukaAgencyFeatureOptions;
    ai?: AsukaAiFeatureOptions;
    boot?: AsukaBootOptions;
    colors?: AsukaColorsConfig;
    debug?: AsukaDebugOptions;
    defaultRole?: string;
    engine?: AsukaRenderEngineKind | AsukaRenderEngineOptions;
    engines?: AsukaRenderEngineOptionsByKind;
    exports?: AsukaExportsFeatureOptions;
    fonts?: AsukaFontsConfig;
    i18n?: AsukaI18nOptions;
    icons?: Record<string, AsukaIconOverride>;
    initialState?: unknown;
    integrations?: AsukaIntegrationsConfig;
    layout?: LayoutConfig;
    license?: AsukaLicenseOptions;
    listeners?: Partial<Record<string, boolean>>;
    mode?: AsukaMode;
    moduleConfig?: AsukaModuleConfig;
    observability?: AsukaObservabilityOptions;
    pdf?: AsukaPdfOptions;
    permissions?: Partial<AsukaPermissions>;
    price?: string | number;
    priceFormat?: AsukaPriceFormatConfig;
    pricingRules?: AsukaPricingRule[];
    printingMethods?: AsukaPrintingMethod[];
    responsive?: AsukaResponsiveConfig;
    roles?: Record<string, Partial<AsukaPermissions>>;
    shell?: AsukaShellOptions;
    theme?: AsukaThemeOptions;
    ui?: AsukaUiOptions;
    uiScaling?: AsukaUiScalingOptions;
    views?: AsukaInitialViewConfig[];
}

Properties

agency? ai? boot? colors? debug? defaultRole? engine? engines? exports? fonts? i18n? icons? initialState? integrations? layout? license? listeners? mode? moduleConfig? observability? pdf? permissions? price? priceFormat? pricingRules? printingMethods? responsive? roles? shell? theme? ui? uiScaling? views?

Properties

Optionalagency

agency?: AsukaAgencyFeatureOptions

Agency-only features such as white-label branding, advanced permissions and export/import helpers.

Optionalai

ai?: AsukaAiFeatureOptions

AI helpers such as text-to-image and background removal adapters.

Optionalboot

boot?: AsukaBootOptions

Explicit boot strategy used to replace a product/session at startup.

Optionalcolors

colors?: AsukaColorsConfig

Designer-level colors configuration.

Optionaldebug

debug?: AsukaDebugOptions

Optional debug switches for boot/state/layout logs.

OptionaldefaultRole

defaultRole?: string

Default role applied at boot.

Optionalengine

engine?: AsukaRenderEngineKind | AsukaRenderEngineOptions

Default rendering engine. Fabric remains the default 2D engine; 3D is intended for addon-backed views.

Optionalengines

engines?: AsukaRenderEngineOptionsByKind

Optional per-engine loaders/configuration. Use this to lazy-load Fabric/Babylon by active view engine.

Optionalexports

exports?: AsukaExportsFeatureOptions

Paid export helpers such as PDF credit consumption and server-side HD rendering.

Optionalfonts

fonts?: AsukaFontsConfig

Global font registry loaded at boot.

Optionali18n

i18n?: AsukaI18nOptions

Internationalization initialization payload.

Optionalicons

icons?: Record<string, AsukaIconOverride>

Runtime icon overrides for menu/module buttons.

OptionalinitialState

initialState?: unknown

Serialized full state restored automatically right after initialization.

Optionalintegrations

integrations?: AsukaIntegrationsConfig

Third-party integrations (API keys, endpoints, ...).

Optionallayout

layout?: LayoutConfig

Layout, menus and selection menu presets.

Optionallicense

license?: AsukaLicenseOptions

Optional runtime licensing configuration.

Optionallisteners

listeners?: Partial<Record<string, boolean>>

Enable/disable individual listeners at boot.

Optionalmode

mode?: AsukaMode

Global mode. In prod, some permissions default to stricter values.

OptionalmoduleConfig

moduleConfig?: AsukaModuleConfig

Per-module configuration (UI defaults, feature toggles).

Optionalobservability

observability?: AsukaObservabilityOptions

Optional host-controlled production error reporting.

Optionalpdf

pdf?: AsukaPdfOptions

Optional PDF export support.

Optionalpermissions

permissions?: Partial<AsukaPermissions>

Permission overrides merged on top of the selected role defaults. Example: { canMovePanels: true, canCollapsePanels: true } enables menu drag & drop and zone/panel collapse controls even in mode: 'prod'.

Optionalprice

price?: string | number

Optional external/base price included by computed totals.

OptionalpriceFormat

priceFormat?: AsukaPriceFormatConfig

Default price formatting settings.

OptionalpricingRules

pricingRules?: AsukaPricingRule[]

Dynamic pricing rules evaluated by the pricing engine.

OptionalprintingMethods

printingMethods?: AsukaPrintingMethod[]

Initial printing methods list.

Optionalresponsive

responsive?: AsukaResponsiveConfig

Responsive shell/layout behavior for mobile and tablet containers.

Optionalroles

roles?: Record<string, Partial<AsukaPermissions>>

Custom role presets merged on top of the built-in defaults.

Optionalshell

shell?: AsukaShellOptions

Optional root shell sizing overrides.

Optionaltheme

theme?: AsukaThemeOptions

Theme initialization payload.

Optionalui

ui?: AsukaUiOptions

UI behavior overrides such as the view pagination bar.

OptionaluiScaling

uiScaling?: AsukaUiScalingOptions

Keeps editor controls and helper overlays readable when the canvas is visually shrunk.

Optionalviews

views?: AsukaInitialViewConfig[]

Optional initial views. Each view can override the root engine.

Settings

Member Visibility

On This Page

Properties