WarningModal.md

section	Extensions
subsection	Component groups
id	Warning modal
source	react
propComponents	WarningModal
sourceLink	https://github.com/patternfly/react-component-groups/blob/main/packages/module/patternfly-docs/content/extensions/component-groups/examples/WarningModal/WarningModal.md

import WarningModal from '@patternfly/react-component-groups/dist/dynamic/WarningModal'; import { FunctionComponent, useState } from 'react';

A warning modal component displays a modal when a user tries to perform a risky action, which asks them to confirm or cancel the action.

Examples

Basic warning modal

A basic warning modal is triggered when a user tries to perform an action that is deemed risky.

You can customize the contents of the modal to fit your use cases. To adjust the text in the modal, pass your desired title to title and your message to the <WarningModal> component. To customize the action buttons in the modal, use onConfirm and onClose.

For further customization, you can utilize all properties of the modal component, with the exception of ref.

Warning modal with a custom button variant

You can apply custom variant to a warning modal's confirmation button.

Warning modal with a checkbox

To confirm that a user wishes to initiate a selected action, you can add a checkbox to a warning modal.

Warning modal with a text confirmation

To ensure the user intentionally initiates a selected action, you can add a confirmation text input.