# @dbx-tools/ui-lakebox 中文文档

规范地址：https://npmcn.com/package/%40dbx-tools/ui-lakebox/

版本：0\.9\.206
npm 元数据更新时间：2026-11-10T19:19:05.298Z
中文译文更新时间：2026-11-11T18:28:41.420Z
软件包许可：Apache-2\.0

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

原始 npm 页面：https://www.npmjs.com/package/%40dbx-tools/ui-lakebox
原文对照：https://npmcn.com/package/%40dbx-tools/ui-lakebox/?lang=original
项目主页：https://github.com/reggie-db/dbx-tools#readme
源码仓库：https://github.com/reggie-db/dbx-tools

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

- 包体积（解压后）：54.2 kB，12 个文件
- 模块格式：ES Module
- TypeScript 类型：包内自带
- 运行依赖：4 个
- peer 依赖：react ~19\.2\.4，react-dom ~19\.2\.4
- 首次发布：2026-10-15T08:40:37.557Z
- 最新版本发布：2026-11-10T19:19:04.851Z
- 近 30 天下载量：5189（2026-10-12 至 2026-11-10，npm 官方下载统计）
- 已发布版本数：53（近 12 个月 53 个）

## 中文简介

应用 Lakebox 的响应控制、用户服务和度量衡

## 安装

```sh
npm install @dbx-tools/ui-lakebox
```

也可以使用：`pnpm add @dbx-tools/ui-lakebox`、`yarn add @dbx-tools/ui-lakebox`、`bun add @dbx-tools/ui-lakebox`

## README

# @dbx-tools/ui-lakebox (英语)

Render Lakebox 寿命周期控制、用户服务和实况机器计量 a AppKit React 应用程序.

## 将湖箱页面渲染

```tsx
import { LakeboxIndicator, LakeboxPanel } from "@dbx-tools/ui-lakebox/react";

export function LakeboxPage() {
  return (
    <>
      <header>
        <LakeboxIndicator />
      </header>
      <LakeboxPanel />
    </>
  );
}
```

在 Tailwind 和您的 AppKit 用户界面主题之后导入样式表 :

```css
@import "@dbx-tools/ui-lakebox/styles.css";
```

面板显示开始和停止控制,当前用户的终端,桌面, 图像服务、有界日志和去除确认。 它流出CPU, 在"湖盒"运行时,内存,持续存储和网络度量.

该指标与聊天标题相匹配 。 它的弹出器有生命周期控制, 终端和台式发射器,以及紧凑的度量衡.

## 注册后端插件

反应组件需要 `@dbx-tools/appkit-lakebox` 在同一应用程序中 应用程序 :

```ts
import { createApp, lakebase, server } from "@databricks/appkit";
import { lakebox } from "@dbx-tools/appkit-lakebox";

await createApp({
  plugins: [server(), lakebase(), lakebox()],
});
```

后端插件发布 `basePath` 财务报告和审定财务报表 `routePrefix` 通过 AppKit 客户端 配置 。 UI读取了配置,从 `@dbx-tools/shared-lakebox`,并发出同源请求。 不复制插件 路径进入客户端.

## 直接使用浏览器客户端

使用 `LakeboxClient` 当您需要生命周期或服务动作时 提供的组件 :

```tsx
import { useLakeboxClient } from "@dbx-tools/ui-lakebox/react";

export function StartLakeboxButton() {
  const client = useLakeboxClient();
  return (
    <button type="button" onClick={() => void client.start()}>
      Start Lakebox
    </button>
  );
}
```

客户端提供状态,启动,停止,服务创建,服务启动和 停止、 服务去除、 边框日志、 当前度量标准以及 SSE 度量标准 流线.

## 理解用户界面行为

-   组件使用当前 AppKit 会话 。 他们从来不接受或储存 Databricks 证书.
-   当工作区没有湖箱时,小组报告情况.
-   打开指标开始状态和计量活动。 关闭它停止 指标的活度量流.
-   机器度量衡只在客户端观看时进行取样,所以UI 不保持闲置的湖箱 活动通过投票指标.
-   开始和停止 影响一个湖盒共享的应用程序。 服务控制 仅影响经认证的用户服务.
-   终端和桌面链接使用经认证的同源代理路由 。 这个 浏览器从不直接连接到SSH网关.

## 常见问题

### @dbx-tools/ui-lakebox 是什么？

应用 Lakebox 的响应控制、用户服务和度量衡

### 如何安装 @dbx-tools/ui-lakebox？

在项目目录运行 npm install @dbx-tools/ui-lakebox，或使用 pnpm add / yarn add / bun add。它还需要宿主项目提供 peer 依赖：react（~19\.2\.4）、react-dom（~19\.2\.4）。npm 7 及以上与 pnpm 8 及以上默认会自动安装必需的 peer 依赖，Yarn 需要手动安装。

### @dbx-tools/ui-lakebox 支持 TypeScript 吗？

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

### @dbx-tools/ui-lakebox 支持 ESM 还是 CommonJS？

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

### @dbx-tools/ui-lakebox 可以商用吗？

@dbx-tools/ui-lakebox 使用 Apache-2\.0 许可。宽松许可：允许商业使用、修改和再分发，并附带明确的专利授权；分发时需保留许可与 NOTICE 文件，修改过的文件要注明改动。以上为概括，不构成法律意见，请以许可原文为准。

### @dbx-tools/ui-lakebox 的下载量有多少？

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

### @dbx-tools/ui-lakebox 还在维护吗？

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