Skip to main content

ConfirmDeleteDialog

Storybook

Go to Story

ConfirmDeleteDialogProps

Defined in: src/molecules/ConfirmDeleteDialog/ConfirmDeleteDialog.tsx:26

Extends

  • ComponentProps<typeof Dialog>

Properties

PropertyTypeDescriptionInherited fromDefined in
children?ReactNode-ComponentProps.childrennode_modules/@radix-ui/react-dialog/dist/index.d.mts:10
open?boolean-ComponentProps.opennode_modules/@radix-ui/react-dialog/dist/index.d.mts:11
defaultOpen?boolean-ComponentProps.defaultOpennode_modules/@radix-ui/react-dialog/dist/index.d.mts:12
modal?boolean-ComponentProps.modalnode_modules/@radix-ui/react-dialog/dist/index.d.mts:14
entityName?ReactNodeName of the entity type being deleted. Provide in singular or plural form as appropriate for the context. Examples "user" — when deleting a single user "3 users" — when deleting multiple users-src/molecules/ConfirmDeleteDialog/ConfirmDeleteDialog.tsx:34
itemName?ReactNode | ReactNode[]Distinctive item identifier(s) shown before confirming deletion. Pass a single value or an array for bulk deletion. When more than 4 items are provided, only the first 2 are listed followed by "and N more". Examples "example@example.com" ["alice@example.com", "bob@example.com"]-src/molecules/ConfirmDeleteDialog/ConfirmDeleteDialog.tsx:43
onDeleteMouseEventHandler--src/molecules/ConfirmDeleteDialog/ConfirmDeleteDialog.tsx:44

Methods

onOpenChange()?

optional onOpenChange(open): void;

Defined in: node_modules/@radix-ui/react-dialog/dist/index.d.mts:13

Parameters
ParameterType
openboolean
Returns

void

Inherited from
ComponentProps.onOpenChange

ConfirmDeleteDialog()

function ConfirmDeleteDialog(__namedParameters): Element;

Defined in: src/molecules/ConfirmDeleteDialog/ConfirmDeleteDialog.tsx:99

A dialog component for confirming destructive actions like deletion. Built on top of the Dialog component, it provides a consistent interface for confirming irreversible actions.

Supports both single and bulk deletion via the itemName prop.

Parameters

ParameterType
__namedParametersConfirmDeleteDialogProps

Returns

Element

Examples

<ConfirmDeleteDialog
entityName="user"
itemName="john@example.com"
onDelete={handleDelete}
open={isOpen}
onOpenChange={setIsOpen}
/>
<ConfirmDeleteDialog
entityName="3 users"
itemName={["alice@example.com", "bob@example.com", "carol@example.com"]}
onDelete={handleDelete}
open={isOpen}
onOpenChange={setIsOpen}
/>