From 77964a882fd801a23fe7d4b10e14b6158f354ce1 Mon Sep 17 00:00:00 2001 From: Owen Niblock Date: Wed, 21 Sep 2022 17:43:17 +0100 Subject: [PATCH 1/2] Add depreciated note to README --- README.md | 14 +++++++++++++- 1 file changed, 13 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index 679a4ca..c40882e 100644 --- a/README.md +++ b/README.md @@ -2,6 +2,18 @@ A modal dialog opened with a <details> button. +## DEPRECIATED WARNING + +This web component has been depreciated. There are a number of accessibility concerns with this approach and so we no longer recommend using this component. + +### Accessibility and Usability Concerns + +* Semantically, using a details-summary pattern for a dialog solution can be confusing for screen reader users. +* If the user performs a "find in page" operation on a website using details-dialog elements, the content on those elements will appear when they shouldn't. +* Opening the dialog does not disable scrolling on the underlying page. + +GitHub are moving towards using [a dialog Primer View Component](https://primer.style/view-components/components/alpha/dialog) which enforces certain aspects of the design (such as always having a close button and a title). + ## Installation Available on [npm](https://www.npmjs.com/) as [**@github/details-dialog-element**](https://www.npmjs.com/package/@github/details-dialog-element). ``` @@ -87,4 +99,4 @@ Browsers without native [custom element support][support] require a [polyfill][] ## License -Distributed under the MIT license. See LICENSE for details. \ No newline at end of file +Distributed under the MIT license. See LICENSE for details. From efa494eb6617d2f29a38c63093f4e621eac89b15 Mon Sep 17 00:00:00 2001 From: Owen Niblock Date: Wed, 21 Sep 2022 18:12:16 +0100 Subject: [PATCH 2/2] deprecated not depreciated Co-authored-by: Manuel Puyol --- README.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/README.md b/README.md index c40882e..584b164 100644 --- a/README.md +++ b/README.md @@ -2,9 +2,9 @@ A modal dialog opened with a <details> button. -## DEPRECIATED WARNING +## DEPRECATION WARNING -This web component has been depreciated. There are a number of accessibility concerns with this approach and so we no longer recommend using this component. +This web component has been deprecated. There are a number of accessibility concerns with this approach and so we no longer recommend using this component. ### Accessibility and Usability Concerns