usePrompt
This hook can be used to prompt the user for confirmation of an action.
Usage
import { usePrompt } from "@medusajs/ui"
1const dialog = usePrompt()2const actionFunction = async () => {3 const confirmed = await dialog({4 title: "Are you sure?",5 description: "Please confirm this action",6 })7}
API Reference
Call Signature
usePrompt()
usePrompt return
| Value | Type | Description |
|---|---|---|
dialog | function | Async function used to display a new confirmation dialog. |
Was this section helpful?
UsePromptProps
| Prop | Type | Default |
|---|---|---|
title | string | - |
description | string | - |
variant | "danger"| "confirmation" | "danger" |
verificationText | string | - |
verificationInstruction | string | "Please type {val} to confirm:" |
cancelText | string | "Cancel" |
confirmText | string | "Confirm" |
Was this section helpful?
Examples
Basic
Was this example helpful?
With Verification
Was this example helpful?