Skip to content
This repository has been archived by the owner on Apr 12, 2024. It is now read-only.

Commit

Permalink
fix(docModuleComponents): implement anchor scroll when content added
Browse files Browse the repository at this point in the history
When navigating to URLs such as
docs.angularjs.org/api/ng#filter, the browser
was not able to navigate to the named anchor,
"filter," because the anchor did not yet exist
in the DOM.

This fix uses the $anchorScroll service
to automatically scroll to the right place when
the content has been added to the page.

Fixes #4703
  • Loading branch information
jeffbcross committed Nov 6, 2013
1 parent 56d0917 commit eb51b02
Showing 1 changed file with 20 additions and 18 deletions.
38 changes: 20 additions & 18 deletions docs/src/templates/js/docs.js
Original file line number Diff line number Diff line change
Expand Up @@ -207,28 +207,29 @@ docsApp.directive.sourceEdit = function(getEmbeddedTemplate) {
}
};

docsApp.directive.docModuleComponents = ['sections', function(sections) {
docsApp.directive.docModuleComponents = function() {
return {
template: ' <div class="component-breakdown">' +
' <h2>Module Components</h2>' +
' <div ng-repeat="(key, section) in components">' +
' <h3 class="component-heading" id="{{ section.type }}">{{ section.title }}</h3>' +
' <table class="definition-table">' +
' <tr>' +
' <th>Name</th>' +
' <th>Description</th>' +
' </tr>' +
' <tr ng-repeat="component in section.components">' +
' <td><a ng-href="{{ component.url }}">{{ component.shortName }}</a></td>' +
' <td>{{ component.shortDescription }}</td>' +
' </tr>' +
' </table>' +
' <div ng-repeat="(key, section) in components">' +
' <h3 class="component-heading" id="{{ section.type }}">{{ section.title }}</h3>' +
' <table class="definition-table">' +
' <tr>' +
' <th>Name</th>' +
' <th>Description</th>' +
' </tr>' +
' <tr ng-repeat="component in section.components">' +
' <td><a ng-href="{{ component.url }}">{{ component.shortName }}</a></td>' +
' <td>{{ component.shortDescription }}</td>' +
' </tr>' +
' </table>' +
' </div>' +
' </div>',
scope : {
module : '@docModuleComponents'
},
controller : ['$scope', function($scope) {
controller : ['$scope', '$anchorScroll', '$timeout', 'sections',
function($scope, $anchorScroll, $timeout, sections) {
var validTypes = ['property','function','directive','service','object','filter'];
var components = {};
angular.forEach(sections.api, function(item) {
Expand All @@ -239,16 +240,17 @@ docsApp.directive.docModuleComponents = ['sections', function(sections) {
components[type] = components[type] || {
title : type,
type : type,
components : []
components : []
};
components[type].components.push(item);
}
}
});
$scope.components = components;
$timeout($anchorScroll, 0, false);
}]
};
}]
};

docsApp.directive.docTutorialNav = function(templateMerge) {
var pages = [
Expand Down Expand Up @@ -411,7 +413,7 @@ docsApp.serviceFactory.prepareDefaultAppModule = function() {
var moduleName = 'App';
return {
module : moduleName,
script : "angular.module('" + moduleName + "', [" +
script : "angular.module('" + moduleName + "', [" +
(deps.length ? "'" + deps.join("','") + "'" : "") + "]);\n\n"
};
};
Expand Down Expand Up @@ -709,7 +711,7 @@ docsApp.controller.DocsController = function($scope, $location, $window, $cookie
error: 'Error Reference'
};

populateComponentsList();
populateComponentsList();

$scope.$watch(function docsPathWatch() {return $location.path(); }, function docsPathWatchAction(path) {
// ignore non-doc links which are used in examples
Expand Down

0 comments on commit eb51b02

Please sign in to comment.