Skip to content

Commit da99254

Browse files
committed
documentation main block-ui instance relocation & fullscreen style class added
1 parent d04d495 commit da99254

19 files changed

+167
-17
lines changed

.idea/runConfigurations/http___localhost_8080_.xml

Lines changed: 9 additions & 0 deletions
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

.idea/runConfigurations/http___localhost_8080_sandbox_.xml

Lines changed: 8 additions & 0 deletions
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

README.md

Lines changed: 10 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -220,10 +220,17 @@ When the module is started it will inject the _main block element_ by adding the
220220
<body block-ui="main">
221221
</body>
222222

223-
This behaviour can be disabled if there no need for any _fullscreen_ blocking or if there's more control required.
223+
This behaviour can be disabled 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.
224+
225+
// Disable auto body block
226+
blockUIConfig.autoInjectBodyBlock = false;
227+
228+
<div ng-app="myApp">
229+
<div block-ui="main" class="block-ui-main"></div>
230+
</div>
231+
232+
More information and an example can be found in this [plunker](http://plnkr.co/edit/F9UauI?p=preview).
224233

225-
blockUIConfig.autoInjectBodyBlock = false; // Disable auto body block
226-
227234
#### cssClass
228235
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'`.
229236

bower.json

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
{
22
"name": "angular-block-ui",
33
"description": "An AngularJS module that allows you to block user interaction on AJAX requests.",
4-
"version": "0.1.0",
4+
"version": "0.1.1",
55
"keywords": [
66
"angular",
77
"angularjs",

dist/README.md

Lines changed: 10 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -220,10 +220,17 @@ When the module is started it will inject the _main block element_ by adding the
220220
<body block-ui="main">
221221
</body>
222222

223-
This behaviour can be disabled if there no need for any _fullscreen_ blocking or if there's more control required.
223+
This behaviour can be disabled 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.
224+
225+
// Disable auto body block
226+
blockUIConfig.autoInjectBodyBlock = false;
227+
228+
<div ng-app="myApp">
229+
<div block-ui="main" class="block-ui-main"></div>
230+
</div>
231+
232+
More information and an example can be found in this [plunker](http://plnkr.co/edit/F9UauI?p=preview).
224233

225-
blockUIConfig.autoInjectBodyBlock = false; // Disable auto body block
226-
227234
#### cssClass
228235
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'`.
229236

dist/angular-block-ui.css

Lines changed: 2 additions & 2 deletions
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

dist/angular-block-ui.css.map

Lines changed: 1 addition & 1 deletion
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

dist/angular-block-ui.js

Lines changed: 1 addition & 1 deletion
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

dist/angular-block-ui.js.map

Lines changed: 1 addition & 1 deletion
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

dist/angular-block-ui.min.css

Lines changed: 2 additions & 2 deletions
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

0 commit comments

Comments
 (0)