Type Alias SceneSetup<P, D>

SceneSetup: (
props: P,
ctx: Scene<any>,
) => NodeLike | NodeLike[] | { data: () => D; node: NodeLike | NodeLike[] }

Scene setup function, only called once when the scene is created.

Type Parameters

P extends LooseObject = any
D extends LooseObject = LooseObject & ForbiddenSceneData

Type Declaration

- (
  props: P,
  ctx: Scene<any>,
  ): NodeLike | NodeLike[] | { data: () => D; node: NodeLike | NodeLike[] }
- Parameters
  - props: P
    The reactive props to control the scene display
  - ctx: Scene<any>
    The scene instance, can be used to manage lifecycle
  Returns NodeLike | NodeLike[] | { data: () => D; node: NodeLike | NodeLike[] }
  - NodeLike
  - NodeLike[]
  - { data: () => D; node: NodeLike | NodeLike[] }
    - data: () => D
      Data getter to get data from elements
    - node: NodeLike | NodeLike[]
      The node(s) appended to the root element of scene

See