@ goflowstate/ widget- sdk
SDK用于在"流州"风景名胜区内部运行的构件.
安装
npm install @goflowstate/widget-sdk
或者通过CDN(不需要捆绑):
<script src="https://unpkg.com/@goflowstate/widget-sdk/dist/canvas-widget-sdk.js"></script>
快速启动
无害环境管理(捆绑者/类型脚本)
import { CanvasWidget } from '@goflowstate/widget-sdk';
const widget = await CanvasWidget.init();
// React to display state changes
widget.onStateChange((state) => {
console.log('Widget state:', state); // 'collapsed' | 'expanding' | 'expanded' | 'collapsing'
});
// Expand into modal view
document.getElementById('open-btn')?.addEventListener('click', () => {
widget.requestExpand();
});
脚本标签( 无捆绑)
<script src="canvas-widget-sdk.js"></script>
<script>
CanvasWidget.init().then((widget) => {
widget.onStateChange((state) => console.log(state));
});
</script>
加入和订阅事件
const widget = await CanvasWidget.init();
// Broadcast to other widgets on the same canvas
widget.emit('timer:tick', { remaining: 60 });
// Listen for events from other widgets
const unsub = widget.subscribe('timer:tick', (event) => {
console.log(event.topic, event.payload);
});
// Stop listening
unsub();
持久性存储
const widget = await CanvasWidget.init();
// Store a value (scoped to this widget installation)
await widget.storage.set('count', 42);
// Retrieve a value
const count = await widget.storage.get('count');
// Remove a value
await widget.storage.delete('count');
AI 补全
在不持有任何提供者密钥的情况下调用平台的模型. 每个电话都是 和你的出版业务有关.
const widget = await CanvasWidget.init();
// One-shot completion
const res = await widget.ai.complete({
alias: 'widget.gpt-mini', // widget.* aliases only — never raw model ids
system: 'You summarise kanban boards in one sentence.',
messages: [{ role: 'user', content: boardAsText }],
});
console.log(res.text, res.inputTokens, res.outputTokens);
// Streaming
for await (const ev of widget.ai.stream({
alias: 'widget.haiku',
messages: [{ role: 'user', content: 'Brainstorm three icebreakers.' }],
})) {
if (ev.type === 'text') appendToUi(ev.text);
if (ev.type === 'done') console.log('tokens:', ev.inputTokens, ev.outputTokens);
if (ev.type === 'error') showError(ev.message);
}
可用的别名 : widget.haiku (Anthropic,快来), widget.sonnet
(Anthropic,最强), widget.gpt (开放AI,最强), widget.gpt-mini
(开放AI,快), widget.gemini (Google,最强), widget.gemini-mini
(高格尔,快), widget.sonar (复杂,答案基于现场网络)
搜索), widget.sonar-pro (繁杂,网易,更深的研究).
异名是平台管理的;一个模型背后的模型可以改进而不用
代码在你这边更改.
注释:
maxTokens被夹住的服务器侧到 [256, 4096] (默认 1024)。 这个 地板之所以存在,是因为OpenAI的别名是推理模型:一个微小的 预算完全被隐形推理所消耗,返回为空 文本为stopReason: 'length'。如果看到空文本,请提高预算.- 越狱
stream()循环取消上游呼叫,所以你是 没有为您停止阅读的文本计费. - 预算出错, 有信件开始
usage limit reached—— 说 抓住他们 展示自己的副本.
用户背景和同意
const widget = await CanvasWidget.init();
// Request access to user data
const result = await widget.requestConsent('user:profile', 'Needed to personalise your experience');
if (result.granted) {
console.log('User:', widget.user?.displayName);
}
通知
widget.notify('Saved!', { level: 'info', duration: 3000 });
观众要求(壳牌嘉宾)
在unishell shell网页上开幕的会话 属于一位客人,他的名字是,
电子邮件或电话已验证 。 这些事实都发生在
状态改为 state.viewer.claims,最新的一个是
session.claims数字 :
const session = CanvasWidget.initSession();
const state = await session.join();
const email = session.claims?.email; // { type, value, source, verifiedAt? } | undefined
索求只是读者自己的 而且是背景,不是
授权. session.claims 实值 null 为会员、PWA嘉宾和
在第一州到达之前.
流量反馈( 错误图标)
呼唤的流出 CanvasWidget.initSession() 带有反馈图标,没有自己的代码.
戒指打开了反馈,会话状态就这么说了 SDK放一圈
按钮。 水龙头一次打开一个字段的表,然后取出
其后页的截图,图标和工作表都没有. 床单上写着
步骤:角标记框上页,槽上写作"抓取截图"(最多15秒),
然后"Screenshot附" 图片和一张支票,或者"没有截图" 与"Take"
当无法取出或被取出时, 按钮读取“ 发送” 时, 便条
单子在关闭前以"Feedback sent"结尾 该说明通过流量会话发送给 POST /api/w/:slug/feedback。 。 。 .
图标和工作表查看他们所坐的页面:其字体、地、墨、填
和它的主按钮的形状,以及它的角半径。 要设定角色, 请设置自定义属性
:root数字 :
:root {
--fs-feedback-cta: #5136c4; /* also -cta-ink, -ground, -ink, -font, -font-display, -radius */
--fs-feedback-bottom: 96px; /* where the icon sits; also -right */
}
工作表的类型来自流动所画的字,而不是来自 <body>: 标题
最大方向、音符和字段的相貌、重量和字母间隔
流中大部分较小的文字被设定在相上,发送按钮取出相上,相上,相上,相上,
字母间距和流量主按钮的大小写。 键 --fs-feedback-font 或者说
--fs-feedback-font-display 当诵经已去.
按钮会漂浮在流上,属于使用它的人. 他们可以把它拖到任何地方, 它在更近的一面。 一闪一闪,或一被拖入边缘, 把它停在那里,作为一个 微小标签, 错误仍在显示; 标签上的水龙头打开工作表并拉取标签 内向又漂出. 床单还设有"把按钮接到侧"的链接. 当一个人 离开按钮被记住.
在一个人移动之前,按钮保持远离页面自身的控制. 它从下角开始,并且,任何时候
页面更改、大小调整或停止滚动,查找最下端为空的边缘。 它仅停留在一行文字上
当空地在它的上方, 只有在整个边缘控制时, 才能控制。 接线
--fs-feedback-bottom 关掉它,把图标放在流出的地方.
将图标取出流出的一个屏幕(胶片,全屏幕图片),设定
--fs-feedback-display: none 例如,从流程的样式表开始,当屏幕打开时
:root:has(.film) { --fs-feedback-display: none; }。 。 。 .
每个屏幕的名字,所以一个报告说它来自哪里: document.body.dataset.pageKey = 'question-2'。 。 。 .
不可显示图标的页面( 投影墙) <html data-fs-feedback="off">。 。 。 .
完整 API 参考
见 Flowstate 开发者文件 用于完整的API参考、表格式、AI集成指南和提交程序.
许可证
麻省理工学院