cf-alert v0.4.1

cf-alert

An alert dialog implementation made with campfire.js.

Usage

Import it from esm.sh:

import { confirm, input, message } from "https://esm.sh/cf-alert";

Then perform your method call.

await message("Hello!");

Note that this alert comes without any styling by default - you can copy it from style.css or write your own!

API

function message(
  text: string,
  title?: string,
  customLabel?: string,
  safeBody = true,
): Promise<void>;

An alert dialog box.

• text The message that will be displayed.
• customLabel Custom label for the "OK" button.
• title The title that will be displayed for the box. Defaults to "Info".
• safeBody Defaults to true. A boolean representing whether the body of the dialog should be escaped or not.

This method returns a Promise that resolves when the user clicks the "OK" button.

function fatal(
  text: string,
  title = "Error",
  safeBody = true,
): Promise<void>;

A fatal error dialog box.

• text The message that will be displayed.
• title The title that will be displayed for the box. Defaults to "Error".
• safeBody Defaults to true. A boolean representing whether the body of the dialog should be escaped or not.

This method returns a promise that will never resolve.

function input(
  type: string,
  text: string,
  title?: string,
  safeBody = true,
): Promise<unknown>;

An input dialog box.

• type The HTML type of the input element, for example text, password, or number. Also supports textarea.
• text The text message to display in the input box.
• title The title that will be displayed for the box. Defaults to "Input".
• safeBody Defaults to true. A boolean representing whether the body of the dialog should be escaped or not.

This method returns a Promise that resolves to the user's input. No validation is performed, and the promise rejects if the user clicks the cancel button.

interface CustomLabels {
  yes?: string;
  no?: string;
}

function confirm(
  text: string,
  customLabels: CustomLabels,
  title?: string,
  safeBody = true,
): Promise<boolean>;

A confirm dialog box.

• text The message for the confirm box.
• customLabels Custom labels for the yes and no buttons.
• title The title that will be displayed for the box. Defaults to "Are you sure?".
• safeBody Defaults to true. A boolean representing whether the body of the dialog should be escaped or not.

This method returns a Promise that resolves to either true or false depending on the user's selection.