@rahdar/plugin-sdk

中文文档
2026.11.1发布于 2026/11/02Apache-2.0TypeScriptES Module构建来源已验证

构建一个Rahdar插件的UI:一个插件可能使用的Rahdar api的类型,以及一个Vite预设。

中文使用文档

@rahdar / plugin-sdk

构建一个的UI Rahdar 插件。

  • 打字 对于插件UI可能从Rahdar中使用的所有内容:Rahdar自己根下的路由,插槽, 导航、API客户端、权限检查和共享组件。在运行时Rahdar提供 SDK本身,所以一个插件的包永远不会包含一个副本。
  • Vite预设 它将UI构建为一个模块联邦,远程使用React、Mantine和 来自拉达尔的TanStack。
// vite.config.ts
import { defineConfig } from 'vite';
import react from '@vitejs/plugin-react';
import { rahdarPlugin } from '@rahdar/plugin-sdk/vite';

export default defineConfig({ plugins: [react(), rahdarPlugin({ id: 'acme-notes' })] });
// src/feature.tsx
import { createRoute } from '@tanstack/react-router';
import { CONTRACT, clusterRoute, definePlugin, pluginPath, pluginView } from '@rahdar/plugin-sdk';

const notes = createRoute({
  getParentRoute: () => clusterRoute,
  path: pluginPath('acme-notes', 'notes'),
  component: pluginView('acme-notes', NotesView),
});

export default definePlugin({ contract: CONTRACT, id: 'acme-notes', routes: { cluster: [notes] } });

SDK的版本是构建它的Rahdar版本,它的对等依赖关系是精确的 Rahdar提供的React、Mantine和TanStack版本。根据最老的Rahdar的SDK构建 您的插件支持(rahdar.since 在 plugin.json)。

导游: https://rahdar.dev/guide/plugins.

版本与发布记录

@rahdar/plugin-sdk 共发布 12 个版本,首次发布于 2026/10/14;过去 12 个月发布了 12 个版本。最新版本附带 npm provenance 构建来源证明,可追溯到公开的 CI 构建记录。

版本发布日期距今
2026.11.1latest2026/11/021 天前
2026.11.02026/11/021 天前
2026.10.662026/10/304 天前
2026.10.642026/10/294 天前
2026.10.592026/10/276 天前
2026.10.582026/10/2113 天前

关于 @rahdar/plugin-sdk 的常见问题

@rahdar/plugin-sdk 是什么?

构建一个Rahdar插件的UI:一个插件可能使用的Rahdar api的类型,以及一个Vite预设。

如何安装 @rahdar/plugin-sdk?

在项目目录运行 npm install @rahdar/plugin-sdk,或使用 pnpm add / yarn add / bun add。它还需要宿主项目提供 peer 依赖:vite(>=8)、react(19.3.1)、react-dom(19.3.1)、@mantine/core(9.7.4)、@mantine/hooks(9.7.4)、@tanstack/react-query(5.104.5)、@tanstack/react-router(1.170.46)。npm 7 及以上与 pnpm 8 及以上默认会自动安装必需的 peer 依赖,Yarn 需要手动安装。

@rahdar/plugin-sdk 支持 TypeScript 吗?

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

@rahdar/plugin-sdk 支持 ESM 还是 CommonJS?

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

@rahdar/plugin-sdk 可以商用吗?

@rahdar/plugin-sdk 使用 Apache-2.0 许可。宽松许可:允许商业使用、修改和再分发,并附带明确的专利授权;分发时需保留许可与 NOTICE 文件,修改过的文件要注明改动。以上为概括,不构成法律意见,请以许可原文为准。

@rahdar/plugin-sdk 还在维护吗?

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