raycast-notifier

Send cross platform native notifications using Raycast

Install

npm i raycast-notifier

Usage

1. Setup prebuilds to your extension

Run npx raycast-notifier-setup under your extension project directory to setup notifier prebuilds to the assets folder.

2. Prepare prebuilds before running your extension

Remember to run preparePrebuilds() before you use any function from the raycast-notifier.

import { useEffect, useState } from "react";
import { List } from "@raycast/api";
import { notificationCenter, preparePrebuilds } from "raycast-notifier";

export default function Command() {
	const [isLoading, setIsLoading] = useState(true);

	const loadPrebuilds = async () => {
		await preparePrebuilds();
		setIsLoading(false);

		const result = await notificationCenter({
			title: "Raycast Notifier",
			subtitle: "Success",
			message: "Hello from Raycast!",
			reply: "Send greetings...",
		});

		const { response, metadata } = result;
		if (response === "replied") {
			console.log("Reply:", metadata?.activationValue);
		}
	};

	useEffect(() => {
		loadPrebuilds();
	}, []);

	return <List isLoading={isLoading} />;
}

API

preparePrebuilds()

This function programmatically copies the prebuilds files from assets/prebuilds to the correct directory for node-notifier.

notificationCenter(notifyOptions?, notifierOptions?)

This function is used to create a notify action of NotificationCenter.

Returns a Promise<NotifyResult>.

notifyOptions

Type: NotifyOptions

Optional. Options for node-notifier's notifier.notify(notifyOptions).

notifierOptions

Type: NotifierOptions

Optional. Options for node-notifier's new NotificationCenter(notifierOptions).

findRaycastNotificationCenterPath()

This method can be used to find the installed Notification Center from Raycast Notification.

Returns a Promise<string | undefined>.

import { open } from "@raycast/api";
import {
	findRaycastNotificationCenterPath,
	notificationCenter,
} from "raycast-notifier";

const found = await findRaycastNotificationCenterPath();

// ... You can lead user to the installation page if not found
open("raycast://extensions/maxnyby/raycast-notification");

notificationCenter(notifyOptions, { customPath: found });

FAQ

1. Not working on Apple Silicon

See mikaelbr/node-notifier#361 (comment).

2. Custom icon is not showing

This is a upstream issue from terminal-notifier.

Related

• node-notifier - Send cross platform native notifications using Node.js
• terminal-notifier - The command-line tool to send macOS User Notifications
• raycast-corss-extension - Defines the development approach for cross-extension in Raycast
• raycast-hid - Access USB & Bluetooth HID devices through Node.js

License

MIT