Frontend API¶

Your frontend module must export a setup(ctx) function. It receives a SpindleFrontendContext for host DOM rendering, events, backend communication, and opt-in sandbox frames.

import type { SpindleFrontendContext } from 'lumiverse-spindle-types'

export function setup(ctx: SpindleFrontendContext) {
  // Your initialization code here

  // Return a cleanup function (optional)
  return () => {
    ctx.dom.cleanup()
  }
}

Alternatively, export a teardown() function:

export function setup(ctx: SpindleFrontendContext) {
  // init
}

export function teardown() {
  // cleanup
}

API Surface¶

Frontend UI can follow two supported rendering paths:

• direct host rendering through ctx.dom.* and ctx.ui.*
• isolated iframe rendering through ctx.dom.createSandboxFrame(...) and ctx.messages.renderWidget(...)