@brendanbank/atrium-host-types

类型脚本声明 ium 主机延伸合同.

import type {
  AtriumRegistry,
  AtriumNotification,
  AtriumEvent,
  UserContext,
  AdminUserRow,
} from '@brendanbank/atrium-host-types';

const reg = window.__ATRIUM_REGISTRY__ as AtriumRegistry;
reg.registerHomeWidget({ key: 'my-card', render: () => /* ... */ });

软件包是 仅类型 没有运行时间,没有JS有效载荷运行时间. 邦德勒斯将其从生产产出中剥离.

安装

pnpm add -D @brendanbank/atrium-host-types

该套件发布于公共npm注册. 没有 .npmrc, (中文(简体) ), 没有证明,没有PAT。 如果你在v.0.15.1和 有个 @brendanbank:registry=https://npm.pkg.github.com 线条在  .npmrc,删除它 — npmjs.org 是默认注册.

版本

包版本跟踪 Atrium的图像版本. 键 ^0.32 页:1 "可与原子0.32.x相兼容";与原子图像相撞 用于取取新的登记位置。 新建插槽 选项 成员 打开 AtriumRegistry 先是还没有撞倒的宿主 类型检查.

什么样的船

• AtriumRegistry ——每个 register* 槽原子曝光加 subscribeEvent。 。 。 .
• UserContext —— 说 /users/me/context 形状.
• AdminUserRow —— 说 /admin/users 排行形状.
• AtriumNotification ——通知行体.
• AtriumEvent 编号 : AtriumEventHandler ——SSE键入事件形状.
• 每秒选项包类型 : HomeWidget, (中文(简体) ), RouteEntry, (中文(简体) ), NavItem, (中文(简体) ), AdminTab, (中文(简体) ), ProfileItem, (中文(简体) ), NotificationKindRenderer, (中文(简体) ), LocaleOverlay。 。 。 .
• ProfileSlot, (中文(简体) ), HomeWidgetWidth ——弦联.
• A 类 declare global 块,该类型 window.React, (中文(简体) ), window.__ATRIUM_VERSION__,以及 window.__ATRIUM_REGISTRY__。 。 。 .

另见

• @brendanbank/atrium-host-bundle-utils —— 说 运行时帮助器,Vite预设和回放钩. 再出口类型 从这个软件包中,所以只添加一个 dep 的主机仍然得到 声明.
• docs/published-images.md - 那个 完整的主机扩展合同(图像目录、装载器行为、, 登记语义).
• docs/compat-matrix.md - 哪个 原子释放增加了哪个槽.