# @glasshome/widget-sdk 中文文档

规范地址：https://npmcn.com/package/%40glasshome/widget-sdk/

版本：1\.32\.3
npm 元数据更新时间：2026-11-15T21:40:46.052Z
中文译文更新时间：2026-11-16T15:36:06.977Z
软件包许可：MIT

本文由上游 README 翻译，可能存在偏差，请结合原文核对 API、命令与配置。版权与许可归原作者所有。

原始 npm 页面：https://www.npmjs.com/package/%40glasshome/widget-sdk
原文对照：https://npmcn.com/package/%40glasshome/widget-sdk/?lang=original
项目主页：https://github.com/glasshome/widget-sdk#readme
源码仓库：https://github.com/glasshome/widget-sdk

## 关键信息（来自 npm 元数据）

- 包体积（解压后）：433 kB，94 个文件
- 模块格式：ES Module
- TypeScript 类型：包内自带
- Node.js 要求：\>=18
- 运行依赖：9 个
- peer 依赖：solid-js ^1\.9\.11，@glasshome/ui 1\.37\.0，@glasshome/sync-layer 0\.9\.1
- 首次发布：2026-03-22T22:16:35.726Z
- 最新版本发布：2026-11-15T21:40:45.680Z
- 近 30 天下载量：3628（2026-10-17 至 2026-11-15，npm 官方下载统计）
- 已发布版本数：81（近 12 个月 81 个）

## 中文简介

SDK 用于建造带有 SolidJS 的 GlassHome 仪表板部件

## 安装

```sh
npm install @glasshome/widget-sdk
```

也可以使用：`pnpm add @glasshome/widget-sdk`、`yarn add @glasshome/widget-sdk`、`bun add @glasshome/widget-sdk`

## README

# @ glasshome/ widget- sdk

SDK用于建造有SolidJS的GlassHome仪表板部件.

提供 `defineWidget`,反应实体绑定,框架组件/呼克,用于部件开发的Vite插件,以及 Tailwind v4 源路径——您需要构建、预览和传输部件的所有内容 [格拉斯之家](https://glasshome.app/)本地首个家庭助理仪表板 开始于 [部件开发指南](https://glasshome.app/docs/widget-development)。 。 。 .

## 安装

```bash
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:定义部件,创建反应实体绑定,并使用框架组件/呼克.

```tsx
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 插件 。 处理部件捆绑、预览服务器和注册生成.

```typescript
// vite.config.ts
import { defineConfig } from "vite";
import { glasshomeWidget } from "@glasshome/widget-sdk/vite";

export default defineConfig({
  plugins: [glasshomeWidget()],
});
```

插件接受可选选项 `entry` 选项(默认为 `"src/index.tsx"`:

```typescript
glasshomeWidget({ entry: "src/my-widget.tsx" });
```

### `@glasshome/widget-sdk/tailwind-sources` – 尾风 v4 CSS 源代码

规定 a `@source` tailwind v4 指令, 因此编译器会扫描类名的部件 SDK 源文件 .

```css
/* 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)")` 解答设备的设置,这与家庭遵循时间表或太阳时的家庭模式不同.

```tsx
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运行时间 |

## 许可证

麻省理工学院

## 常见问题

### @glasshome/widget-sdk 是什么？

SDK 用于建造带有 SolidJS 的 GlassHome 仪表板部件

### 如何安装 @glasshome/widget-sdk？

在项目目录运行 npm install @glasshome/widget-sdk，或使用 pnpm add / yarn add / bun add。它还需要宿主项目提供 peer 依赖：solid-js（^1\.9\.11）、@glasshome/ui（1\.37\.0）、@glasshome/sync-layer（0\.9\.1）。npm 7 及以上与 pnpm 8 及以上默认会自动安装必需的 peer 依赖，Yarn 需要手动安装。

### @glasshome/widget-sdk 支持 TypeScript 吗？

支持。包内自带 TypeScript 类型声明（package\.json 声明了 types 入口），安装后即可获得类型提示，无需再安装 @types 包。

### @glasshome/widget-sdk 支持 ESM 还是 CommonJS？

以 ES Module 形式发布，推荐使用 import 引入。在 CommonJS 项目中，Node\.js 20\.19\+ / 22\.12\+ 可以直接 require\(\) 不含顶层 await 的 ES Module，更早的版本需要改用动态 import\(\)。

### @glasshome/widget-sdk 需要什么版本的 Node\.js？

package\.json 的 engines 字段要求 Node\.js \>=18。版本不符时 npm 默认只给出警告，开启 engine-strict 后会拒绝安装。

### @glasshome/widget-sdk 可以商用吗？

@glasshome/widget-sdk 使用 MIT 许可。宽松许可：允许商业使用、修改和再分发，通常只需在分发时保留原版权与许可声明。以上为概括，不构成法律意见，请以许可原文为准。

### @glasshome/widget-sdk 的下载量有多少？

根据 npm 官方下载统计，@glasshome/widget-sdk 在 2026/10/17 – 2026/11/15 这 30 天内被下载 3,628 次，日均约 121 次。下载量会把 CI 构建、镜像同步和作为其他包依赖的安装一并计入，适合横向比较热度，不能直接等同于使用人数。

### @glasshome/widget-sdk 还在维护吗？

最新版本 1\.32\.3 发布于 2026/11/16（今天）；至今共发布 81 个版本，其中过去 12 个月发布了 81 个；首次发布于 2026/03/23。发布频率只是参考信号：功能稳定的工具可能很少需要更新，建议结合源码仓库的 issue 和提交记录判断。

