Skip to content

Commit 930eec5

Browse files
committed
(docs: warning-modal) Adjusts example documentation.
1 parent 6e0ab4b commit 930eec5

File tree

1 file changed

+4
-3
lines changed
  • packages/module/patternfly-docs/content/extensions/component-groups/examples/WarningModal

1 file changed

+4
-3
lines changed

packages/module/patternfly-docs/content/extensions/component-groups/examples/WarningModal/WarningModal.md

Lines changed: 4 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -15,14 +15,15 @@ propComponents: ['WarningModal']
1515

1616
import WarningModal from '@patternfly/react-component-groups/dist/dynamic/WarningModal';
1717

18-
A **warning modal** component displays a modal asking user to confirm his intention to perform a risky action.
18+
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.
1919

2020
## Examples
2121

2222
### Basic warning modal
2323

24-
A basic warning modal component provides users with a basic layout to which only specific texts need to be passed.
25-
Action buttons callbacks can be customized using `onConfirm` and `onClose`.
24+
A basic warning modal is triggered when a user tries to perform an action that is deemed risky.
25+
26+
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`.
2627

2728
```js file="./WarningModalExample.tsx"
2829

0 commit comments

Comments
 (0)