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.

API Reference

showHUD

A HUD will automatically hide the main window and show a compact message at the bottom of the screen.

Signature

1
async function showHUD(title: string): Promise<void>;
Copied!

Example

1
import { showHUD } from "@raycast/api";
2
3
export default async () => {
4
await showHUD("Hey there 👋");
5
};
Copied!

Parameters

Name
Type
Required
Description
title
string
Yes
The title that will be displayed in the HUD.

Return

A Promise that resolves when the HUD is shown.
Last modified 3d ago
Copy link
Edit on GitHub