Skip to content

Added an ignoreSelector option to exclude header elements #27

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

Merged
gfranko merged 4 commits into from
Apr 13, 2013
Merged

Added an ignoreSelector option to exclude header elements #27

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
82ec05d
Added an ignoreSelector option to exclude header elements that match …
kevinoconnor7 Apr 8, 2013
acec89f
Merge branch 'dev' of github.com:kevinoconnor7/jquery.tocify.js into …
kevinoconnor7 Apr 9, 2013
17f02e3
Remove leftover code from testing
kevinoconnor7 Apr 9, 2013
5f7a0c9
Merge remote-tracking branch 'upstream/dev' into ignoreSelected
kevinoconnor7 Apr 9, 2013
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
9 changes: 8 additions & 1 deletion demos/default.html
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -202,6 +202,13 @@ <h3>Options</h3>
<td>"body"</td>
<td>Any valid jQuery selector</td>
</tr>
<tr>
<td class="optionName" title="ignoreSelector" data-content="A selector to any element that would be matched by selectors that you wish to be ignored"><a href="#">ignoreSelector</a></td>
<td>String</td>
<td>null</td>
<td>Any valid jQuery selector</td>
</tr>
<tr>
<td class="optionName" title="selectors" data-content="The element's used to generate the table of contents. The order is very important since it will determine the table of content's nesting structure."><a href="#">selectors</a></td>
<td>String</td>
<td>"h1,h2,h3"</td>
Expand Down Expand Up @@ -438,4 +445,4 @@ <h2>Donation</h2>
</script>

</body>
</html>
</html>
24 changes: 23 additions & 1 deletion src/javascripts/jquery.tocify.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -32,6 +32,10 @@
// The container element that holds all of the elements used to generate the table of contents
context: "body",

// **ignoreSelector**: Accepts String: Any jQuery selector
// A selector to any element that would be matched by selectors that you wish to be ignored
ignoreSelector: null,

// **selectors**: Accepts an Array of Strings: Any jQuery selectors
// The element's used to generate the table of contents. The order is very important since it will determine the table of content's nesting structure
selectors: "h1, h2, h3",
Expand Down Expand Up @@ -208,6 +212,12 @@
// Loops through each top level selector
firstElem.each(function(index) {

//If the element matches the ignoreSelector then we skip it
if($(this).is(self.options.ignoreSelector))
{
return;
}

// Creates an unordered list HTML element and adds a dynamic ID and standard class name
ul = $("<ul/>", {
"id": "Header" + index,
Expand All @@ -229,6 +239,12 @@
// Loops through all of the subheader elements
$(this).filter(self.options.selectors).each(function() {

//If the element matches the ignoreSelector then we skip it
if($(this).is(self.options.ignoreSelector))
{
return;
}

self._appendSubheaders.call(this, self, ul);

});
Expand All @@ -241,6 +257,12 @@
// Loops through all of the subheader elements
$(this).find(self.options.selectors).each(function() {

//If the element matches the ignoreSelector then we skip it
if($(this).is(self.options.ignoreSelector))
{
return;
}

self._appendSubheaders.call(this, self, ul);

});
Expand Down Expand Up @@ -911,4 +933,4 @@

});

})); //end of plugin
})); //end of plugin