зеркало из
1
0
Форкнуть 0

Add depreciated note to README

This commit is contained in:
Owen Niblock 2022-09-21 17:43:17 +01:00 коммит произвёл GitHub
Родитель e1aece5dec
Коммит 77964a882f
Не найден ключ, соответствующий данной подписи
Идентификатор ключа GPG: 4AEE18F83AFDEB23
1 изменённых файлов: 13 добавлений и 1 удалений

Просмотреть файл

@ -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.
Distributed under the MIT license. See LICENSE for details.