airi/packages/vishot-runtime
2026-05-07 19:36:33 +08:00
..
src test: migrate more test into browser mode, fix all existing tests 2026-05-07 18:48:39 +08:00
package.json release: v0.10.2 2026-05-07 19:36:33 +08:00
README.md refactor(vishot-*,scenarios-*): better structure, better api, and markup components 2026-04-15 04:51:00 +08:00
tsconfig.json feat(vishot-*,scenarios-*): new packages, and playwright high level abstraction 2026-04-04 01:37:57 +08:00
vite.config.ts feat(vishot-*,scenarios-*): new packages, and playwright high level abstraction 2026-04-04 01:37:57 +08:00
vitest.config.ts test: migrate more test into browser mode, fix all existing tests 2026-05-07 18:48:39 +08:00

Vishot Runtime

Shared runtime contracts and Vue bindings for Vishot scene capture.

Purpose

This package owns the browser-side runtime surface used by scene packages. It provides:

  • readiness helpers via markScenarioReady() and resetScenarioReady()
  • the shared ScenarioCaptureRootProps type
  • framework-specific bindings through subpath exports such as @proj-airi/vishot-runtime/vue
    • Vue bindings include ScenarioCanvas, ScenarioCaptureRoot, useSceneReady()
    • Vue bindings also export screen-specific components/composables (router, navigator, markup, and navigation helpers)

Usage

import { markScenarioReady, resetScenarioReady } from '@proj-airi/vishot-runtime'
import {
  ScenarioCanvas,
  ScenarioCaptureRoot,
  ScreenNavigator,
  ScreenRouterProvider,
  useSceneNavigation,
} from '@proj-airi/vishot-runtime/vue'

Keep framework-agnostic contracts at the package root and import Vue SFC bindings from ./vue.

import {
  markScenarioReady,
  resetScenarioReady,
} from '@proj-airi/vishot-runtime'