alchemy-widget 0.1.1 → 0.1.4

package/CHANGELOG.md

@@ -1,3 +1,16 @@
+## 0.1.4 (2022-06-23)
+
+* Use `he-context-menu` element to show widgets to add
+* Add widget actions to move across container boundaries
+
+## 0.1.3 (2022-03-21)
+
+* Catch and print errors when appending a widget to a container
+
+## 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

@@ -11,7 +11,7 @@ alchemy-widgets-column {
 	}
 
 	> * {
-		flex: 1;
+		flex: 10;
 	}
 }
 
@@ -53,7 +53,7 @@ alchemy-widgets {
 
 alchemy-widgets-row {
 	flex-flow: row;
-	flex: 1 1 auto;
+	flex: 10 10 auto;
 
 	&.aw-editing {
 		padding-right: 5rem;
@@ -91,7 +91,7 @@ alchemy-widgets-column > alchemy-widgets-column,
 }
 
 alchemy-widgets-column {
-	flex: 1 1 auto;
+	flex: 10 10 auto;
 }
 
 alchemy-widgets-column,
@@ -149,8 +149,8 @@ alchemy-widget-add-area {
 	display: flex;
 	align-content: center;
 	min-height: 26px;
-	min-width: 26px;
 	align-items: center;
+	text-transform: uppercase;
 
 	&:hover {
 		color: #388ae5;
@@ -251,4 +251,8 @@ alchemy-widget[type="header"] {
 		font-weight: bold;
 		height: 1.3em;
 	}
+}
+
+table-of-contents {
+	display: block;
 }

package/element/00-widget_base_element.js

@@ -42,9 +42,89 @@ Base.setAssignedProperty('instance');
  *
  * @author   Jelle De Loecker <jelle@elevenways.be>
  * @since    0.1.0
- * @version  0.1.0
+ * @version  0.1.4
+ */
+Base.setProperty(function parent_container() {
+
+	let container,
+	    current = this.parentElement;
+	
+	while (current) {
+		if (current.is_container) {
+			container = current;
+			break;
+		}
+
+		current = current.parentElement;
+	}
+
+	return container;
+});
+
+/**
+ * The next container across container boundaries
+ *
+ * @author   Jelle De Loecker <jelle@elevenways.be>
+ * @since    0.1.4
+ * @version  0.1.4
+ */
+Base.setProperty(function next_container() {
+	return this.getSiblingContainer('next');
+});
+
+/**
+ * The previous container across container boundaries
+ *
+ * @author   Jelle De Loecker <jelle@elevenways.be>
+ * @since    0.1.4
+ * @version  0.1.4
  */
-Base.setProperty('parent_container');
+Base.setProperty(function previous_container() {
+	return this.getSiblingContainer('previous');
+});
+
+/**
+ * Get a sibling container
+ *
+ * @author   Jelle De Loecker   <jelle@elevenways.be>
+ * @since    0.1.4
+ * @version  0.1.4
+ */
+Base.setMethod(function getSiblingContainer(type) {
+	let property;
+
+	if (type == 'next') {
+		property = 'nextElementSibling';
+	} else if (type == 'previous') {
+		property = 'previousElementSibling';
+	} else {
+		return false;
+	}
+
+	if (!this[property] && !this.parent_container) {
+		return;
+	}
+
+	let next = this[property];
+
+	if (next) {
+		if (next.is_container) {
+			return next;
+		}
+
+		if (next.tagName != 'ALCHEMY-WIDGET-ADD-AREA') {
+			return false;
+		}
+	}
+
+	next = this.parent_container[property];
+
+	if (next && next.is_container) {
+		return next;
+	}
+
+	return false;
+});
 
 /**
  * Look for a context variable

package/element/10-container_elements.js

@@ -32,6 +32,15 @@ AlchemyWidgets.setStatic('custom_element_prefix', 'alchemy-widgets');
  */
 AlchemyWidgets.setProperty('add_edit_event_listeners', false);
 
+/**
+ * Indicate this is a container
+ *
+ * @author   Jelle De Loecker   <jelle@elevenways.be>
+ * @since    0.1.4
+ * @version  0.1.4
+ */
+AlchemyWidgets.setProperty('is_container', true);
+
 /**
  * Context variables
  *
@@ -179,15 +188,26 @@ AlchemyWidgets.setMethod(function clear() {
  *
  * @author   Jelle De Loecker   <jelle@elevenways.be>
  * @since    0.1.0
- * @version  0.1.0
+ * @version  0.1.3
  *
  * @param    {String}   type
  * @param    {Object}   config
  */
 AlchemyWidgets.setMethod(function addWidget(type, config) {
 
+	let instance;
+
 	// Create the instance of the widget
-	let instance = this.instance.createChildWidget(type, config);
+	try {
+		instance = this.instance.createChildWidget(type, config);
+	} catch (err) {
+		config = {
+			original_config : config,
+			html            : '<pre>' + err.message + '\n' + err.stack + '</pre>',
+		};
+
+		instance = this.instance.createChildWidget('html', config);
+	}
 
 	// Attach the renderer
 	instance.hawkejs_renderer = this.hawkejs_renderer;
@@ -195,9 +215,6 @@ AlchemyWidgets.setMethod(function addWidget(type, config) {
 	// Get the actual widget HTML element
 	let element = instance.element;
 
-	// Make the element know what its parent container is
-	element.parent_container = this;
-
 	this._appendWidgetElement(element);
 
 	element.value = config;

package/element/20-add_area_element.js

@@ -26,11 +26,9 @@ let AddArea = Function.inherits('Alchemy.Element.Widget.Base', function AlchemyW
  * @since    0.1.0
  * @version  0.1.0
  */
-AddArea.setMethod(function showTypes() {
+AddArea.setMethod(function showTypes(event) {
 
-	let that = this,
-	    types_element = this.querySelector('.widget-types'),
-	    widgets = alchemy.getClassGroup('widgets');
+	let that = this;
 
 	let context_button = document.querySelector('alchemy-widget-context');
 
@@ -38,31 +36,25 @@ AddArea.setMethod(function showTypes() {
 		context_button.unselectedWidget();
 	}
 
-	this.classList.add('show-types');
+	let context = this.createElement('he-context-menu');
 
-	Hawkejs.removeChildren(types_element);
+	let widgets = Object.values(alchemy.getClassGroup('widgets')).sortByPath(1, 'title');
 
-	for (let key in widgets) {
+	for (let widget of widgets) {
 
-		if (key == 'container') {
+		if (widget.type_name == 'container') {
 			continue;
 		}
 
-		let widget = widgets[key];
-
-		let button = this.createElement('button');
-		button.setAttribute('data-type', key);
-		button.textContent = widget.title;
-
-		button.addEventListener('click', function onClick(e) {
-			e.preventDefault();
-			that.classList.remove('show-types');
-
-			that.parentElement.addWidget(key);
+		context.addEntry({
+			title : widget.title,
+			icon  : null,
+		}, e => {
+			that.parentElement.addWidget(widget.type_name);
 		});
-
-		types_element.append(button);
 	}
+
+	context.show(event);
 });
 
 /**
@@ -107,7 +99,7 @@ AddArea.setMethod(function introduced() {
 
 	add_button.addEventListener('click', function onClick(e) {
 		e.preventDefault();
-		that.showTypes();
+		that.showTypes(e);
 	});
 
 	let context_button = this.querySelector('.menu-button');

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/element/widget_toolbar_element.js

@@ -38,6 +38,7 @@ Toolbar.setMethod(function showWidgetActions(widget) {
 		button.classList.add('aw-toolbar-button');
 
 		button.innerHTML = action.getButtonHTML();
+		button.setAttribute('title', action.title);
 
 		let is_selected = action.isAlreadySelected(widget);
 

package/helper/widgets/00-widget.js

@@ -107,12 +107,16 @@ Widget.constitute(function prepareSchema() {
 
 	// Extra classnames for the wrapper
 	this.schema.addField('wrapper_class_names', 'String', {
+		title       : 'Wrapper CSS classes',
+		description : 'Configure extra CSS classes to the wrapper `alchemy-widget` element', 
 		array: true,
 		widget_config_editable: true,
 	});
 
 	// Classnames for the inserted element (if any)
 	this.schema.addField('main_class_names', 'String', {
+		title       : 'Main CSS classes',
+		description : 'Configure extra CSS classes for the main inserted element', 
 		array: true,
 	});
 
@@ -179,6 +183,47 @@ Widget.constitute(function prepareSchema() {
 
 	move_right.setIcon('gg-arrow-right');
 
+	// The move-in-left action
+	let move_in_left = this.createAction('move-in-left', 'Move in left');
+
+	move_in_left.close_toolbar = true;
+
+	move_in_left.setHandler(function moveLeftAction(widget_el, handle) {
+		// Hawkejs custom element method!
+		let container = handle.previous_container;
+
+		if (container) {
+			container.append(handle);
+		}
+	});
+
+	move_in_left.setTester(function moveLeftTest(widget_el, handle) {
+		return !!handle.previous_container;
+	});
+
+	move_in_left.setIcon('gg-arrow-left');
+
+	// The move-in-right action
+	let move_in_right = this.createAction('move-in-right', 'Move in right');
+
+	move_in_right.close_toolbar = true;
+
+	move_in_right.setHandler(function moveRightAction(widget_el, handle) {
+		// Hawkejs custom element method!
+		let container = handle.next_container;
+
+		if (container) {
+			container.prepend(handle);
+		}
+	});
+
+	move_in_right.setTester(function moveRightTest(widget_el, handle) {
+		console.log('Right test of:', handle)
+		return !!handle.next_container;
+	});
+
+	move_in_right.setIcon('gg-arrow-right');
+
 	let css_class = this.createAction('css-class', 'CSS Class');
 
 	css_class.setHandler(function setCssClass(widget_el, handle) {
@@ -212,11 +257,11 @@ Widget.setStatic(function createSchema() {
  *
  * @author   Jelle De Loecker   <jelle@elevenways.be>
  * @since    0.1.0
- * @version  0.1.0
+ * @version  0.1.4
  */
-Widget.setStatic(function createAction(name) {
+Widget.setStatic(function createAction(name, title) {
 
-	let action = new Classes.Alchemy.Widget.Action(name);
+	let action = new Classes.Alchemy.Widget.Action(name, title || name.titleize());
 
 	this.actions.set(name, action);
 
@@ -408,7 +453,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 +461,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.4",
 	"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>