Deprecate Modal

hypothesis · Apr 17, 2023 · ea7ebf6 · ea7ebf6
1 parent dd8e390
commit ea7ebf6
Show file tree

Hide file tree

Showing 2 changed files with 14 additions and 0 deletions.
diff --git a/src/components/feedback/Modal.tsx b/src/components/feedback/Modal.tsx
@@ -36,6 +36,7 @@ const noop = () => {};
 
 /**
  * Show a modal
+ * @deprecated - Use `ModalDialog` instead
  */
 const ModalNext = function Modal({
   children,

diff --git a/src/pattern-library/components/patterns/feedback/ModalPage.tsx b/src/pattern-library/components/patterns/feedback/ModalPage.tsx
@@ -103,6 +103,19 @@ export default function ModalPage() {
           </p>
         }
       >
+        <Library.Pattern title="Status">
+          <Library.Changelog>
+            <Library.ChangelogItem status="deprecated">
+              This implementation of
+              <s>
+                <code>Modal</code>
+              </s>{' '}
+              is deprecated. Use
+              <code>ModalDialog</code> or <code>Dialog</code> instead, which
+              provide a similar API and enhanced accessibility.
+            </Library.ChangelogItem>
+          </Library.Changelog>
+        </Library.Pattern>
         <Library.Pattern title="Usage">
           <Library.Usage componentName="Modal" />
           <Library.Demo title="Basic modal" withSource>