@archbee/app-widget

中文文档
1.1.43发布于 2026/10/20UNLICENSEDES Module近 30 天下载 1781
中文使用文档
文档目录8 节
  1. 目录
  2. 安装
  3. API 文档
  4. 实例
  5. 组件道具
  6. 泡泡声
  7. 查找方法
  8. 演示文稿

Archbee 重现组件部件

目录

安装

要安装、使用 小时数字 :

$ pnpm add @archbee/app-widget

如果您需要安装Archbee Control Widget SDK, 您可以找到更多细节 这里。 。 。 .

API 文档

Archbee React 组件部件的主要文档可见于 文档,它描述了API 并举例说明其用法.

实例

以下是Archbee React 部件在应用程序中使用的简单例子

import React from 'react'
import { ArchbeeAppWidget } from '@archbee/app-widget'

function App() {
  return (
    <div>
      <ArchbeeAppWidget
        spaceId={/** published space id **/}
        onWidgetOpen={() => {
          /** ... **/
        }} // callback function called after widget has open
        // onWidgetClose={() => { /** ... **/ }} // callback function called after widget has open
      >
        <button type="button">Open</button>
      </ArchbeeAppWidget>
    </div>
  )
}

ReactDOM.render(<App />, appElement)

也可以采用比较有方案的办法:

import React from 'react';
import { ArchbeeAppWidget, AbWidgetRef } from '@archbee/app-widget'

function App() {
const widgetRef = useRef<AbWidgetRef>(null);

  return (
    <div>
        <ArchbeeAppWidget
            ref={widgetRef}
            spaceId={ /** published space id **/ }
            onWidgetOpen={() => { /** ... **/ }} // callback function called after widget has open
            onWidgetClose={() => { /** ... **/ }} // callback function called after widget has open
      >
        <button type='button' onClick={() => {
        <!-- Opens widget -->
            widgetRef.current?.open();
        }}>
          Open
        </button>

        <button type='button' onClick={() => {
        <!-- Closes widget -->
            widgetRef.current?.close();
        }}>
          Close
        </button>

        <button type='button' onClick={() => {
        <!-- Gets the instance of the widget if needed for various event manipulations. -->
            widgetRef.current?.instance();
        }}>
          Get widget instance
        </button>
      </ArchbeeAppWidget>
    </div>
  );
}

ReactDOM.render(<App />, appElement);

组件道具

财产类型需求说明
spaceIdstringrequired通过理想的ID来装入您的文档.
docIdstringoptional要打开部件文件的医生。 若为 docId 已经通过, widgetType 无论道具是否通过,它都会以 docs 模式打开.
blockIdstringoptional某个文档打开后要滚动的块 .
jwtstringoptional传出jwt 令牌,以便看到 jwt 受保护的文档 .
shareableTokenstringoptional从您的私人链接中传递可共享的托肯来保护您的文档 .
classNamestringoptional将 CSS 课程传给 div 包装
widgetTypedocs | searchoptional默认值是 docs。此选项将打开部件,并带有所期望的行为. docs`` type will open the widget with the default behaviour, 搜索 ` 将打开一个显示有 AI 支持的搜索栏的搜索部件栏( 如果包含在您的订阅中)
bubbleask | invisibleoptional默认值是 invisible。此道具将显示您屏幕右下方的询问泡。 当有人点击它时, 搜索部件会打开 .
loadingStrategyeager | lazyoptional默认值是 lazy。虽然 lazy 加载延迟资源初始化, eager 执行代码后立即加载或初始化部件.
anchorstringoptional你可以提供你的 class, (中文(简体) ), id 或者说 path 到 DOM 元素中,您想要部件锁定和即时启动 。 提供的集装箱应具有 position: relative ,因为部件将基于所找到的第一个相对父文件显示.
onWidgetOpenvoidoptional在部件打开后调用 .
onWidgetClosevoidoptional在部件关闭后调用 .
hideNavbarbooleanoptional默认值是 false。它隐藏了标题导航符与模式.
initialSearchQuerystringoptional预集搜索输入,并在部件打开时触发搜索。 使用方式 widgetType: "search" 打开已显示结果的部件.

泡泡声

使用 bubble 要浏览整个文档,请选择一个简单的搜索按钮.

Ask search bubble

查找方法

若为 ref 未转至 ArchbeeAppWidget时,孩子会自动打开模式弹出.

财产类型说明
openmethod程序化打开部件 .
closemethod程序关闭部件 .
instancemethod返回部件实例.

演示文稿

下面是演示设置 代码框,哪个 展示出拱蜂应用的各种特征:

版本与发布记录

@archbee/app-widget 共发布 104 个版本,首次发布于 2023/11/17;过去 12 个月发布了 10 个版本。

版本发布日期距今
1.1.43latest2026/10/2018 天前
1.1.422026/05/295 个月前
1.1.412026/05/225 个月前
1.1.402026/05/225 个月前
1.1.392026/05/086 个月前
1.1.382026/05/086 个月前

关于 @archbee/app-widget 的常见问题

@archbee/app-widget 是什么?

安装 - 说吧 API 文档 - 说吧 实例

如何安装 @archbee/app-widget?

在项目目录运行 npm install @archbee/app-widget,或使用 pnpm add / yarn add / bun add。它还需要宿主项目提供 peer 依赖:react(^18.2.0 || ^19.0.0)、react-dom(^18.2.0 || ^19.0.0)。npm 7 及以上与 pnpm 8 及以上默认会自动安装必需的 peer 依赖,Yarn 需要手动安装。

@archbee/app-widget 支持 TypeScript 吗?

该包的 package.json 没有声明类型入口。需要类型提示时,可以在 npm 上查找社区维护的 @types/archbee__app-widget 是否存在。

@archbee/app-widget 支持 ESM 还是 CommonJS?

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

@archbee/app-widget 可以商用吗?

@archbee/app-widget 使用 UNLICENSED 许可。作者声明为 UNLICENSED,即不授予公开使用许可(与公共领域的 Unlicense 不同)。使用前需获得作者授权。以上为概括,不构成法律意见,请以许可原文为准。

@archbee/app-widget 的下载量有多少?

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

@archbee/app-widget 还在维护吗?

最新版本 1.1.43 发布于 2026/10/20(18 天前);至今共发布 104 个版本,其中过去 12 个月发布了 10 个;首次发布于 2023/11/17。发布频率只是参考信号:功能稳定的工具可能很少需要更新,建议结合源码仓库的 issue 和提交记录判断。