Thanks to visit codestin.com
Credit goes to github.com

Skip to content
This repository was archived by the owner on Sep 22, 2022. It is now read-only.

Add depreciated note to README #92

Merged
merged 2 commits into from
Sep 21, 2022
Merged

Add depreciated note to README #92

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
77964a8
Add depreciated note to README
owenniblock Sep 21, 2022
efa494e
deprecated not depreciated
owenniblock Sep 21, 2022
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
14 changes: 13 additions & 1 deletion README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,18 @@

A modal dialog opened with a <details> button.

## DEPRECATION WARNING

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

* 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).
```
Expand Down Expand Up @@ -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.