updated docs and changelog for the locationChangeSuccess event config…

…uration
dwmkerr · Oct 30, 2017 · cc89e49 · cc89e49
1 parent a79d0da
commit cc89e49
Show file tree

Hide file tree

Showing 2 changed files with 5 additions and 0 deletions.
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -1,3 +1,7 @@
+## v0.7.12
+
+* Support for configuration of the `$locationChangeSuccess` event. Thanks [smalbs](https://github.com/smalbs).
+
 ## v0.6.12
 
 * When a model is opened, we blur any active element. Thanks [samx](https://github.com/samwx)!

diff --git a/README.md b/README.md
@@ -142,6 +142,7 @@ The `showModal` function takes an object with these fields:
 * `scope`: Optional. If provided, the modal controller will use a new scope as a child of `scope` (created by calling `scope.$new()`) rather than a new scope created as a child of `$rootScope`.
 * `bodyClass`: Optional. The custom css class to append to the body while the modal is open (optional, useful when not using Bootstrap).
 * `preClose`: Optional. A function which will be called before the process of closing a modal starts. The signature is `function preClose(modal, result, delay)`. It is provided the `modal` object, the `result` which was passed to `close` and the `delay` which was passed to close.
+* `locationChangeSuccess`: Optional. Allows the closing of the modal when the location changes to be configured. If no value is set, the modal is closed immediately when the `$locationChangeSuccess` event fires. If `false` is set, event is not fired. If a number `n` is set, then the event fires after `n` milliseconds.
 
 #### The Modal Object