API

auto-exhibition-template-sdk 提供配置定义、Vite 接入、页面取值和模板函数通信所需的 API。

SDK 入口

SDK 通过以下方式导入:

// 默认导入(包含 Vue 插件和所有导出)
import TemplateSdk from 'auto-exhibition-template-sdk'

// 按需导入
import {
  useTemplateValue,
  registerTemplateFunction,
  invokeTemplateFunction
} from 'auto-exhibition-template-sdk'

模块导出

auto-exhibition-template-sdk

SDK 的主入口,导出运行时所需的全部 API:

导出 说明 类型
TemplateSdk Vue 插件 Plugin
useTemplateValue 组合式函数,用于读取字段值 Function
validateTemplateConfig 配置校验函数 Function
registerTemplateFunction 注册当前模板暴露给外部调用的函数 Function
invokeTemplateFunction 通过本地 Bridge 或网关调用模板函数 Function
useTemplateBridge 获取模板通信 Bridge 实例 Function

auto-exhibition-template-sdk/config

配置相关的 API:

导出 说明 类型
defineTemplateConfig 类型安全的配置定义函数 Function

auto-exhibition-template-sdk/vite

Vite 插件相关的 API:

导出 说明 类型
templateSdkPlugin Vite 插件 Plugin

快速链接