		{
		"name": "bit-docs-html-toc",
		"version": "0.5.0",
		"version": "0.6.0",
		"description": "table of contents bit-docs plugin",
		@@ -5,0 +5,0 @@ "main": "toc.js",

readme.md

		@@ -34,6 +34,18 @@ # bit-docs-html-toc

		```js
		```html
		<div class="on-this-page-container"></div>
		```

		By default, all heading tags children of the first `article` tag on the page will
		be collected to create the table of contents; if you want to use a different element
		just do:

		```html
		<div
		class="on-this-page-container"
		data-heading-container-selector="#my-custom-selector"
		>
		</div>
		```

		The table of contents will be injected into this element at run time.

test/test.js

		require("./make-tree-test");
		require("./toc-control-test");
		require("./toc-container-control-test");

toc.js

		@@ -1,35 +0,9 @@
		var Control = require("can-control");
		var TableOfContents = require("./toc-control");
		var TOCContainer = require("./toc-container-control");

		var TOCContainer = Control.extend({
		init: function(el) {
		el.style.display = "none";
		var el = document.getElementsByClassName("on-this-page-container");

		var depth = this.getOutlineDepth();
		var tagName = this.getOutlineTagName();
		var toc = document.createElement(tagName);

		toc.className = "on-this-page";
		el.appendChild(toc);

		new TableOfContents(toc, {
		depth: depth,
		tagName: tagName,
		headingsContainerSelector: "article"
		});
		},

		getOutlineTagName: function() {
		var outline = window.docObject.outline \|\| {};
		return (outline.tag === "ol") ? "ol" : "ul";
		},

		getOutlineDepth: function() {
		var depth = window.docObject.outline && window.docObject.outline.depth;
		return (typeof depth === "number" ? Math.min(depth, 6) : 1);
		}
		});

		new TOCContainer(
		document.getElementsByClassName("on-this-page-container")[0]
		);
		if (el.length) {
		new TOCContainer(el);
		} else {
		console.log("An element with class 'on-this-page-container' is required");
		}

bit-docs-html-toc - npm Package Compare versions

New alerts