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

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

Example

import { showHUD } from "@raycast/api";
export default async () => {
await showHUD("Hey there 👋");
};

Parameters

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

Return

A Promise that resolves when the HUD is shown.
Last modified 3mo ago
Copy link
Edit on GitHub
On this page
API Reference
showHUD