alchemy-widget 0.1.1 → 0.1.2

package/CHANGELOG.md

@@ -1,3 +1,7 @@
+## 0.1.2 (2022-02-20)
+
+* Add `table-of-contents` element and widget
+
 ## 0.1.1 (2022-01-28)
 
 * Hide context button when clicking out of widget

package/assets/stylesheets/alchemy-widgets.scss

@@ -251,4 +251,8 @@ alchemy-widget[type="header"] {
 		font-weight: bold;
 		height: 1.3em;
 	}
+}
+
+table-of-contents {
+	display: block;
 }

package/element/table_of_contents_element.js

@@ -0,0 +1,193 @@
+/**
+ * The table-of-contents element
+ *
+ * @author   Jelle De Loecker   <jelle@elevenways.be>
+ * @since    0.1.2
+ * @version  0.1.2
+ */
+const TableOfContents = Function.inherits('Alchemy.Element.App', 'TableOfContents');
+
+/**
+ * The template to use for the content of this element
+ *
+ * @author   Jelle De Loecker   <jelle@elevenways.be>
+ * @since    0.1.2
+ * @version  0.1.2
+ */
+TableOfContents.setTemplateFile('elements/table_of_contents');
+
+/**
+ * Set the content
+ *
+ * @author   Jelle De Loecker   <jelle@elevenways.be>
+ * @since    0.1.2
+ * @version  0.1.2
+ */
+TableOfContents.setAssignedProperty('content');
+
+/**
+ * The role of this element
+ *
+ * @author   Jelle De Loecker   <jelle@elevenways.be>
+ * @since    0.1.2
+ * @version  0.1.2
+ */
+TableOfContents.setRole('navigation');
+
+/**
+ * The parent query
+ *
+ * @author   Jelle De Loecker   <jelle@elevenways.be>
+ * @since    0.1.2
+ * @version  0.1.2
+ */
+TableOfContents.setAttribute('parent-selector');
+
+/**
+ * The children query
+ *
+ * @author   Jelle De Loecker   <jelle@elevenways.be>
+ * @since    0.1.2
+ * @version  0.1.2
+ */
+TableOfContents.setAttribute('children-selector');
+
+/**
+ * The elements query
+ *
+ * @author   Jelle De Loecker   <jelle@elevenways.be>
+ * @since    0.1.2
+ * @version  0.1.2
+ */
+TableOfContents.setAttribute('elements-selector');
+
+/**
+ * The elements query
+ *
+ * @author   Jelle De Loecker   <jelle@elevenways.be>
+ * @since    0.1.2
+ * @version  0.1.2
+ */
+TableOfContents.setAttribute('title-selector');
+
+/**
+ * The class to add when intersecting (visible)
+ *
+ * @author   Jelle De Loecker   <jelle@elevenways.be>
+ * @since    0.1.2
+ * @version  0.1.2
+ */
+TableOfContents.setAttribute('intersection-class');
+
+/**
+ * Get the entries
+ *
+ * @author   Jelle De Loecker   <jelle@elevenways.be>
+ * @since    0.1.2
+ * @version  0.1.2
+ */
+TableOfContents.setProperty(function entries() {
+
+	let result = [],
+		parent = this.parentElement,
+		wrapper;
+
+	if (this.parent_selector) {
+		parent = this.queryParents(this.parent_selector);
+	}
+
+	if (parent) {
+		wrapper = parent;
+	}
+
+	if (wrapper && this.children_selector) {
+		wrapper = wrapper.querySelector(this.children_selector);
+	}
+
+	if (wrapper) {
+		let elements = wrapper.querySelectorAll(this.elements_selector || 'h1,h2'),
+			element,
+			title,
+			i;
+
+		for (i = 0; i < elements.length; i++) {
+			element = elements[i];
+
+			if (!element.id) {
+
+				if (element.hawkejs_id) {
+					element.id = element.hawkejs_id;
+				}
+
+				if (!element.id) {
+					continue;
+				}
+			}
+
+			let title_element;
+
+			if (this.title_selector) {
+				title_element = element.querySelector(this.title_selector);
+			}
+
+			if (!title_element) {
+				title_element = element;
+			}
+
+			title = (title_element.toc_title || title_element.textContent || '').trim();
+
+			title = title.truncate(30);
+
+			// Don't add empty titles
+			if (!title) {
+				continue;
+			}
+
+			result.push({
+				id      : element.id,
+				title   : title,
+				element : element,
+			});
+		}
+	}
+
+	return result;
+});
+
+/**
+ * Added to the dom for the first time
+ *
+ * @author   Jelle De Loecker   <jelle@elevenways.be>
+ * @since    0.1.2
+ * @version  0.1.2
+ */
+TableOfContents.setMethod(async function introduced() {
+
+	await this.rerender();
+
+	const observer = new IntersectionObserver(entries => {
+
+		let class_name = this.intersection_class || 'visible';
+
+		for (let entry of entries) {
+			const id = entry.target.getAttribute('id');
+
+			let query = `a[href="#${id}"]`,
+			    element = this.querySelector(query);
+			
+			if (!element) {
+				return;
+			}
+
+			if (entry.intersectionRatio > 0) {
+				element.classList.add(class_name);
+			} else {
+				element.classList.remove(class_name);
+			}
+		};
+	});
+
+	for (let entry of this.entries) {
+		observer.observe(entry.element);
+	}
+});

package/helper/widgets/00-widget.js

@@ -408,7 +408,7 @@ Widget.setMethod(function _createPopulatedWidgetElement() {
  *
  * @author   Jelle De Loecker   <jelle@elevenways.be>
  * @since    0.1.0
- * @version  0.1.0
+ * @version  0.1.2
  */
 Widget.setMethod(function populateWidget() {
 
@@ -416,8 +416,10 @@ Widget.setMethod(function populateWidget() {
 		let name,
 		    i;
 
-		for (i = 0; i < this.config.wrapper_class_names.length; i++) {
-			name = this.config.wrapper_class_names[i];
+		let class_names = Array.cast(this.config.wrapper_class_names);
+
+		for (i = 0; i < class_names.length; i++) {
+			name = class_names[i];
 			this.widget.classList.add(name);
 		}
 	}

package/helper/widgets/table_of_contents.js

@@ -0,0 +1,44 @@
+/**
+ * The TOC Widget class
+ *
+ * @constructor
+ *
+ * @author   Jelle De Loecker <jelle@elevenways.be>
+ * @since    0.1.2
+ * @version  0.1.2
+ *
+ * @param    {Object}   data
+ */
+const Toc = Function.inherits('Alchemy.Widget', 'TableOfContents');
+
+/**
+ * Populate the widget
+ *
+ * @author   Jelle De Loecker   <jelle@elevenways.be>
+ * @since    0.1.2
+ * @version  0.1.2
+ */
+Toc.setMethod(function populateWidget() {
+
+	populateWidget.super.call(this);
+
+	let toc = this.createElement('table-of-contents');
+
+	if (this.config.parent_selector) {
+		toc.parent_selector = this.config.parent_selector;
+	}
+
+	if (this.config.elements_selector) {
+		toc.elements_selector = this.config.elements_selector;
+	}
+
+	if (this.config.child_selector) {
+		toc.child_selector = this.config.child_selector;
+	}
+
+	if (this.config.title_selector) {
+		toc.title_selector = this.config.title_selector;
+	}
+
+	this.widget.append(toc);
+});

package/package.json

@@ -1,7 +1,7 @@
 {
 	"name": "alchemy-widget",
 	"description": "The widget plugin for the AlchemyMVC",
-	"version": "0.1.1",
+	"version": "0.1.2",
 	"author": "Jelle De Loecker <jelle@elevenways.be>",
 	"keywords": [
 		"alchemy",
@@ -10,7 +10,7 @@
 		"widget"
 	],
 	"peerDependencies": {
-		"alchemymvc" : "~1.1.0"
+		"alchemymvc" : ">=1.1.0"
 	},
 	"repository": "11ways/alchemy-widget",
 	"license": "MIT",

package/view/elements/table_of_contents.hwk

@@ -0,0 +1,9 @@
+<ol>
+	{% each self.entries as entry %}
+		<li>
+			<a href="#{% entry.id %}">
+				{{ entry.title }}
+			</a>
+		</li>
+	{% /each %}
+</ol>