From 930eec56f18684bb0371fffc11a1c0636e858109 Mon Sep 17 00:00:00 2001 From: Erin Donehoo Date: Tue, 24 Oct 2023 13:39:16 -0400 Subject: [PATCH] (docs: warning-modal) Adjusts example documentation. --- .../component-groups/examples/WarningModal/WarningModal.md | 7 ++++--- 1 file changed, 4 insertions(+), 3 deletions(-) diff --git a/packages/module/patternfly-docs/content/extensions/component-groups/examples/WarningModal/WarningModal.md b/packages/module/patternfly-docs/content/extensions/component-groups/examples/WarningModal/WarningModal.md index 21dd2eb8..ffd710d4 100644 --- a/packages/module/patternfly-docs/content/extensions/component-groups/examples/WarningModal/WarningModal.md +++ b/packages/module/patternfly-docs/content/extensions/component-groups/examples/WarningModal/WarningModal.md @@ -15,14 +15,15 @@ propComponents: ['WarningModal'] import WarningModal from '@patternfly/react-component-groups/dist/dynamic/WarningModal'; -A **warning modal** component displays a modal asking user to confirm his intention to perform a risky action. +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 component provides users with a basic layout to which only specific texts need to be passed. -Action buttons callbacks can be customized using `onConfirm` and `onClose`. +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 `` component. To customize the action buttons in the modal, use `onConfirm` and `onClose`. ```js file="./WarningModalExample.tsx"