aurelia-dialog

This library is part of the Aurelia platform and contains a dialog plugin.

To keep up to date on Aurelia, please visit and subscribe to the official blog and our email list. We also invite you to follow us on twitter. If you have questions look around our Discourse forums, chat in our community on Gitter or use stack overflow. Documentation can be found in our developer hub. If you would like to have deeper insight into our development process, please install the ZenHub Chrome or Firefox Extension and visit any of our repository's boards.

Future work on the dialog plugin is being done on the v2.x branch. Please submit all bug fixes and features there. Note that the new branch has a set of breaking changes which are designed to enable dialogs to work better with recent enhancements in the templating engine and in bundler support. Several breaking changes are focused around architectural improvements as well. Please expect the shelf-life of v1.x to be relatively short in light of the v2.x work that is currently underway.

Platform Support

This library can be used in the browser.

Documentation

Check out the docs on the Aurelia Hub.

Reporting Issues

Please refer to the issue template.

Building

npm run build

Tests

npm run test

Developing

npm run test:watch

Debugging

npm run test:debugging

Publishing

1. Bump the version

   npm run bump-version [<newversion> | major | minor | patch]
   

2. Prepare the release (run tests, run build, docs, release notes)

   npm run cut-release
   

3. Commit, tag, npm publish (not automated)

2.0.0 (2020-01-07)

• Fix dialog mouse event bug

2.0.0-rc.8 (2019-09-19)

Bug Fixes

• settings: add missing types (0a518f1), closes #382

2.0.0-rc.7 (2019-09-12)

Bug Fixes

• renderers: don't store a reference to last active element if it (12a892d)

Features

• keyboard: allow to configure keyevent type (1cfdd58)
• renderers: add restoreFocus setting (c5f4ad4)

1.1.0 (2018-08-18)

Bug Fixes

• attach-focus: restore behavior prior to #346 (#349) (915e735)
• css: update styles to use ux- prefix instead of ai- (130c13b), closes #306
• DI: use static method for Element (e970a1b)
• dialog-composition-engine: align with fixed templating typings (ab7e534)
• dialog-service: remove internal members from public interface (a10c1ab)

Features

• dialog-renderer: add Animator support close #188 (2dd5f28)
• dialog-renderer: add native dialog renderer close #338 (f7d4c7a)

BREAKING CHANGES

• dialog-renderer: remove the current transition based animation support from DialogRenderer

2.0.0-rc.6 (2019-05-31)

Bug Fixes

• build: adjust umd build, add umd-es2015 (342c023)
• package.json: fix package.json (5ae0d3a)

Features

• dialog-renderer: add native dialog renderer close #338 (9da52fe)
• keyboard: allow to configure keyevent type (2f57949)

2.0.0-rc.5 (2019-01-21)

Bug Fixes

• build: correct namespace for umd build (b3b08e7)

2.0.0-rc.4 (2019-01-19)

Bug Fixes

• build: add umd build to build script (0c46fdc)
• build: update rollup dep, config (0c9e029)
• doc: fix html5 syntax (629ad1c), closes /github.com/aurelia/templating/pull/647#issuecomment-427989601

Features

• keyboard: allow to configure keyevent type (3aad34f)

2.0.0-rc.3 (2018-08-22)

Bug Fixes

• resources: use named exports instead of default (4033216)

2.0.0-rc.2 (2018-08-22)

Bug Fixes

• attach-focus: AttachFocus must be the default export fix #358 (fb5e829)

2.0.0-rc.1 (2018-08-21)

Bug Fixes

• css: update styles to use ux- prefix instead of ai- (f29d8cb), closes #306
• package.json: add missing dependency (ed9c5df)

Features

• attach-focus: make work as boolean attr (f75abb4), closes #349
• resources: register resources by class (#354) (ff55c80)

BREAKING CHANGES

• resources: - default resources are no longer reexported, need to be explicitly included when bundling

1.0.0 (2018-07-23)

Bug Fixes

• DI: use static method for Element (700dd62)
• doc: correct link from dialog to bootstraping (432533d)

1.0.0-rc.2.0.0 (2017-11-05)

Bug Fixes

• dialog-configuration: set defaults for ".renderer" and ".cssText" (fd58f2a), closes #307
• dialog-renderer: lazy DOM access fix #294 (f71ecf8)
• dialog-service: fix no fail for undefined moduleId (e90a9d8), closes #312
• typings: fix as it was in #280 (c6dd762)

Features

• dialog-controller: add param to canDeactivate / deactivate functions. (42ad7f3)
• dialog-controller: pass close result to lifecycle hooks (320504c)

BREAKING CHANGES

• dialog-controller: - DialogController.prototype.error wraps the passed reason in DialogCloseError

1.0.0-rc.1.0.3 (2017-05-05)

Bug Fixes

• dialog-renderer: don't cancel events fix #281 (9a92123)

1.0.0-rc.1 (2017-04-28)

Bug Fixes

• dialog-configuration: fix #264 add missing padding unit (902c921)
• dialog-configuration: use PLATFORM.moduleName (9dc62ff)
• dialog-renderer: check for transitions (ed77c85)
• dialog-renderer: let click events bubble (6a03bbd)
• enableescclose: default to true (58bfc88)
• lefecycle: handle thrown errors (e7f1284)
• lifecycle: fix lifecycle methods default value (67a5c64)

Features

• all: migrate to TS (5a68ca3)
• all: remove "lock" setting (a0fd54a)
• all: switch prefix - "ai" => "ux" (817be7f)
• dialog options: allow esc to close dialog without lock: false (c0baaf5)
• dialog-service: add .closeAll() (76048e6)
• dialog-service: add .closeAll() (f59dfc7)
• dialog-service: refactor consolidate open methods in one (676ee58)
• dialog-service: refactor consolidate open methods in one (dc44a34)
• dialog-service, dialog-controller: add "rejectOnCancel" (e8cd8e5)
• dialog-settings, dialog-renderer: add host (4aebd63)
• dialog-settings, dialog-service: add childContainer (db0aca5)

1.0.0-beta.3.0.1

Bug Fixes

• dialog-service: .open() proper error propagation
• dialog-controller: clear close promise when canDeactivate=>false
• dialog-renderer, dialog-service: fix settings merging
• dialog-renderer: do not track controllers per renderer instance
• dialog-service: fix remove controllers closed with .error
• styles: make ai-dialog display:table

1.0.0-beta.3.0.0 (2016-07-27)

Bug Fixes

• dialog-configuration: Add settings to configuration types and docs. (7d5f6b8)
• dialog-configuration: correct typings (541cd8e)
• dialog-configuration: do not inject empty styling (6c48a8c)
• dialog-configuration: Fix useRenderer typing (451cd2c)
• dialog-configuration: register renderer as transient (901a004), closes aurelia/dialog#180

Features

• dialog-service: rename openc to openAndYieldController (d21458d)

1.0.0-beta.2.0.0 (2016-07-12)

Bug Fixes

• dialog-configuration: setup default renderer (2c4c1fb), closes #129

1.0.0-beta.1.1.0 (2016-06-22)

0.6.2 (2016-05-24)

Bug Fixes

• dialog-service: add host element to container (#152) (bcd24532, closes #150)
• dialogResult: export DialogResult for dts (#153) (736f6fa1, closes #134)

0.6.1 (2016-05-17)

Bug Fixes

• style: alter div styles (388bffac, closes #148)

0.6.0 (2016-05-10)

Bug Fixes

• dialog.css: fix close button positioning (ca7af613, closes #128)
• renderer: modal scrolling, close behavior (75f9606a, closes #125, #103)

0.5.10 (2016-03-23)

Bug Fixes

• build: incorrect build configuration (f03146ee)

0.5.9 (2016-03-22)

Features

• dialog: track controllers in service (b58d17f5, closes #121)

0.5.8 (2016-03-10)

Bug Fixes

• dialog: put back centerDialog (1e03984a)
• dialog-controller:
  • remove promise pyramid of doom (e5d42e3f)
  • fix the class interface (7ac0be86, closes #82)

Features

• position: allow to pass in callback to do setup on elements (825e0e16)

0.5.7 (2016-03-01)

Bug Fixes

• dialog:
  • allow response to click events (1fd3bfc8)
  • allow response to click events (ec8a8ce0)
  • accessibility fixes (79a796da)

Features

• use attach-focus attribute value to decide if the element is to be focused (ceb7196f)
• z-index: make z-index configurable (e9d164f5, closes #90)

0.5.6 (2016-02-09)

Bug Fixes

• changelog: fix changelog generation (3f123e38, closes #71)
• ie: clicking overlay closes (2c4cfa63, closes #87)

0.5.4 (2016-01-30)

• feat(all): update jspm meta; core-js; aurelia deps
• fix(deps): move aurelia-pal to dev-dep
• disable pointer events on ai-dialog-container
• fix(dialog): use CSS auto margins instead of JS

0.5.1 (2015-12-03)

• Destroy modal only when modalContainer ends its transition
• incorrect DialogFooter name

0.2.1 (2015-09-07)

Bug Fixes

• dialog: Update link to require (3caf3a7d)

0.2.0 (2015-09-05)

Bug Fixes

• build: update linting, testing and tools (9b011a5e)
• dialog-service: update to latest templating (3a2c7edd)

0.1.1 (2015-08-24)

0.1.1 (2015-08-24)