@sook/use-confirm

1.1.0 • Public • Published

@sook/use-confirm

React Hook to ask the user for a confirmation before executing a function.

Installation

yarn

yarn add @sook/use-confirm

npm

npm i @sook/use-confirm

Usage

import React from "react";
import useConfirm from "@sook/use-confirm";

function App() {
  const deleteWorld = () => console.log("Deleting world...");
  const confirmDelete = useConfirm("Are you sure?", deleteWorld);
  return <button onClick={confirmDelete}>Delete the world</button>;
}

Arguments

Argument Type Description Required
message string Message to show the user on the confirmation propmt yes
onConfirm function Function to be executed when the user confirms yes
onCancel function Function to be executed when the user cancels no

Return

Return value Type Description Default value
function function Function wrapped around the confirmation logic null

Package Sidebar

Install

npm i @sook/use-confirm

Weekly Downloads

0

Version

1.1.0

License

MIT

Unpacked Size

2.37 kB

Total Files

4

Last publish

Collaborators

  • sangriaholic