@ glasshome/ widget- sdk
SDK用于建造有SolidJS的GlassHome仪表板部件.
提供 defineWidget,反应实体绑定,框架组件/呼克,用于部件开发的Vite插件,以及 Tailwind v4 源路径——您需要构建、预览和传输部件的所有内容 格拉斯之家本地首个家庭助理仪表板 开始于 部件开发指南。 。 。 .
安装
npm install @glasshome/widget-sdk solid-js
# or
bun add @glasshome/widget-sdk solid-js
solid-js ^1.9.11是一个必要的同伴依赖.
子路径导入
@glasshome/widget-sdk - SDK API 软件
核心部件 API:定义部件,创建反应实体绑定,并使用框架组件/呼克.
import { defineWidget, createEntity, SDK_VERSION } from "@glasshome/widget-sdk";
const entity = createEntity("light.living_room");
export default defineWidget({
manifest: {
tag: "glasshome-my-widget",
type: "status",
name: "My Widget",
size: "small",
sdkVersion: "^0.1.0",
defaultConfig: { label: "Hello" },
},
component: (props) => <div>{props.config.label}</div>,
});
部件保持小值, 跨越重载( 最近取出, 最后一个标签) useWidgetState(key, schema, fallback),由主机保存,用于此部件和这个人. localStorage 是在内存中,在重新装入后为空.
@glasshome/widget-sdk/vite - Vite 插件
部件开发的 Vite 插件 。 处理部件捆绑、预览服务器和注册生成.
// vite.config.ts
import { defineConfig } from "vite";
import { glasshomeWidget } from "@glasshome/widget-sdk/vite";
export default defineConfig({
plugins: [glasshomeWidget()],
});
插件接受可选选项 entry 选项(默认为 "src/index.tsx":
glasshomeWidget({ entry: "src/my-widget.tsx" });
@glasshome/widget-sdk/tailwind-sources – 尾风 v4 CSS 源代码
规定 a @source tailwind v4 指令, 因此编译器会扫描类名的部件 SDK 源文件 .
/* In your widget's CSS entrypoint */
@import "tailwindcss";
@source "@glasshome/widget-sdk/tailwind-sources";
黑暗模式
用 Tailwind 的样式 dark: 变量和主题变量(var(--foreground), (中文(简体) ), var(--card):它们遵循每个引擎和每个SDK版本的家用模式. 对于逻辑,呼叫 isDark();在备忘或效果内,当家用交换模式时,它再次运行. matchMedia("(prefers-color-scheme: dark)") 解答设备的设置,这与家庭遵循时间表或太阳时的家庭模式不同.
import { isDark } from "@glasshome/widget-sdk";
import { createMemo } from "solid-js";
const palette = createMemo(() => (isDark() ? DARK_COLORS : LIGHT_COLORS));
当部件拥有其视觉表面时, 逃出模式
大多数部件通过频道 API 路由 : <Widget tone> 编号 : <Widget color colorTo> 编号 : <Widget.Icon color>。少量部件有意拥有整个视觉表面并绕过频道。 这些是辅助出逃模式,而不是反标.
天气, 完整背景场景
这个 weather 部件生成一个 <WeatherBackground condition> 完全由动画中的条件场景(阳光、雨滴、雪粒)取代外壳梯度的组件。 通道 vars 不适用于外壳; Widget.Icon color 仍然每个条件都会收到一个 CSS 字符串,用于图标徽章.
媒体播放器, 阴道梯度
这个 media-player 部件组成自定义 <VinylRecord> 带有相册艺术光圈覆盖的元素。 视觉特征是内容驱动(album artifics)而不是音调驱动;频道底色在下方保持中性.
面积,每克避孕药颜色
这个 area 元件使快闪光量的药丸(CO2 交通灯光、湿度范围、温度),每颗药丸的颜色编码了度量的 语义状态 (CO2 绿色/琥珀/红色,湿度干燥/舒适/湿润)。 这些每分量的颜色规则是故意的语义每分量,而不是由通道驱动的,并且生活在部件本身的帮助中.
如果部件需要完整的视觉控制(图表、视频流、自定义动画表面),则遵循这些模式: <Widget> 外壳中性( 无) tone编号 :color把您的自定义 DOM 放在里面 <Widget.Content>,并在部件的 README 中记录选择.
解决问题
| 变量 | 效果 |
|---|---|
GLASSHOME_WIDGET_NO_WORKER | 设定为 1 将制作 bun widget connect 检查每个重建在新的过程中, 而不是重新使用一个工人用于会话. |
同伴依赖关系
| 软件包 | 需求 | 页:1 |
|---|---|---|
solid-js | 对 | SolidJS反应原始和JSX运行时间 |
许可证
麻省理工学院