improve comments

This commit is contained in:
Stephan Classen
2018-09-06 23:32:16 +02:00
parent f2af5911a3
commit 9bf669ddb6
+25 -12
View File
@@ -48,6 +48,8 @@ declare module 'angular' {
*
* If you don't want this behaviour and want to do all the
* blocking manually you can change this value to false.
*
* The default value is 'true'
*/
autoBlock?: boolean;
@@ -56,6 +58,8 @@ declare module 'angular' {
* hide the overlay whenever an exception has occurred.
*
* You can set this value to false if you don't want this behaviour.
*
* The default value is 'true'
*/
resetOnException?: boolean;
@@ -74,33 +78,42 @@ declare module 'angular' {
/**
* When the module is started it will inject the main block element
* by adding the block-ui directive to the body element.
* by adding the "block-ui" directive to the <body> element.
*
* Set this to false if there no need for any fullscreen blocking or if there's
* more control required. For instance when your ng-app directive is a child
* element of the body element it is impossible for the blockUI resolve the main
* instance. In such a case the auto injection of the main block scope should
* be disabled and the main block element should be relocated.
*
* The default value is 'true'
*/
autoInjectBodyBlock?: boolean;
/**
* A string containing the default css classes, separated by spaces,
* A string containing the default css classes (separated by spaces)
* that should be applied to each block-ui element.
*
* The default value is `block-ui block-ui-anim-fade`
* The default value is "block-ui block-ui-anim-fade"
*/
cssClass?: string;
/**
* Whenever a user interface block is active, because the single page
* application is still waiting for a response from the backend server,
* the user can still navigate away using the back and forward buttons
* of the browser.
* While a user interface block is active the user can still navigate
* away using the back and forward buttons of the browser.
*
* Callbacks registered to handle the responses from the server will
* be executed even if a different view/controller is currently active.
* By setting the blockBrowserNavigation property to true the
* angular-block-ui module will prevent navigation while a fullscreen
* Callbacks registered to handle responses from the server will
* be executed even if a different view/controller is active at the
* time the response arrives.
*
* You can set this value to true if you want to prevent navigation
* with the browser back and forward buttons while a fullscreen
* block is active.
*
* Programatic location changes via the $location service are still
* allowed however.
* The navigation block is disabled by default.
*
* The default value is 'false'
*/
blockBrowserNavigation?: boolean;
}