aboutsummaryrefslogtreecommitdiffstats
path: root/src/directive/ngView.js
blob: 95b1546dfc44bc366f2a1b20076635def1f0edad (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
'use strict';

/**
 * @ngdoc directive
 * @name angular.module.ng.$compileProvider.directive.ng-view
 * @restrict ECA
 *
 * @description
 * # Overview
 * `ng-view` is a directive that complements the {@link angular.module.ng.$route $route} service by
 * including the rendered template of the current route into the main layout (`index.html`) file.
 * Every time the current route changes, the included view changes with it according to the
 * configuration of the `$route` service.
 *
 * @scope
 * @example
    <doc:example module="ngView">
      <doc:source>
        <script type="text/ng-template" id="examples/book.html">
          controller: {{name}}<br />
          Book Id: {{params.bookId}}<br />
        </script>

        <script type="text/ng-template" id="examples/chapter.html">
          controller: {{name}}<br />
          Book Id: {{params.bookId}}<br />
          Chapter Id: {{params.chapterId}}
        </script>

        <script>
          angular.module('ngView', [], function($routeProvider, $locationProvider) {
            $routeProvider.when('/Book/:bookId', {
              template: 'examples/book.html',
              controller: BookCntl
            });
            $routeProvider.when('/Book/:bookId/ch/:chapterId', {
              template: 'examples/chapter.html',
              controller: ChapterCntl
            });

            // configure html5 to get links working on jsfiddle
            $locationProvider.html5Mode(true);
          });

          function MainCntl($scope, $route, $routeParams, $location) {
            $scope.$route = $route;
            $scope.$location = $location;
            $scope.$routeParams = $routeParams;
          }

          function BookCntl($scope, $routeParams) {
            $scope.name = "BookCntl";
            $scope.params = $routeParams;
          }

          function ChapterCntl($scope, $routeParams) {
            $scope.name = "ChapterCntl";
            $scope.params = $routeParams;
          }
        </script>

        <div ng-controller="MainCntl">
          Choose:
          <a href="/Book/Moby">Moby</a> |
          <a href="/Book/Moby/ch/1">Moby: Ch1</a> |
          <a href="/Book/Gatsby">Gatsby</a> |
          <a href="/Book/Gatsby/ch/4?key=value">Gatsby: Ch4</a> |
          <a href="/Book/Scarlet">Scarlet Letter</a><br/>

          <div ng-view></div>
          <hr />

          <pre>$location.path() = {{$location.path()}}</pre>
          <pre>$route.current.template = {{$route.current.template}}</pre>
          <pre>$route.current.params = {{$route.current.params}}</pre>
          <pre>$route.current.scope.name = {{$route.current.scope.name}}</pre>
          <pre>$routeParams = {{$routeParams}}</pre>
        </div>
      </doc:source>
      <doc:scenario>
        it('should load and compile correct template', function() {
          element('a:contains("Moby: Ch1")').click();
          var content = element('.doc-example-live [ng-view]').text();
          expect(content).toMatch(/controller\: ChapterCntl/);
          expect(content).toMatch(/Book Id\: Moby/);
          expect(content).toMatch(/Chapter Id\: 1/);

          element('a:contains("Scarlet")').click();
          content = element('.doc-example-live [ng-view]').text();
          expect(content).toMatch(/controller\: BookCntl/);
          expect(content).toMatch(/Book Id\: Scarlet/);
        });
      </doc:scenario>
    </doc:example>
 */


/**
 * @ngdoc event
 * @name angular.module.ng.$compileProvider.directive.ng-view#$viewContentLoaded
 * @eventOf angular.module.ng.$compileProvider.directive.ng-view
 * @eventType emit on the current ng-view scope
 * @description
 * Emitted every time the ng-view content is reloaded.
 */
var ngViewDirective = ['$http', '$templateCache', '$route', '$anchorScroll', '$compile',
                       '$controller',
               function($http,   $templateCache,   $route,   $anchorScroll,   $compile,
                        $controller) {
  return {
    restrict: 'ECA',
    terminal: true,
    link: function(scope, element, attr) {
      var changeCounter = 0,
          lastScope,
          onloadExp = attr.onload || '';

      scope.$on('$afterRouteChange', function(event, next, previous) {
        changeCounter++;
      });

      scope.$watch(function() {return changeCounter;}, function(newChangeCounter) {
        var template = $route.current && $route.current.template;

        function destroyLastScope() {
          if (lastScope) {
            lastScope.$destroy();
            lastScope = null;
          }
        }

        function clearContent() {
          // ignore callback if another route change occured since
          if (newChangeCounter == changeCounter) {
            element.html('');
          }
          destroyLastScope();
        }

        if (template) {
          $http.get(template, {cache: $templateCache}).success(function(response) {
            // ignore callback if another route change occured since
            if (newChangeCounter == changeCounter) {
              element.html(response);
              destroyLastScope();

              var link = $compile(element.contents()),
                  current = $route.current;

              lastScope = current.scope = scope.$new();
              if (current.controller) {
                element.contents().
                  data('$ngControllerController', $controller(current.controller, {$scope: lastScope}));
              }

              link(lastScope);
              lastScope.$emit('$viewContentLoaded');
              lastScope.$eval(onloadExp);

              // $anchorScroll might listen on event...
              $anchorScroll();
            }
          }).error(clearContent);
        } else {
          clearContent();
        }
      });
    }
  };
}];