From 275789f24115d2292b03c1f0cbfe8b380a0c05c5 Mon Sep 17 00:00:00 2001 From: Ashutosh Palhare Date: Fri, 25 Sep 2026 22:26:38 +0530 Subject: [PATCH] docs(modal): clarify dismissible prop behavior Update documentation to correctly explain that the dismissible prop controls both the close button visibility and backdrop dismissal. --- apps/web/content/docs/components/modal.mdx | 8 ++++++-- 1 file changed, 6 insertions(+), 2 deletions(-) diff --git a/apps/web/content/docs/components/modal.mdx b/apps/web/content/docs/components/modal.mdx index d0cec7fd08..87399cf6ef 100644 --- a/apps/web/content/docs/components/modal.mdx +++ b/apps/web/content/docs/components/modal.mdx @@ -23,12 +23,16 @@ Using a `openModal` and `setOpenModal` state for the main React component should -## Backdrop dismissible +## Dismissible modal -To enable the modal to be dismissed when clicking outside of the component (ie. the backdrop) then you can pass the `dismissible` prop to the `` component from React. +To enable the close (X) button and allow the modal to be dismissed by clicking the backdrop or pressing the Escape key, pass the `dismissible` prop to the `` component. + +When `dismissible` is set to `true`, the close button will appear in the header and the `onClose` callback will be triggered when the user tries to close the modal. + + ## Pop-up modal Use this example by passing the `popup` prop from React to the modal component to show a dialog to the user asking for a decision such as when confirming an item deletion from the database.