Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

API: add depth option #37

Open
wants to merge 3 commits into
base: gh-pages
Choose a base branch
from
Open

API: add depth option #37

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
0f95c75
API: add depth option
MathieuDuponchelle Jun 19, 2017
ee9e809
Fix indentation
Jun 20, 2017
b8420ec
Merge pull request #1 from kudaba/depth
MathieuDuponchelle Jun 20, 2017
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
46 changes: 20 additions & 26 deletions bootstrap-toc.css
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -8,53 +8,47 @@
/* All levels of nav */
nav[data-toggle='toc'] .nav > li > a {
display: block;
padding: 4px 20px;
font-size: 13px;
font-weight: 500;
color: #767676;
padding: 5px 10px;
border-left: 1px solid rgba(255, 255, 255, 0);
}

nav[data-toggle='toc'] .nav > li > a:hover,
nav[data-toggle='toc'] .nav > li > a:focus {
padding-left: 19px;
color: #563d7c;
text-decoration: none;
background-color: transparent;
border-left: 1px solid #563d7c;
}
nav[data-toggle='toc'] .nav > .active > a,
nav[data-toggle='toc'] .nav > .active:hover > a,
nav[data-toggle='toc'] .nav > .active:focus > a {
padding-left: 18px;
nav[data-toggle='toc'] .nav .active > a,
nav[data-toggle='toc'] .nav .active:hover > a,
nav[data-toggle='toc'] .nav .active:focus > a {
font-weight: bold;
color: #563d7c;
background-color: transparent;
border-left: 2px solid #563d7c;
}

nav[data-toggle='toc'] {
font-size: 18px;
}

nav[data-toggle='toc'] .nav {
position: relative;
padding-left: 7px;
font-size: 90%;
}

/* Nav: second level (shown on .active) */
nav[data-toggle='toc'] .nav .nav {
display: none; /* Hide by default, but at >768px, show it */
padding-bottom: 10px;
}
nav[data-toggle='toc'] .nav .nav > li > a {
padding-top: 1px;
padding-bottom: 1px;
padding-left: 30px;
font-size: 12px;
font-weight: normal;
}
nav[data-toggle='toc'] .nav .nav > li > a:hover,
nav[data-toggle='toc'] .nav .nav > li > a:focus {
padding-left: 29px;
}
nav[data-toggle='toc'] .nav .nav > .active > a,
nav[data-toggle='toc'] .nav .nav > .active:hover > a,
nav[data-toggle='toc'] .nav .nav > .active:focus > a {
padding-left: 28px;
font-weight: 500;
}

/* from https://github.com/twbs/bootstrap/blob/e38f066d8c203c3e032da0ff23cd2d6098ee2dd6/docs/assets/css/src/docs.css#L631-L634 */
nav[data-toggle='toc'] .nav > .active > ul {
nav[data-toggle='toc'] .nav > .active > ul,
nav[data-toggle='toc'] .nav:first-child li:first-child > ul:first-child,
nav[data-toggle='toc'] .nav > .active > ul li:first-child > ul:first-child
{
display: block;
}
65 changes: 42 additions & 23 deletions bootstrap-toc.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -65,6 +65,11 @@
return $li;
},

generateEmptyNavEl: function() {
var $li = $('<li></li>');
return $li;
},

generateNavItem: function(headingEl) {
var anchor = this.generateAnchor(headingEl);
var $heading = $(headingEl);
Expand All @@ -84,41 +89,54 @@
return 1;
},

// returns the elements for the top level, and the next below it
getHeadings: function($scope, topLevel) {
var topSelector = 'h' + topLevel;

var secondaryLevel = topLevel + 1;
var secondarySelector = 'h' + secondaryLevel;
getHeadings: function($scope, depth, topLevel) {
var selector = '';
for (var i = topLevel; i < topLevel + depth; i++) {
selector += 'h' + i;
if (i < topLevel + depth - 1)
selector += ',';
}

return this.findOrFilter($scope, topSelector + ',' + secondarySelector);
return this.findOrFilter($scope, selector);
},

getNavLevel: function(el) {
return parseInt(el.tagName.charAt(1), 10);
},

populateNav: function($topContext, topLevel, $headings) {
var $context = $topContext;
var $prevNav;
populateNav: function($topContext, depth, topLevel, $headings) {
var $contexts = new Array(depth);
var helpers = this;

$contexts[0] = $topContext;
$topContext.lastNav = null;

var helpers = this;
$headings.each(function(i, el) {
var $newNav = helpers.generateNavItem(el);
var navLevel = helpers.getNavLevel(el);
var relLevel = navLevel - topLevel;
var j;

// determine the proper $context
if (navLevel === topLevel) {
// use top level
$context = $topContext;
} else if ($prevNav && $context === $topContext) {
// create a new level of the tree and switch to it
$context = helpers.createChildNavList($prevNav);
} // else use the current $context
for (j = relLevel + 1; j < $contexts.length; j++) {
$contexts[j] = null;
}

$context.append($newNav);
if (!$contexts[relLevel]) {
for (j = 0; j < relLevel; j++) {
if (!$contexts[j + 1]) {
if (!$contexts[j].lastNav) {
var $emptyNav = helpers.generateEmptyNavEl();
$contexts[j].append($emptyNav);
$contexts[j].lastNav = $emptyNav;
}
$contexts[j + 1] = helpers.createChildNavList($contexts[j].lastNav);
$contexts[j + 1].lastNav = null;
}
}
}

$prevNav = $newNav;
$contexts[relLevel].append($newNav);
$contexts[relLevel].lastNav = $newNav;
});
},

Expand All @@ -132,6 +150,7 @@
opts = arg;
}
opts.$scope = opts.$scope || $(document.body);
opts.depth = opts.depth || opts.$nav.attr('data-toc-depth') || 2;
return opts;
}
},
Expand All @@ -145,8 +164,8 @@

var $topContext = this.helpers.createChildNavList(opts.$nav);
var topLevel = this.helpers.getTopLevel(opts.$scope);
var $headings = this.helpers.getHeadings(opts.$scope, topLevel);
this.helpers.populateNav($topContext, topLevel, $headings);
var $headings = this.helpers.getHeadings(opts.$scope, opts.depth, topLevel);
this.helpers.populateNav($topContext, opts.depth, topLevel, $headings);
}
};

Expand Down
1 change: 1 addition & 0 deletions index.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -83,6 +83,7 @@ option | type | notes
--- | --- | ---
`$nav` | jQuery Object | (required) The element that the navigation will be created in.
`$scope` | jQuery Object | The element where the search for headings will be limited to, or the list of headings that will be used in the navigation. Defaults to `$(document.body)`.
`depth` | Integer | The number of heading classes to consider, starting from the top level. Defaults to `2`.
{: .table }

## Customization
Expand Down
109 changes: 108 additions & 1 deletion test/toc-test.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -89,7 +89,7 @@ describe('Toc', function() {
expect(level).to.eql(6);
});
});

describe('.getNavLevel()', function() {
it("returns the value from the tag", function() {
var el = document.createElement('h5');
Expand Down Expand Up @@ -206,5 +206,112 @@ describe('Toc', function() {
'</ul>'
);
});

it("handles up to 6 nested headings", function() {
$fixture.append(
'<h1>H1</h1>' +
'<h2>H2</h2>' +
'<h3>H3</h3>' +
'<h4>H4</h4>' +
'<h5>H5</h5>' +
'<h6>H6</h6>'
);

$nav = $(
'<nav data-toc-depth="6"></nav>'
);

Toc.init({
$nav: $nav,
$scope: $fixture
});

expect($nav.html()).to.eql(
'<ul class="nav">' +
'<li>' +
'<a href="#h1">H1</a>' +
'<ul class="nav">' +
'<li>' +
'<a href="#h2">H2</a>' +
'<ul class="nav">' +
'<li>' +
'<a href="#h3">H3</a>' +
'<ul class="nav">' +
'<li>' +
'<a href="#h4">H4</a>' +
'<ul class="nav">' +
'<li>' +
'<a href="#h5">H5</a>' +
'<ul class="nav">' +
'<li>' +
'<a href="#h6">H6</a>' +
'</li>' +
'</ul>' +
'</li>' +
'</ul>' +
'</li>' +
'</ul>' +
'</li>' +
'</ul>' +
'</li>' +
'</ul>' +
'</li>' +
'</ul>'
);
});

it("handles staggered nesting", function() {
$fixture.append(
'<h1>H1</h1>' +
'<h2>H2</h2>' +
'<h3>H3</h3>' +
'<h1>H1-1</h1>' + // expect drop from 3 to 1
'<h3>H3-1</h3>' + // intentionally in wrong spot
'<h2>H2-1</h2>'
);

$nav = $(
'<nav data-toc-depth="6"></nav>'
);

Toc.init({
$nav: $nav,
$scope: $fixture
});

expect($nav.html()).to.eql(
'<ul class="nav">' +
'<li>' +
'<a href="#h1">H1</a>' +
'<ul class="nav">' +
'<li>' +
'<a href="#h2">H2</a>' +
'<ul class="nav">' +
'<li>' +
'<a href="#h3">H3</a>' +
'</li>' +
'</ul>' +
'</li>' +
'</ul>' +
'</li>' +
'<li>' +
'<a href="#h1-1">H1-1</a>' +
'<ul class="nav">' +
'<li>' +
'<ul class="nav">' +
'<li>' +
'<a href="#h3-1">H3-1</a>' +
'</li>' +
'</ul>' +
'</li>' +
'<li>' +
'<a href="#h2-1">H2-1</a>' +
'</li>' +
'</ul>' +
'</li>' +
'</ul>'
);
});

});
});