docs: simplify left nav selection/scroll

also added some blog posts to resources
This commit is contained in:
Ward Bell 2016-03-04 23:31:29 -08:00
parent bf3ed182a7
commit b0f1f3a4b8
5 changed files with 44 additions and 49 deletions

View File

@ -1,35 +1,42 @@
// Include this file ONLY when current.path[2] is defined // Include this file ONLY when current.path[2] is defined
- var tracks = function(src, selector) { - var base = '/docs/' + current.path[1] + '/' + current.path[2] + '/';
- var base = '/docs/' + current.path[1] + '/' + current.path[2] + '/'; - var dir = current.path[4] ? current.path[3] + '/' : '';
- var cur = current.path[4] || current.path[3];
- cur = cur === 'index' ? '' : cur + '.html';
- cur = base + dir + cur;
- var sections = function(dir, selector) {
- var secondaryPath = public.docs[current.path[1]][current.path[2]] - var secondaryPath = public.docs[current.path[1]][current.path[2]]
- var data = src ? secondaryPath[src] && secondaryPath[src]._data : secondaryPath._data; - var data = dir ? secondaryPath[dir] && secondaryPath[dir]._data : secondaryPath._data;
- if (!data) return []; - if (!data) return [];
- var track = []; - var section = [];
- var selector = selector || function() { return true; }; - var selector = selector || function() { return true; };
- var prefix = base + (src ? src + '/' : ''); - var prefix = base + (dir ? dir + '/' : '');
- for (prop in data) { - for (prop in data) {
- var item = data[prop]; - var item = data[prop];
- item[0] = prop; - item.slug = prop;
- if (prop[0] !== '_' && !item.hide && selector(item)) { - if (prop[0] !== '_' && !item.hide && selector(item)) {
- var file = prop !== 'index' ? prop + '.html' : '' - var file = prop === 'index' ? '' : prop + '.html';
- var href = prefix + file;
- item.class = cur === href ? 'is-selected' : '';
- item.file = file; - item.file = file;
- item.href = prefix + file; - item.href = href;
- item.navTitle = item.navTitle || item.title; - item.navTitle = item.navTitle || item.title;
- item.tooltip = item.description || item.intro || ''; - item.tooltip = item.description || item.intro || '';
- track.push(item); - section.push(item);
- } - }
- } - }
- return track; - return section;
- } - }
- var tutorial = tracks('tutorial'); - var tutorial = sections('tutorial');
- var cookbook = tracks('cookbook'); - var cookbook = sections('cookbook');
- var basics = tracks('guide', function(item) { return item.basics; }); - var basics = sections('guide', function(item) { return item.basics; });
- var guide = tracks('guide', function(item) { return !item.basics; }); - var guide = sections('guide', function(item) { return !item.basics; });
- var qs = tracks('', function(item) { return item[0] === 'quickstart'; })[0] || {}; - var qs = sections('', function(item) { return item.slug === 'quickstart'; })[0] || {};
- var reference = tracks('', function(item) { return item.reference; }); - var reference = sections('', function(item) { return item.reference; });
- var resources = tracks('', function(item) { return item.resources; }); - var resources = sections('', function(item) { return item.resources; });
nav.side-nav.l-pinned-left.l-layer-4.l-offset-nav nav.side-nav.l-pinned-left.l-layer-4.l-offset-nav
// SEARCH BAR // SEARCH BAR
@ -38,77 +45,61 @@ nav.side-nav.l-pinned-left.l-layer-4.l-offset-nav
label(for="search-io" class="is-hidden") Search Docs label(for="search-io" class="is-hidden") Search Docs
input(type="search" id="search-io" placeholder="SEARCH DOCS...") input(type="search" id="search-io" placeholder="SEARCH DOCS...")
button(class="mobile-trigger button" aria-label="View Docs Menu" ng-click="appCtrl.toggleDocsMenu($event)" md-button) Docs <span class="icon icon-arrow-drop-down"></span> button(class="mobile-trigger button" aria-label="View Docs Menu" ng-click="appCtrl.toggleDocsMenu($event)" md-button) Docs <span class="icon icon-arrow-drop-down"></span>
div(class="side-nav-secondary" ng-class="appCtrl.showDocsNav ? 'is-visible' : ''") div(class="side-nav-secondary" ng-class="appCtrl.showDocsNav ? 'is-visible' : ''")
.nav-blocks .nav-blocks
.nav-title Tutorial .nav-title Tutorial
.nav-primary-link .nav-primary-link(class="#{qs.class}")
a(href="#{qs.href}" title="#{qs.tooltip}") #{qs.navTitle} a(href="#{qs.href}" title="#{qs.tooltip}") #{qs.navTitle}
.nav-sub-title Case Study: Tour of Heroes .nav-sub-title Case Study: Tour of Heroes
.nav-ordered-lists .nav-ordered-lists
ol ol
each item in tutorial each item in tutorial
li: a(href="#{item.href}" title="#{item.tooltip}") #{item.navTitle} li(class="#{item.class}"): a(href="#{item.href}" title="#{item.tooltip}") #{item.navTitle}
.nav-blocks .nav-blocks
.nav-title Basics .nav-title Basics
.nav-ordered-lists .nav-ordered-lists
ol ol
each item in basics each item in basics
li: a(href="#{item.href}" title="#{item.tooltip}") #{item.navTitle} li(class="#{item.class}"): a(href="#{item.href}" title="#{item.tooltip}") #{item.navTitle}
.nav-blocks .nav-blocks
.nav-title Developer Guide .nav-title Developer Guide
.nav-unordered-lists .nav-unordered-lists
ul ul
each item in guide each item in guide
li: a(href="#{item.href}" title="#{item.tooltip}") #{item.navTitle} li(class="#{item.class}"): a(href="#{item.href}" title="#{item.tooltip}") #{item.navTitle}
.nav-blocks .nav-blocks
.nav-title Cookbook .nav-title Cookbook
.nav-unordered-lists .nav-unordered-lists
ul ul
each item in cookbook each item in cookbook
li: a(href="#{item.href}" title="#{item.tooltip}") #{item.navTitle} li(class="#{item.class}"): a(href="#{item.href}" title="#{item.tooltip}") #{item.navTitle}
.nav-blocks .nav-blocks
.nav-title Reference .nav-title Reference
.nav-unordered-lists .nav-unordered-lists
ul ul
each item in reference each item in reference
li: a(href="#{item.href}" title="#{item.tooltip}") #{item.navTitle} li(class="#{item.class}"): a(href="#{item.href}" title="#{item.tooltip}") #{item.navTitle}
.nav-blocks .nav-blocks
.nav-title Resources .nav-title Resources
.nav-unordered-lists .nav-unordered-lists
ul ul
each item in resources each item in resources
li: a(href="#{item.href}" title="#{item.tooltip}") #{item.navTitle} li(class="#{item.class}"): a(href="#{item.href}" title="#{item.tooltip}") #{item.navTitle}
script. script.
// Could put in appCtrl but only needed here and clear here // Could put in appCtrl but only needed here and clear here
(function highlightSelectedLink() { (function scrollToSelectedLink() {
var leftNav = document.getElementsByClassName('side-nav-secondary')[0]; var sideNav = document.getElementsByClassName('side-nav')[0];
if (!leftNav) {return;} var link = sideNav.getElementsByClassName('is-selected')[0];
var links = leftNav.getElementsByTagName('a'); if(link && link.offsetTop > window.innerHeight){
var path = location.toString(); sideNav.scrollTop = link.offsetTop - (window.innerHeight/2);
// remove trailing 'index.html' (10 chars) for matching purposes. //alert("offsetTop: " + link.offsetTop + " side-nav top is " + sideNav.scrollTop);
if (path.lastIndexOf('index.html') === path.length-10) { }
path = path.slice(0, -10);
}
for (var i=0; i < links.length; i++){
// assumes fresh page each time so no need to clear class
if (path === links[i].href) {
var parent = links[i].parentElement;
parent.classList.add('is-selected');
if(parent.offsetTop > window.innerHeight && parent.scrollIntoView){
sideNav = document.getElementsByClassName('side-nav')[0];
sideNav.scrollTop = parent.offsetTop - (window.innerHeight/2);
//alert("offsetTop: " + parent.offsetTop + " side-nav top is " + sideNav.scrollTop);
}
break;
}
}
})() })()

View File

@ -2,6 +2,7 @@
.l-main-section .l-main-section
h2 Victor Savkin's Blog Posts h2 Victor Savkin's Blog Posts
ul ul
li: a(href="http://victorsavkin.com/post/137821436516/managing-state-in-angular-2-applications") Managing State in Angular 2 Applications
li <a href="http://victorsavkin.com/post/114168430846/two-phases-of-angular-2-applications">Two Phases of Angular 2 Applications</a> li <a href="http://victorsavkin.com/post/114168430846/two-phases-of-angular-2-applications">Two Phases of Angular 2 Applications</a>
li <a href="http://angularjs.blogspot.com/2015/03/forms-in-angular-2.html">Forms in Angular 2</a> li <a href="http://angularjs.blogspot.com/2015/03/forms-in-angular-2.html">Forms in Angular 2</a>
li <a href="http://victorsavkin.com/post/110170125256/change-detection-in-angular-2">Change detection</a> li <a href="http://victorsavkin.com/post/110170125256/change-detection-in-angular-2">Change detection</a>

View File

@ -2,6 +2,7 @@
.l-main-section .l-main-section
h2 Blog Posts by thoughtram h2 Blog Posts by thoughtram
ul ul
li: a(href="http://blog.thoughtram.io/angular/2016/02/22/angular-2-change-detection-explained.html") Angular 2 Change Detection Explained
li <a href="http://blog.thoughtram.io/angular/2015/07/06/even-better-es5-code-for-angular-2.html">Even ES5 code for Angular 2</a> li <a href="http://blog.thoughtram.io/angular/2015/07/06/even-better-es5-code-for-angular-2.html">Even ES5 code for Angular 2</a>
li <a href="http://blog.thoughtram.io/angular/2015/06/29/shadow-dom-strategies-in-angular2.html">Shadow DOM Strategies in Angular 2</a> li <a href="http://blog.thoughtram.io/angular/2015/06/29/shadow-dom-strategies-in-angular2.html">Shadow DOM Strategies in Angular 2</a>
li <a href="http://blog.thoughtram.io/angular/2015/06/25/styling-angular-2-components.html">Styling Angular 2 components</a> li <a href="http://blog.thoughtram.io/angular/2015/06/25/styling-angular-2-components.html">Styling Angular 2 components</a>
@ -19,6 +20,7 @@
.l-main-section .l-main-section
h2 Victor Savkin's Blog Posts h2 Victor Savkin's Blog Posts
ul ul
li: a(href="http://victorsavkin.com/post/137821436516/managing-state-in-angular-2-applications") Managing State in Angular 2 Applications
li <a href="http://victorsavkin.com/post/114168430846/two-phases-of-angular-2-applications">Two Phases of Angular 2 Applications</a> li <a href="http://victorsavkin.com/post/114168430846/two-phases-of-angular-2-applications">Two Phases of Angular 2 Applications</a>
li <a href="http://angularjs.blogspot.com/2015/03/forms-in-angular-2.html">Forms in Angular 2</a> li <a href="http://angularjs.blogspot.com/2015/03/forms-in-angular-2.html">Forms in Angular 2</a>
li <a href="http://victorsavkin.com/post/110170125256/change-detection-in-angular-2">Change detection</a> li <a href="http://victorsavkin.com/post/110170125256/change-detection-in-angular-2">Change detection</a>

View File

@ -20,7 +20,7 @@ include ../_util-fns
## Feedback ## Feedback
The cookbook is a perpetual *work-in-progress*. The cookbook is a perpetual *work-in-progress*.
We welcome feedback! Leave a comment by clicking the icon in upper right corner of the banner. We welcome feedback! Leave a comment by clicking the icon in upper right corner of the banner.
Post *documentation* issues and pull requests on the Post *documentation* issues and pull requests on the

View File

@ -2,6 +2,7 @@
.l-main-section .l-main-section
h2 Victor Savkin's Blog Posts h2 Victor Savkin's Blog Posts
ul ul
li: a(href="http://victorsavkin.com/post/137821436516/managing-state-in-angular-2-applications") Managing State in Angular 2 Applications
li <a href="http://victorsavkin.com/post/114168430846/two-phases-of-angular-2-applications">Two Phases of Angular 2 Applications</a> li <a href="http://victorsavkin.com/post/114168430846/two-phases-of-angular-2-applications">Two Phases of Angular 2 Applications</a>
li <a href="http://angularjs.blogspot.com/2015/03/forms-in-angular-2.html">Forms in Angular 2</a> li <a href="http://angularjs.blogspot.com/2015/03/forms-in-angular-2.html">Forms in Angular 2</a>
li <a href="http://victorsavkin.com/post/110170125256/change-detection-in-angular-2">Change detection</a> li <a href="http://victorsavkin.com/post/110170125256/change-detection-in-angular-2">Change detection</a>