Defines the development approach for cross-extension in Raycast
npm install raycast-cross-extensionDefines the development approach for cross-extension in Raycast
[![raycast-cross-extension-badge]][raycast-cross-extension-link]
Raycast has tons of extensions so far. But most of them are standalone, it’s hard to use their ability from other extensions.
``shell`
npm i raycast-cross-extension
Add your target extension handle to the crossExtensions list of package.json.
This field allows providers to get to know who is using their extension. See maintenance.
`json`
{
"crossExtensions": ["target-extensions-author-name/target-extension-name"]
}
We recommend always using the crossLaunchCommand() API to launch cross-extensions even your extension doesn't use the callback launch feature.
You may need to catch exceptions from crossLaunchCommand() if the target command is not installed.open()
The redirects to the Store when crossLaunchCommand() errored.
#### Example
`typescript
import { LaunchType, open } from "@raycast/api";
import { crossLaunchCommand } from "raycast-cross-extension";
crossLaunchCommand({
name: "target-command-name",
type: LaunchType.UserInitiated,
extensionName: "target-extension-name",
ownerOrAuthorName: "target-extension-author-name",
context: {
foo: "foo",
bar: "bar",
},
}).catch(() => {
open(
"raycast://extensions/target-extension-author-name/target-extension-name",
);
});
`
Incoming parameters can be received from LaunchContext.
The callbackLaunchOptions is used for running the callback launchCommand() to the source extension.
Please note passing parameters through Arguments is not recommneded since it supports string only.
But a command with arguments is still useful if you want to reuse your existing arguments-based commands as the cross-extension entrance.
For exmaple, the Say extension is using the typeToSay arguments-based command for receiving cross-extension parameters.
#### Example
`typescript
import { LaunchProps } from "@raycast/api";
import { callbackLaunchCommand, LaunchOptions } from "raycast-cross-extension";
type LaunchContext = {
foo?: string;
bar?: string;
callbackLaunchOptions?: LaunchOptions;
};
export default function Command({
launchContext = {},
}: LaunchProps<{ launchContext?: LaunchContext }>) {
const { foo, bar, callbackLaunchOptions } = launchContext;
// ...
callbackLaunchCommand(callbackLaunchOptions, {
result: "hello, world",
});
}
`
#### options
Type: LaunchOptions
Options for launch the target command.
#### callbackOptions
Type: Partial
Optional. Options for launch the callback command. It will be used in the callback stage with default values below:
- name defaults to environment.commandName
- defaults to environment.extensionName
- defaults to environment.ownerOrAuthorName or the field in package.json
- defaults to LaunchType.UserInitiated
You can set it to false to disable command callback.
#### options
Type: LaunchOptions
Pass in launchContext.callbackLaunchOptions. This is used to load options for callback.
#### payload
Type: LaunchOptions['context']
Optional. Context data for sending back to consumer command.
When you make breaking changes, keep an eye out for other projects using your API.
You can search for your extension handle your-author-name/your-extension-name from the raycast/extension to find that extension using your extension.
Show the world your extension implemented Cross-Extension.
[![raycast-cross-extension-badge]][raycast-cross-extension-link]
`markdown``
- Badges - shields.io - Concise, consistent, and legible badges
- United Nations - Peace, dignity and equality on a healthy planet
- Brand Icons - simpleicons.org - Browse, search, and copy free SVG icons for popular brands
- Color Picker - A simple system-wide color picker
- Say - Spoken Content - macOS built-in Spoken Content interface
- PM2 - Manage even run your Node.js processes through Raycast
- raycast-pm2 - PM2 utilities for Raycast Extensions
CC0-1.0
[raycast-cross-extension-badge]: https://shields.io/badge/Raycast-Cross--Extension-eee?labelColor=FF6363&logo=raycast&logoColor=fff&style=flat-square
[raycast-cross-extension-link]: https://github.com/LitoMore/raycast-cross-extension-conventions