docs(modal): update documentation to include dismiss properties (hero…

…ui-inc#2217)
Innei · Feb 22, 2024 · f75174d · f75174d
1 parent ac0e564
commit f75174d
Show file tree

Hide file tree

Showing 2 changed files with 6 additions and 3 deletions.
diff --git a/apps/docs/content/components/modal/non-dismissable.ts b/apps/docs/content/components/modal/non-dismissable.ts
@@ -6,7 +6,7 @@ export default function App() {
   return (
     <>
       <Button onPress={onOpen}>Open Modal</Button>
-      <Modal isOpen={isOpen} onOpenChange={onOpenChange} isDismissable={false}>
+      <Modal isOpen={isOpen} onOpenChange={onOpenChange} isDismissable={false} isKeyboardDismissDisabled={true}>
         <ModalContent>
           {(onClose) => (
             <>

diff --git a/apps/docs/content/docs/components/modal.mdx b/apps/docs/content/docs/components/modal.mdx
@@ -60,8 +60,11 @@ When the modal opens:
 
 ### Non-dissmissable
 
-By default the modal can be closed by clicking on the overlay or pressing the <Kbd>Esc</Kbd> key.
-You can disable this behavior by setting the `isDismissable` prop to `false`.
+By default, the modal can be closed by clicking on the overlay or pressing the <Kbd>Esc</Kbd> key. 
+You can disable this behavior by setting the following properties:
+
+- Set the `isDismissable` property to `false` to prevent the modal from closing when clicking on the overlay.
+- Set the `isKeyboardDismissDisabled` property to `true` to prevent the modal from closing when pressing the Esc key.
 
 <CodeDemo title="Non-dissmissible" files={modalContent.nonDismissable} />