AngularJS加载完成后发送事件

时间:2013-02-19 22:22:35

标签: angularjs angularjs-scope

当所有指令完成编译/链接时,想知道检测页面加载/引导完成的最佳方法是什么。

任何活动已经存在?我应该重载引导函数吗?

11 个答案:

答案 0 :(得分:199)

只是预感:为什么不看看ngCloak指令是如何做到的?显然,ngCloak指令设法在事物加载后显示内容。我打赌看看ngCloak会得出确切答案......

1小时后编辑: 好吧,我看了ngCloak而且它很短。这显然意味着编译函数不会被执行,直到{{模板}}表达式被评估(即它加载的模板),因此ngCloak指令的功能很好。

我有根据的猜测是只使用与ngCloak相同的简单性来制作一个指令,然后在你的编译函数中做你想做的任何事情。 :)将指令放在应用程序的根元素上。您可以调用类似myOnload的指令,并将其用作my-onload属性。编译模板(编译表达式并加载子模板)后,将执行编译功能。

编辑,23小时后: 好的,所以我做了一些研究,我也asked my own question。我问的这个问题间接地与这个问题有关,但它巧合地引出了解决这个问题的答案。

答案是你可以创建一个简单的指令并将你的代码放在指令的链接函数中,当你的元素准备好/加载时,它将在大多数用例中解释。基于Josh's description of the order in which compile and link functions are executed

  

如果你有这个标记:

<div directive1>
  <div directive2>
    <!-- ... -->
  </div>
</div>
     

然后AngularJS将通过运行指令来创建指令   以某种顺序运作:

directive1: compile
  directive2: compile
directive1: controller
directive1: pre-link
  directive2: controller
  directive2: pre-link
  directive2: post-link
directive1: post-link
     

默认为直接&#34;链接&#34;功能是一个后链接,所以你的外部   指令1的链接功能直到内部后才会运行   指令2的链接功能已经运行。这就是为什么我们说这只是它的原因   在后链接中安全地进行DOM操作。所以走向原始   问题,访问子指令应该没有问题   但是,来自外部指令的链接函数的内部html   必须编译动态插入的内容,如上所述。

由此我们可以得出结论,当一切准备就绪/编译/链接/加载时,我们可以简单地制定一个指令来执行我们的代码:

    app.directive('ngElementReady', [function() {
        return {
            priority: -1000, // a low number so this directive loads after all other directives have loaded. 
            restrict: "A", // attribute only
            link: function($scope, $element, $attributes) {
                console.log(" -- Element ready!");
                // do what you want here.
            }
        };
    }]);

现在您可以做的是将ngElementReady指令放到应用程序的根元素上,console.log将在加载时触发:

<body data-ng-app="MyApp" data-ng-element-ready="">
   ...
   ...
</body>

就这么简单!只需制作一个简单的指令并使用它。 ;)

您可以进一步自定义它,以便通过向其添加$scope.$eval($attributes.ngElementReady);来执行表达式(即函数):

    app.directive('ngElementReady', [function() {
        return {
            priority: Number.MIN_SAFE_INTEGER, // execute last, after all other directives if any.
            restrict: "A",
            link: function($scope, $element, $attributes) {
                $scope.$eval($attributes.ngElementReady); // execute the expression in the attribute.
            }
        };
    }]);

然后你可以在任何元素上使用它:

<body data-ng-app="MyApp" data-ng-controller="BodyCtrl" data-ng-element-ready="bodyIsReady()">
    ...
    <div data-ng-element-ready="divIsReady()">...<div>
</body>

请确保您的元素(在控制器中)中定义了您的元素所在的函数(例如bodyIsReady和divIsReady)。

警告:我说这适用于大多数案例。使用某些指令(如ngRepeat和ngIf)时要小心。他们创建自己的范围,您的指令可能不会触发。例如,如果您将新的ngElementReady指令放在也具有ngIf的元素上,并且ngIf的条件求值为false,那么我们的ngElementReady指令就不会被加载。或者,例如,如果将新的ngElementReady指令放在也具有ngInclude指令的元素上,则如果ngInclude的模板不存在,则不会加载我们的指令。您可以通过确保嵌套指令而不是将它们全部放在同一元素上来解决其中一些问题。例如,通过这样做:

<div data-ng-element-ready="divIsReady()">
    <div data-ng-include="non-existent-template.html"></div>
<div>

而不是:

<div data-ng-element-ready="divIsReady()" data-ng-include="non-existent-template.html"></div>

ngElementReady指令将在后一个示例中编译,但它的链接函数将不会被执行。注意:指令总是被编译,但是它们的链接函数并不总是执行,具体取决于上面的某些场景。

编辑,几分钟后:

哦,要完全回答这个问题,您现在可以从$emit属性中执行的表达式或函数$broadcastng-element-ready事件。 :)例如:

<div data-ng-element-ready="$emit('someEvent')">
    ...
<div>

编辑,甚至几分钟后:

@satchmorun的答案也有效,但仅适用于初始加载。这是一个very useful SO question,用于描述执行内容的顺序,包括链接功能app.run等。因此,根据您的使用情况,app.run可能不错,但不适用于特定元素,在这种情况下链接功能更好。

编辑,五个月后,即10月17日太平洋标准时间8:11:

这不适用于异步加载的部分。您需要在部分内容中添加簿记(例如,一种方法是让每个部分跟踪其内容何时完成加载然后发出一个事件,以便父作用域可以计算已加载了多少部分,最后做了什么呢?在加载所有部分之后需要做的事情。)

编辑,10月23日太平洋标准时间晚上10:52:

我制作了一个简单的指令,用于在加载图像时触发一些代码:

/*
 * This img directive makes it so that if you put a loaded="" attribute on any
 * img element in your app, the expression of that attribute will be evaluated
 * after the images has finished loading. Use this to, for example, remove
 * loading animations after images have finished loading.
 */
  app.directive('img', function() {
    return {
      restrict: 'E',
      link: function($scope, $element, $attributes) {
        $element.bind('load', function() {
          if ($attributes.loaded) {
            $scope.$eval($attributes.loaded);
          }
        });
      }
    };
  });

编辑,10月24日上午12:48太平洋标准时间:

我改进了原始ngElementReady指令并将其重命名为whenReady

/*
 * The whenReady directive allows you to execute the content of a when-ready
 * attribute after the element is ready (i.e. done loading all sub directives and DOM
 * content except for things that load asynchronously like partials and images).
 *
 * Execute multiple expressions by delimiting them with a semi-colon. If there
 * is more than one expression, and the last expression evaluates to true, then
 * all expressions prior will be evaluated after all text nodes in the element
 * have been interpolated (i.e. {{placeholders}} replaced with actual values). 
 *
 * Caveats: if other directives exists on the same element as this directive
 * and destroy the element thus preventing other directives from loading, using
 * this directive won't work. The optimal way to use this is to put this
 * directive on an outer element.
 */
app.directive('whenReady', ['$interpolate', function($interpolate) {
  return {
    restrict: 'A',
    priority: Number.MIN_SAFE_INTEGER, // execute last, after all other directives if any.
    link: function($scope, $element, $attributes) {
      var expressions = $attributes.whenReady.split(';');
      var waitForInterpolation = false;

      function evalExpressions(expressions) {
        expressions.forEach(function(expression) {
          $scope.$eval(expression);
        });
      }

      if ($attributes.whenReady.trim().length == 0) { return; }

      if (expressions.length > 1) {
        if ($scope.$eval(expressions.pop())) {
          waitForInterpolation = true;
        }
      }

      if (waitForInterpolation) {
        requestAnimationFrame(function checkIfInterpolated() {
          if ($element.text().indexOf($interpolate.startSymbol()) >= 0) { // if the text still has {{placeholders}}
            requestAnimationFrame(checkIfInterpolated);
          }
          else {
            evalExpressions(expressions);
          }
        });
      }
      else {
        evalExpressions(expressions);
      }
    }
  }
}]);

例如,在加载元素并且尚未替换someFunction时,像这样使用它来触发{{placeholders}}

<div when-ready="someFunction()">
  <span ng-repeat="item in items">{{item.property}}</span>
</div>

someFunction将在所有item.property占位符被替换之前调用。

根据需要评估任意数量的表达式,并使最后一个表达式true等待{{placeholders}}进行如下评估:

<div when-ready="someFunction(); anotherFunction(); true">
  <span ng-repeat="item in items">{{item.property}}</span>
</div>
someFunction被替换后,

anotherFunction{{placeholders}}会被解雇。

这仅在第一次加载元素时起作用,而不是在将来的更改中起作用。如果在占位符最初被替换之后$digest一直发生,它可能无法正常工作($ digest可能会发生多达10次,直到数据停止更改)。它适用于绝大多数用例。

编辑,10月31日太平洋标准时间下午7:26:

好吧,这可能是我最后一次也是最后一次更新。这可能适用于99.999个用例:

/*
 * The whenReady directive allows you to execute the content of a when-ready
 * attribute after the element is ready (i.e. when it's done loading all sub directives and DOM
 * content). See: https://stackoverflow.com/questions/14968690/sending-event-when-angular-js-finished-loading
 *
 * Execute multiple expressions in the when-ready attribute by delimiting them
 * with a semi-colon. when-ready="doThis(); doThat()"
 *
 * Optional: If the value of a wait-for-interpolation attribute on the
 * element evaluates to true, then the expressions in when-ready will be
 * evaluated after all text nodes in the element have been interpolated (i.e.
 * {{placeholders}} have been replaced with actual values).
 *
 * Optional: Use a ready-check attribute to write an expression that
 * specifies what condition is true at any given moment in time when the
 * element is ready. The expression will be evaluated repeatedly until the
 * condition is finally true. The expression is executed with
 * requestAnimationFrame so that it fires at a moment when it is least likely
 * to block rendering of the page.
 *
 * If wait-for-interpolation and ready-check are both supplied, then the
 * when-ready expressions will fire after interpolation is done *and* after
 * the ready-check condition evaluates to true.
 *
 * Caveats: if other directives exists on the same element as this directive
 * and destroy the element thus preventing other directives from loading, using
 * this directive won't work. The optimal way to use this is to put this
 * directive on an outer element.
 */
app.directive('whenReady', ['$interpolate', function($interpolate) {
  return {
    restrict: 'A',
    priority: Number.MIN_SAFE_INTEGER, // execute last, after all other directives if any.
    link: function($scope, $element, $attributes) {
      var expressions = $attributes.whenReady.split(';');
      var waitForInterpolation = false;
      var hasReadyCheckExpression = false;

      function evalExpressions(expressions) {
        expressions.forEach(function(expression) {
          $scope.$eval(expression);
        });
      }

      if ($attributes.whenReady.trim().length === 0) { return; }

    if ($attributes.waitForInterpolation && $scope.$eval($attributes.waitForInterpolation)) {
        waitForInterpolation = true;
    }

      if ($attributes.readyCheck) {
        hasReadyCheckExpression = true;
      }

      if (waitForInterpolation || hasReadyCheckExpression) {
        requestAnimationFrame(function checkIfReady() {
          var isInterpolated = false;
          var isReadyCheckTrue = false;

          if (waitForInterpolation && $element.text().indexOf($interpolate.startSymbol()) >= 0) { // if the text still has {{placeholders}}
            isInterpolated = false;
          }
          else {
            isInterpolated = true;
          }

          if (hasReadyCheckExpression && !$scope.$eval($attributes.readyCheck)) { // if the ready check expression returns false
            isReadyCheckTrue = false;
          }
          else {
            isReadyCheckTrue = true;
          }

          if (isInterpolated && isReadyCheckTrue) { evalExpressions(expressions); }
          else { requestAnimationFrame(checkIfReady); }

        });
      }
      else {
        evalExpressions(expressions);
      }
    }
  };
}]);

像这样使用

<div when-ready="isReady()" ready-check="checkIfReady()" wait-for-interpolation="true">
   isReady will fire when this {{placeholder}} has been evaluated
   and when checkIfReady finally returns true. checkIfReady might
   contain code like `$('.some-element').length`.
</div>

当然,它可能会被优化,但我会把它留在那里。 requestAnimationFrame很不错。

答案 1 :(得分:38)

docs for angular.Module中,有一个描述run功能的条目:

  

使用此方法注册加载所有模块时应执行注入的工作。

所以,如果您有一些模块是您的应用程序:

var app = angular.module('app', [/* module dependencies */]);

您可以在模块加载后运行:

app.run(function() {
  // Do post-load initialization stuff here
});

编辑:手动初始化到救援

因此有人指出,当DOM准备就绪并且链接起来时,run不会被调用。当$injector引用的模块的ng-app加载了所有依赖项时,它会被调用,这与DOM编译步骤是分开的。

我又看了manual initialization,看来这应该可以解决问题了。

I've made a fiddle to illustrate

HTML很简单:

<html>
    <body>
        <test-directive>This is a test</test-directive>
    </body>
</html>

请注意缺少ng-app。我有一个指令可以做一些DOM操作,所以我们可以确定事情的顺序和时间。

像往常一样,创建了一个模块:

var app = angular.module('app', []);

这是指令:

app.directive('testDirective', function() {
    return {
        restrict: 'E',
        template: '<div class="test-directive"><h1><div ng-transclude></div></h1></div>',
        replace: true,
        transclude: true,
        compile: function() {
            console.log("Compiling test-directive");
            return {
                pre: function() { console.log("Prelink"); },
                post: function() { console.log("Postlink"); }
            };
        }
    };
});

我们要将test-directive标记替换为divtest-directive,并将其内容包装在h1中。

我添加了一个返回前后链接函数的编译函数,以便我们可以看到这些内容何时运行。

以下是代码的其余部分:

// The bootstrapping process

var body = document.getElementsByTagName('body')[0];

// Check that our directive hasn't been compiled

function howmany(classname) {
    return document.getElementsByClassName(classname).length;
}

在我们完成任何工作之前,DOM中不应该有test-directive类的元素,在我们完成之后应该有1。

console.log('before (should be 0):', howmany('test-directive'));

angular.element(document).ready(function() {
    // Bootstrap the body, which loades the specified modules
    // and compiled the DOM.
    angular.bootstrap(body, ['app']);

    // Our app is loaded and the DOM is compiled
    console.log('after (should be 1):', howmany('test-directive'));
});

这很简单。文档准备就绪后,使用应用程序的根元素和一组模块名称调用angular.bootstrap

事实上,if you attach a run function to the app module,您会看到它在任何编译发生之前就会运行。

如果您操作小提琴并观看控制台,您将看到以下内容:

before (should be 0): 0 
Compiling test-directive 
Prelink
Postlink
after (should be 1): 1 <--- success!

答案 2 :(得分:15)

Angular没有提供在页面加载时发出信号的方法,可能是因为“已完成”取决于您的应用程序。例如,如果您有部分的分层树,则加载其他部分。 “完成”意味着所有这些都已加载。任何框架都很难分析您的代码并理解所有内容已完成或仍在等待。为此,您必须提供特定于应用程序的逻辑来检查和确定。

答案 3 :(得分:14)

我已经提出了一种在评估角度初始化完成时相对准确的解决方案。

指令是:

.directive('initialisation',['$rootScope',function($rootScope) {
            return {
                restrict: 'A',
                link: function($scope) {
                    var to;
                    var listener = $scope.$watch(function() {
                        clearTimeout(to);
                        to = setTimeout(function () {
                            console.log('initialised');
                            listener();
                            $rootScope.$broadcast('initialised');
                        }, 50);
                    });
                }
            };
        }]);

然后可以将其作为属性添加到body元素,然后使用$scope.$on('initialised', fn)

进行监听

它的工作原理是假设在没有更多$ digest周期的情况下初始化应用程序。 $ watch在每个摘要周期调用,因此启动计时器(setTimeout不是$ timeout,因此不会触发新的摘要周期)。如果在超时内没有发生摘要循环,则假定应用程序已初始化。

它显然不如satchmoruns解决方案准确(因为摘要周期可能比超时时间长)但我的解决方案不需要您跟踪模块,这使得它更容易管理(特别是对于大型项目)。无论如何,似乎足够准确满足我的要求。希望它有所帮助。

答案 4 :(得分:10)

如果您使用Angular UI Router,则可以收听$viewContentLoaded事件。

&#34; $ viewContentLoaded - 在加载视图后触发,在呈现DOM后 。 &#39; $范围&#39;视图发出事件。&#34; - Link

$scope.$on('$viewContentLoaded', 
function(event){ ... });

答案 5 :(得分:3)

我用JQuery观察角度的DOM操作,我确实为我的应用程序设置了一个完成(某种预定义和令人满意的情况,我需要我的应用程序摘要),例如我希望我的ng-repeater产生7结果和为此我会在setInterval的帮助下设置一个观察函数。

$(document).ready(function(){

  var interval = setInterval(function(){

  if($("article").size() == 7){
     myFunction();
     clearInterval(interval);
  }

  },50);

});

答案 6 :(得分:3)

如果您不使用ngRoute模块,即您没有$viewContentLoaded事件。

您可以使用其他指令方法:

    angular.module('someModule')
        .directive('someDirective', someDirective);

    someDirective.$inject = ['$rootScope', '$timeout']; //Inject services

    function someDirective($rootScope, $timeout){
        return {
            restrict: "A",
            priority: Number.MIN_SAFE_INTEGER, //Lowest priority
            link    : function(scope, element, attr){
                $timeout(
                    function(){
                        $rootScope.$emit("Some:event");
                    }
                );
            }
        };
    }

相对于trusktr's answer,它具有最低优先级。加$timeout将导致Angular在回调执行之前运行整个事件循环。

使用了

$rootScope,因为它允许将指令放在应用程序的任何范围内并仅通知必要的侦听器。

  

$ rootScope。$ emit将仅为侦听器触发所有$ rootScope。$的事件。有趣的是$ rootScope。$ broadcast将通知所有$ rootScope。$ on以及$ scope。$ on listeners   Source

答案 7 :(得分:2)

根据Angular团队和Github issue

  

我们现在分别在ng-view和ng-include中发出$ viewContentLoaded和$ includeContentLoaded事件。我认为这与我们完成编译时能够知道的一样接近。

基于此,似乎目前不可能以可靠的方式进行,否则Angular会提供开箱即用的事件。

引导应用程序意味着在根作用域上运行摘要周期,并且也没有摘要周期结束事件。

根据Angular 2 design docs

  

由于存在多个摘要,因此无法确定并通知组件模型是否稳定。这是因为通知可以进一步更改数据,这可以重新启动绑定过程。

根据这一点,这是不可能的事实是为什么决定在Angular 2中重写的原因之一。

答案 8 :(得分:2)

我有一个片段在通过路由进入的主要部分之后/之后被加载。

我需要在子部分加载后运行一个函数,我不想写一个新的指令,并且发现你可以使用厚颜无耻的ngIf

父母部分控制者:

$scope.subIsLoaded = function() { /*do stuff*/; return true; };

子部分的HTML

<element ng-if="subIsLoaded()"><!-- more html --></element>

答案 9 :(得分:0)

这些都是很好的解决方案,但是,如果您当前正在使用路由,那么我发现这个解决方案是最简单和最少量的代码。使用&#39;解决&#39;在触发路线之前等待承诺完成的属性。 e.g。

$routeProvider
.when("/news", {
    templateUrl: "newsView.html",
    controller: "newsController",
    resolve: {
        message: function(messageService){
            return messageService.getMessage();
    }
}

})

Click here for the full docs - Credit to K. Scott Allen

答案 10 :(得分:0)

可能是我可以通过这个例子帮助你

在自定义fancybox中,我使用插值显示内容。

在服务中,在“开放式”fancybox方法中,我做

open: function(html, $compile) {
        var el = angular.element(html);
     var compiledEl = $compile(el);
        $.fancybox.open(el); 
      }

$ compile返回编译数据。 你可以检查编译的数据