Skip to content

Commit b29db92

Browse files
authoredNov 26, 2024··
Update README.md to reflect current status of development and maintenance
1 parent 4309525 commit b29db92

File tree

1 file changed

+14
-0
lines changed

1 file changed

+14
-0
lines changed
 

‎README.md

+14
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,19 @@
11
# Ember Modal Dialog [![Build Status](https://travis-ci.org/yapplabs/ember-modal-dialog.svg?branch=master)](https://travis-ci.org/yapplabs/ember-modal-dialog) [![Ember Observer Score](http://emberobserver.com/badges/ember-modal-dialog.svg)](http://emberobserver.com/addons/ember-modal-dialog)
22

3+
## Regarding the Status of this Addon
4+
5+
A lot has happened in browser APIs, the JS ecosytem, and in the Ember ecosystem since this addon was created.
6+
7+
Most notably, all major browsers have added support for the HTML `dialog` element. This effectively delivers the core use case for this addon as a browser API. It is not syntax-compatible of course, so adopting it requires learning the new element and its programmatic API and using it as appropriate for your situation.
8+
9+
In the Javascript ecosystem, tether.js has reached the end of its life, being succeeded by popper and now by floating-ui as the most common solution for positioning a DOM element relative to another element. Our experience is that floating-ui works great in conjunction with Ember's modifiers. While there are addons that wrap it, like ember-velcro, we have found that using it directly does the job quite well.
10+
11+
In the Ember ecosystem, addon authors are transitioning addons to support modern versions of Ember and to become v2 addons. This addon has three dependencies that are either unsupported or poorly supported: ember-tether, liquid-wormhole, and liquid-tether.
12+
13+
Having contemplated these changes, *we won't be investing in ongoing development of this addon, and are migrating away from it in our own projects*. We will still review and accept PRs for bug fixes and compatibility, but we encourage you to move on.
14+
15+
## Overview
16+
317
The ember-modal-dialog addon provides components to implement modal dialogs throughout an Ember application using a simple, consistent pattern.
418

519
Unlike some other modal libraries for Ember, ember-modal-dialog uses solutions like [ember-wormhole](//github.com/yapplabs/ember-wormhole) to render a modal structure as a top-level DOM element for layout purposes while retaining its logical position in the Ember view hierarchy. This difference introduces a certain elegance and, dare we say, joy, into the experience of using modals in your app. For more info on this, see the "Wormhole" section below.

0 commit comments

Comments
 (0)
Please sign in to comment.