Raycast 扩展技能

使用 React、TypeScript 和 Raycast API 构建强大的扩展。

快速开始（代理工作流）

当需要实现或修复 Raycast 功能时，请遵循以下步骤：

1. 确定核心组件：判断 UI 是否需要列表、网格、详情视图或表单。
2. 查阅参考文档：打开并阅读references/api/目录下的对应文件（例如references/api/list.md）。
3. 使用默认值：
   • 反馈：使用显示提示用于加载/成功/失败状态。仅对快速后台完成使用显示进度指示器。
   • 数据：频繁/临时数据使用缓存，本地存储用于持久性用户数据。
   • 访问：使用前始终检查environment.canAccess(AI)或environment.canAccess(BrowserExtension)。
4. 实现：使用@raycast/api组件提供简洁的实现。
5. 引用：链接回你所使用的具体references/api/*.md文件。

菜谱模式

1. 列表与网格（可搜索界面）

使用列表处理以文本为主的数据，使用网格处理以图像为主的数据。

• 列表参考|网格参考

<List isLoading={isLoading} searchBarPlaceholder="Search items..." throttle>
  <List.Item
    title="Item Title"
    subtitle="Subtitle"
    accessories={[{ text: "Tag" }]}
    actions={
      <ActionPanel>
        <Action.Push title="View Details" target={<Detail markdown="# Details" />} />
        <Action.CopyToClipboard title="Copy" content="value" />
      </ActionPanel>
    }
  />
</List>

2. 详情（丰富的Markdown）

用于显示长篇内容或项目详情。

• 详情参考

<Detail
  isLoading={isLoading}
  markdown="# Heading\nContent here."
  metadata={
    <Detail.Metadata>
      <Detail.Metadata.Label title="Status" text="Active" icon={Icon.Checkmark} />
    </Detail.Metadata>
  }
/>

3. 表单（用户输入）

始终包含一个提交表单操作。

• 表单参考

<Form
  actions={
    <ActionPanel>
      <Action.SubmitForm onSubmit={(values) => console.log(values)} />
    </ActionPanel>
  }
>
  <Form.TextField id="title" title="Title" placeholder="Enter title" />
  <Form.TextArea id="description" title="Description" />
</Form>

4. 反馈与交互

对于大多数反馈，推荐使用显示提示消息。

• 提示消息参考|HUD参考

// Success/Failure
await showToast({ style: Toast.Style.Success, title: "Success!" });

// HUD (Overlay)
await showHUD("Done!");

5. 数据持久化

使用缓存以提升性能，本地存储以实现持久化。

• 缓存参考|存储参考

// Cache (Sync/Transient)
const cache = new Cache();
cache.set("key", "value");

// LocalStorage (Async/Persistent)
await LocalStorage.setItem("key", "value");

6. AI 与浏览器扩展（受限 API）

务必通过environment.canAccess检查进行封装。

• AI 参考|浏览器参考

if (environment.canAccess(AI)) {
  const result = await AI.ask("Prompt");
}

if (environment.canAccess(BrowserExtension)) {
  const tabs = await BrowserExtension.getTabs();
}

附加资源

API 参考树

• UI 组件
  • 操作面板
  • 详情
  • 表单
  • 网格
  • 列表
  • 用户界面
• 交互性
  • 操作
  • 警报
  • 键盘
  • 导航
  • Raycast窗口搜索栏
• 实用工具与服务
  • 人工智能
  • 浏览器扩展
  • 剪贴板
  • 环境
  • 反馈与HUD
    • HUD
    • 提示框
  • OAuth
  • 系统工具
• 数据与配置
  • 缓存
  • 颜色
  • 图标与图像
  • 偏好设置
  • 存储
• 高级
  • 命令相关工具
  • 菜单栏命令
  • 工具
  • 窗口管理

示例

如需查看结合了多个组件和API的端到端示例，请参阅examples.md文件。