Raycast 中文文档
  • 介绍
  • 链接
    • 官网
    • 官网 API 文档
    • 社区
    • GitHub
    • Store
    • Icon 生成器
    • 扩展图标模板
  • 基础
    • 起步
    • 创建您的第一个扩展
    • 贡献一个扩展
    • 过审一个扩展
    • 发布一个扩展
    • 调试一个扩展
    • 安装一个扩展
  • 团队
    • 开始
    • 发布私人扩展
    • 协作开发私有扩展
  • 例子
    • Doppler 共享 Secrets
    • Hacker News
    • Todo 列表
    • Spotify Controls
  • 资料
    • 最佳实践
    • 工具
      • CLI
      • ESLint
      • VS Code(社区工具)
    • 文件结构
    • 生命周期
      • 参数
      • 后台刷新
      • Deeplinks
    • Manifest
    • 安全性
    • 术语
    • 版本控制
  • API 参考
    • AI
    • Cache
    • Command
    • Clipboard
    • Environment
    • Feedback
      • Alert
      • HUD
      • Toast
    • Keyboard
    • Menu Bar Commands
    • OAuth
    • Preferences
    • Storage
    • System Utilities
    • 用户界面
      • Action Panel
      • Actions
      • Detail
      • Form
      • List
      • Grid
      • Colors
      • Icons & Images
      • Navigation
    • 窗口 & 搜索栏
  • 公共包
    • 起步
    • 功能
      • 执行 AppleScript
    • 图标
      • getAvatarIcon
      • getFavicon
      • getProgressIcon
    • React hooks
      • useCachedState
      • usePromise
      • useCachedPromise
      • useFetch
      • useForm
      • useExec
      • useSQL
      • useAI
  • 迁移
  • FAQ
由 GitBook 提供支持
在本页
  • 启动
  • launch 参数
  • 卸载
  1. 资料

生命周期

上一页文件结构下一页参数

最后更新于1年前

命令一般会启动,运行一段时间,然后卸载。

启动

当在 Raycast 中启动命令时,命令代码会立即执行。如果扩展导出默认函数,则会自动调用该函数。如果您在导出的默认函数中返回一个 React 组件,它将自动呈现为根组件。对于不需要用户界面的命令(清单中的mode 属性设置为 “no-view”),您可以导出异步函数并使用 async/await 执行 API 方法。

import { Detail } from "@raycast/api";

// Returns the main React component for a view command
export default function Command() {
  return <Detail markdown="# Hello" />;
}
import { showHUD } from "@raycast/api";

// Runs async. code in a no-view command
export default async function Command() {
  await showHUD("Hello");
}

有多种方法可以启动命令:

  • 用户在根搜索中搜索该命令并执行它

  • 用户注册该命令的别名并按下它

  • 另一个命令通过 启动该命令

  • 该命令在 启动

  • 已保存并由用户执行

  • 用户将该命令注册为 ,并在根搜索中没有结果时执行它

  • 用户单击

根据命令的启动方式,会不同的参数传递给导出的默认函数。

import { Detail, LaunchProps } from "@raycast/api";

// Access the different launch properties via the argument passed to the function
export default function Command(props: LaunchProps) {
  return <Detail markdown={props.fallbackText || "# Hello"} />;
}

launch 参数

属性
描述
类型

arguments*

使用这些值来填充命令的初始状态。

launchType*

命令的启动类型(用户启动或后台)。

draftValues

当用户通过草稿输入命令时,该对象将包含保存为草稿的用户输入。使用它的值来填充表单的初始状态。

fallbackText

当该命令作为备用命令启动时,该字符串包含根搜索的文本。

string

launchContext

当通过 launchCommand 以编程方式启动命令时,该对象包含传递给 context的值。

卸载

卸载命令时(通常通过弹出回根搜索查看命令或在脚本完成无视图命令后),Raycast 将从内存中卸载整个命令。请注意,命令有内存限制,如果超出这些限制,命令将被终止,并且用户将看到一条错误消息。

后台
fallback 命令
深度链接
LaunchType
Arguments
LaunchContext
launchCommand
表单的草稿
Form.Values