blocker

BlockingView : d2/sdk/controls/blocker/blocker

UI blocker. Used to temporarily make the whole or part of Smart View UI non-interactive to block any unexpected user input while executing a critical piece of logic either in the background or foreground.

Extends: Object

• BlockingView : d2/sdk/controls/blocker/blocker
  • .imbue(view)
  • .delegate(view, delegateToView)

BlockingView.imbue(view)

Mix progrss blocking APIs as well as well as blocker instance to a view.

Kind: static method of BlockingView
Mixes: BlockerAPI

Param	Type	Description
view	Marionette.View	The view instance where blocing APIs are to be mixed.

Example (An item view showing/hiding blocker when its model syncs)

define([
   'nuc/lib/marionette',
   'd2/sdk/controls/blocker/blocker'
   'd2/sdk/models/node.model',
], function(Marionette, BlockingView, NodeModel){
   'use strict';

   var NodeView = Marionette.ItemView.extend({
       constructor: function NodeView(options) {
           options = options || {};
           options.model = new NodeModel({id: options.id}, options);

           BlockingView.imbue(this);
       },

       onRender: function() {
         this.blockAction(); // Blocker API that got mixed into this instance due to BlockingView.imbue() above
         this.model.fetch().always(this.unblockActions.bind(this));
       }
   });

   return NodeView;
});

BlockingView.delegate(view, delegateToView)

Mix progress blocking APIs to a view where the blocker instance is delegated to a different view.

Useful when there are more than one view instance with parent-child relationship such that each of the views want to mix blocker APIs in it without creating duplicate blocker instances.

Kind: static method of BlockingView
Mixes: BlockerAPI

Param	Type	Description
view	Marionette.View	The view instance where blocing APIs are to be mixed.
delegateToView	Marionette.View	The view which already has blocker APIs mixed and is going to be used as source of blocker instance.

Example (An item view showing/hiding blocker when its model syncs)

define([
   'nuc/lib/marionette',
   'd2/sdk/controls/blocker/blocker'
   'd2/sdk/models/node.model',
], function(Marionette, BlockingView, NodeModel){
   'use strict';

   var NodeView = Marionette.ItemView.extend({
       constructor: function NodeView(options) {
           options = options || {};
           options.model = new NodeModel({id: options.id}, options);

           BlockingView.delegate(this, options.parentView); // Assuming 'parentView' already has blocker API mixed to it
       },

       onRender: function() {
         this.blockAction(); // Blocker API that got mixed into this instance due to BlockingView.imbue() above
         this.model.fetch().always(this.unblockActions.bind(this));
       }
   });

   return NodeView;
});