HUD
When the user takes an action that has the side effect of closing Raycast (for example when copying something in the Clipboard), you can use a HUD to confirm that the action worked properly.
A HUD will automatically hide the main window and show a compact message at the bottom of the screen.
async function showHUD(title: string, options?: { clearRootSearch?: boolean; popToRootType?: PopToRootType }): Promise<void>;
import { showHUD } from "@raycast/api";
export default async function Command() {
await showHUD("Hey there 👋");
}
showHUD closes the main window when called, so you can use the same options as closeMainWindow:import { showHUD } from "@raycast/api";
export default async function Command() {
await showHUD("Hey there 👋", { clearRootSearch: true, PopToRootType.Immediate });
}
Name | Description | Type |
|---|---|---|
title* | The title that will be displayed in the HUD. | string |
options | Can be used to control the behaviour after closing the main window. | Object |
options.clearRootSearch | Clears the text in the root search bar and scrolls to the top | boolean |
options.popToRootType | Defines the pop to root behavior (PopToRootType); the default is to to respect the user's "Pop to Root Search" preference in Raycast |
A Promise that resolves when the HUD is shown.
Last modified 9d ago