alchemy-chimera 1.0.0 → 1.0.3

package/CHANGELOG.md

@@ -1,3 +1,21 @@
+## 1.0.3 (2022-03-16)
+
+* Make table filtering case insensitive
+
+## 1.0.2 (2022-02-20)
+
+* Improve editor styling
+* Put editor errors in the Widget context
+* Add TOC to editor
+* Make sidebar sticky
+
+## 1.0.1 (2022-01-28)
+
+* Allow setting a simple menu sidebar in the config
+* Add simple notification after adding/saving
+* Add page & window titles
+* Improve edit buttons
+
 ## 1.0.0 (2021-09-12)
 
 * Use widgets to create the interface

package/assets/scripts/chimera/chimera.js

@@ -0,0 +1,19 @@
+hawkejs.scene.after({
+	type     : 'set',
+	name     : 'page-notification',
+}, function onNotification(element, variables, block) {
+
+	let notification = element.querySelector('.notification');
+
+	if (!notification) {
+		return;
+	}
+
+	setTimeout(() => {
+		notification.classList.add('removing');
+
+		setTimeout(() => {
+			notification.remove();
+		}, 2500);
+	}, 4 * 1000);
+});

package/assets/stylesheets/chimera/chimera.scss

@@ -10,10 +10,15 @@ body {
 	--text-color: #475466;
 	--main-bg-color: #ebedf0;
 	--main-border-color: #dadee0;
+	
 	--button-bg-color: #F4F5F9;
 	--button-bg-hover-color: #e7e9f2;
 	--button-text-color: #3699FF;
 
+	--notification-bg-color: #4a4e58;
+	--notification-text-color: #f4f5f9;
+	--notification-border-color: #dadee0;
+
 	--color-title: #475466;
 	--color-box-border: #DADEE0;
 	--color-active: #3699FF;
@@ -27,25 +32,97 @@ body {
 }
 
 .btn {
+	//--button-bg-color: var(--context-background-color, --button-bg-color);
+	--local-text-color: var(--context-color, var(--button-text-color));
+	--local-border-color: var(--context-border-color, var(--button-border-color));
+
 	background-color: var(--button-bg-color);
+	color: var(--local-text-color);
+	border: 1px solid;
+	border-color: var(--local-border-color);
+
 	text-decoration: none;
-	color: var(--button-text-color);
 	line-height: 2rem;
 	min-width: 10rem;
 	text-align: center;
 	border-radius: 2px;
 	font-weight: 500;
+	cursor: pointer;
 
 	&:hover {
 		background-color: var(--button-bg-hover-color);
+		//filter: brightness(1.05);
 	}
 }
 
+.primary {
+	--context-color: #084298;
+	--context-background-color: #cfe2ff;
+	--context-border-color: #b6d4fe;
+}
+
+.secondary {
+	--context-color: #41464b;
+	--context-background-color: #e2e3e5;
+	--context-border-color: #d3d6d8;
+}
+
+.success {
+	--context-color: #0f5132;
+	--context-background-color: #d1e7dd;
+	--context-border-color: #badbcc;
+}
+
+.danger,
+.error {
+	--context-color: #842029;
+	--context-background-color: #f8d7da;
+	--context-border-color: #f5c2c7;
+}
+
+.warning {
+	--context-color: #664d03;
+	--context-background-color: #fff3cd;
+	--context-border-color: #ffecb5;
+}
+
+.info {
+	--context-color: #055160;
+	--context-background-color: #cff4fc;
+	--context-border-color: #b6effb;
+}
+
+.light {
+	--context-color: #636464;
+	--context-background-color: #fefefe;
+	--context-border-color: #fdfdfe;
+}
+
+.dark {
+	--context-color: #141619;
+	--context-background-color: #d3d3d4;
+	--context-border-color: #bcbebf;
+}
+
+.alert-box {
+	color: var(--context-color);
+	background-color: var(--context-background-color);
+	border: 1px solid;
+	border-color: var(--context-border-color);
+	padding: 1rem;
+	margin: 1rem 0 1rem;
+}
+
 .chimera-sidebar {
 	background-color: var(--sidebar-bg-color);
 	flex: 0 0 14rem;
 	display: flex;
 	flex-flow: column;
+
+	.sidebar-widgets {
+		position: sticky;
+		top: 1rem;
+	}
 }
 
 .chimera-content {
@@ -86,6 +163,12 @@ body {
 .chimera-main {
 	flex: 1;
 	padding: 0.5rem;
+
+	&[data-he-template="chimera/widgets"] {
+		h1 {
+			padding-top: 0;
+		}
+	}
 }
 
 .main-widgets {
@@ -156,16 +239,41 @@ alchemy-widgets-navigation {
 	height: 2rem;
 }
 
+.page-notification {
+	.notification {
+		border: 1px solid var(--notification-border-color);
+		background: var(--notification-bg-color);
+		color: var(--notification-text-color);
+		border-radius: 5px;
+		padding: 0.5rem 0.8rem;
+	}
+}
+
+.removing {
+	transition: opacity 2s;
+	opacity: 0;
+}
+
 alchemy-table .aft-column-filters input {
 	@extend .chimera-input-field;
 	width: 100%;
 }
 
+alchemy-form {
+	.error-area:not(:empty) {
+		@extend .error, .alert-box;
+		margin-top: 0;
+	}
+}
+
 alchemy-field {
 	border: 1px solid var(--color-box-border);
 	background-color: white;
 	border-radius: 4px;
 
+	// In case something goes wrong:
+	min-height: 1rem;
+
 	alchemy-label {
 		padding-left: 1rem;
 		line-height: 3rem;
@@ -211,6 +319,7 @@ alchemy-field {
 	.field {
 		display: flex;
 		padding: 1rem;
+		flex: 1;
 
 		> * {
 			flex: 1;
@@ -222,16 +331,121 @@ alchemy-field {
 		}
 	}
 
-	.field input[type="text"],
-	.field input[type="number"],
-	.field input[type="color"] {
-		@extend .chimera-input-field;
-		height: 3rem;
+	.field {
+		input[type="text"],
+		input[type="number"],
+		input[type="color"],
+		input[type="datetime-local"],
+		input[type="password"] {
+			@extend .chimera-input-field;
+			height: 3rem;
+		}
+
+		textarea {
+			@extend .chimera-input-field;
+			min-height: 5rem;
+			padding: 1rem;
+		}
+
+		input[type="color"] {
+			background-color: transparent;
+			border: none;
+			padding: 0;
+		}
 	}
+}
+
+alchemy-field-array {
+	.add-entry {
+		@extend .btn;
+		margin: 1rem 0 0 1rem;
+	}
+
+	button.remove {
+		@extend .btn;
+		@extend .danger;
+		min-width: 6rem;
+		margin: 0 1rem 1rem 0;
+	}
+
+	.entries {
+		margin-top: 0.5rem;
+	}
+
+	alchemy-field-array-entry:not(:last-of-type) {
+		//border-bottom: 1px solid gray;
+		position: relative;
+
+		&::after {
+			display: block;
+			content: " ";
+			background-color: lightgray;
+			position: absolute;
+			bottom: 0;
+			height: 1px;
+			left: 50%;
+			transform: translateX(-50%);
+			width: 80%;
+		}
+	}
+
+	alchemy-field-array-entry:not(:first-of-type) {
+		margin-top: 1rem;
+	}
+}
 
-	.field input[type="color"] {
-		background-color: transparent;
+.chimera-editor-widgets {
+
+	alchemy-widgets-column.toc-col {
+		flex: 1 1;
+	}
+
+	table-of-contents[elements-selector="alchemy-field"] {
+		align-self: start;
+		top: 2rem;
+		position: sticky;
+
+		ol {
+			list-style: none;
+			margin: 0 0 0 2rem;
+			padding: 0;
+
+			li {
+				a {
+					display: block;
+					line-height: 2rem;
+					border-bottom: 1px solid #aaa;
+					text-decoration: none;
+					opacity: 0.5;
+					color: #0070e4;
+				}
+			}
+	
+			li a.visible {
+				opacity: 1;
+			}
+		}
+	}
+}
+
+alchemy-field-schema {
+	alchemy-field {
 		border: none;
-		padding: 0;
+		margin-bottom: 1rem;
+	}
+}
+
+.aft-actions {
+	a {
+		color: var(--button-text-color);
+		background-color: var(--button-bg-color);
+		padding: 0.5rem;
+		border-radius: 6px;
+		margin: 0.2rem;
+		display: inline-block;
+
+		&:hover {
+			background-color: var(--button-bg-hover-color);
+		}
 	}
 }

package/controller/chimera_editor_controller.js

@@ -7,12 +7,44 @@
  */
 const Editor = Function.inherits('Alchemy.Controller.Chimera', 'Editor');
 
+/**
+ * Set the title
+ *
+ * @author   Jelle De Loecker   <jelle@elevenways.be>
+ * @since    1.0.1
+ * @version  1.0.1
+ *
+ * @param    {String}    title
+ */
+Editor.setMethod(function setTitle(title) {
+
+	let window_title,
+	    page_title;
+
+	if (alchemy.plugins.chimera.title) {
+		window_title = alchemy.plugins.chimera.title || '';
+
+		if (title && window_title) {
+			window_title += ' | ';
+		}
+	}
+
+	if (title) {
+		window_title += title;
+	}
+
+	page_title = title;
+
+	this.set('page_title', page_title);
+	this.set('window_title', window_title || page_title);
+});
+
 /**
  * The index action
  *
  * @author   Jelle De Loecker   <jelle@elevenways.be>
  * @since    0.1.0
- * @version  1.0.0
+ * @version  1.0.1
  *
  * @param    {Conduit}   conduit
  * @param    {String}    model_name
@@ -23,7 +55,8 @@ Editor.setAction(function index(conduit, model_name) {
 
 	let widget_config = model.chimera.getWidgetConfig('index', conduit);
 
-	this.set('page_title', model_name.titleize());
+	this.setTitle(model_name.titleize());
+
 	this.set('model_name', model_name);
 
 	this.set('widget_config', widget_config);
@@ -36,7 +69,7 @@ Editor.setAction(function index(conduit, model_name) {
  *
  * @author   Jelle De Loecker   <jelle@elevenways.be>
  * @since    0.1.0
- * @version  1.0.0
+ * @version  1.0.2
  *
  * @param    {Conduit}   conduit
  * @param    {String}    model_name
@@ -56,14 +89,16 @@ Editor.setAction(async function add(conduit, model_name) {
 		try {
 			await record.save();
 
-			let url = alchemy.routeUrl('Chimera.Editor#edit', {model: model_name, pk: record.$pk});
+			let url = alchemy.routeUrl('Chimera.Editor#edit', {
+				model: model_name,
+				pk: record.$pk,
+				message: 'added'
+			});
 
 			return conduit.redirect(url);
 		} catch (err) {
-			// @TODO: set this in the context somehow?
-			this.set('record_violations', err);
-
 			this.set('context_variables', {
+				form_violations : err,
 				record : record
 			});
 		}
@@ -78,6 +113,7 @@ Editor.setAction(async function add(conduit, model_name) {
 	widget_config.class_names.push('chimera-editor-widgets');
 
 	this.set('widget_config', widget_config);
+	this.setTitle(model.constructor.title + ' Add');
 
 	this.render('chimera/widgets');
 });
@@ -87,7 +123,7 @@ Editor.setAction(async function add(conduit, model_name) {
  *
  * @author   Jelle De Loecker   <jelle@elevenways.be>
  * @since    0.1.0
- * @version  1.0.0
+ * @version  1.0.2
  *
  * @param    {Conduit}   conduit
  * @param    {String}    model_name
@@ -100,34 +136,44 @@ Editor.setAction(async function edit(conduit, model_name, pk_val) {
 	model.translateItems = false;
 
 	let record = await model.findByPk(pk_val);
+	let message_type = conduit.param('message');
 
-	this.set('context_variables', {
-		record : record
-	});
+	let context_variables = {
+		record,
+	};
 
 	if (conduit.method == 'post') {
 
 		Object.assign(record, conduit.body[model_name]);
 
-		console.log('Set data record of', record, conduit.body);
-
 		try {
 			await record.save();
+			message_type = 'saved';
 		} catch (err) {
-			// @TODO: set this in the context somehow?
-			this.set('record_violations', err);
+			context_variables.form_violations = err;
 		}
 	}
 
+	this.set('context_variables', context_variables);
+
 	let widget_config = model.chimera.getWidgetConfig('edit', conduit);
 
 	if (!widget_config.class_names) {
 		widget_config.class_names = [];
 	}
 
+	if (message_type) {
+		if (message_type == 'added') {
+			this.set('message', 'Record has been added');
+		} else if (message_type == 'saved') {
+			this.set('message', 'Record has been saved');
+		}
+	}
+
 	widget_config.class_names.push('chimera-editor-widgets');
 
 	this.set('widget_config', widget_config);
+	this.setTitle(model.constructor.title + ' Edit');
 
 	this.render('chimera/widgets');
 });
@@ -137,7 +183,7 @@ Editor.setAction(async function edit(conduit, model_name, pk_val) {
  *
  * @author   Jelle De Loecker   <jelle@elevenways.be>
  * @since    1.0.0
- * @version  1.0.0
+ * @version  1.0.3
  *
  * @param    {Conduit}   conduit
  * @param    {String}    model_name
@@ -183,7 +229,7 @@ Editor.setAction(async function records(conduit, model_name) {
 				continue;
 			}
 
-			val = RegExp.interpretWildcard('*' + val + '*');
+			val = RegExp.interpretWildcard('*' + val + '*', 'i');
 			crit.where(key).equals(val);
 		}
 	}

package/controller/chimera_static_controller.js

@@ -26,7 +26,7 @@ ChimeraStatic.setAction(function dashboard(conduit) {
  *
  * @author   Jelle De Loecker   <jelle@elevenways.be>
  * @since    1.0.0
- * @version  1.0.0
+ * @version  1.0.1
  *
  * @param    {Conduit}   conduit
  */
@@ -35,20 +35,71 @@ ChimeraStatic.setAction(function sidebar(conduit) {
 	let widgets = [],
 	    config;
 
-	let models = Model.getAllChildren();
-	models.sortByPath(1, 'model_name');
-
-	for (let model of models) {
-		widgets.push({
-			type   : 'link',
-			config : {
-				route : 'Chimera.Editor#index',
-				parameters: [
-					{name: 'model', value: model.type_name},
-				],
-				content: model.title
+	if (Array.isArray(alchemy.plugins.chimera.sidebar_menu)) {
+
+		for (let entry of alchemy.plugins.chimera.sidebar_menu) {
+
+			if (!entry.model && !entry.href) {
+				continue;
+			}
+
+			let model,
+			    title = entry.title;
+
+			if (entry.model) {
+				model = Model.get(entry.model);
+			}
+
+			if (!title) {
+				if (model) {
+					title = model.constructor.title;
+				}
+
+				if (!title && entry.href) {
+					title = entry.href;
+				}
 			}
-		});
+
+			if (entry.href) {
+				widgets.push({
+					type   : 'link',
+					config : {
+						href   : entry.href,
+						content: title
+					}
+				});
+			} else {
+
+				widgets.push({
+					type   : 'link',
+					config : {
+						route : 'Chimera.Editor#index',
+						parameters: [
+							{name: 'model', value: model.constructor.type_name},
+						],
+						content: title
+					}
+				});
+			}
+		}
+
+	} else {
+
+		let models = Model.getAllChildren();
+		models.sortByPath(1, 'model_name');
+
+		for (let model of models) {
+			widgets.push({
+				type   : 'link',
+				config : {
+					route : 'Chimera.Editor#index',
+					parameters: [
+						{name: 'model', value: model.type_name},
+					],
+					content: model.title
+				}
+			});
+		}
 	}
 
 	config = [

package/lib/chimera_config.js

@@ -65,7 +65,7 @@ Config.setMethod(function getFieldSet(name) {
  *
  * @author   Jelle De Loecker   <jelle@elevenways.be>
  * @since    1.0.0
- * @version  1.0.0
+ * @version  1.0.2
  *
  * @param    {String}   action
  * @param    {Conduit}  conduit
@@ -89,10 +89,13 @@ Config.setMethod(function getWidgetConfig(action, conduit) {
 		let field;
 
 		for (field of fieldset) {
+
 			field_widgets.push({
 				type   : 'alchemy_field',
 				config : {
-					field : field.name,
+					field           : field.name,
+					view            : field.options.view,
+					widget_settings : field.options.widget_settings || {},
 				}
 			});
 		}
@@ -100,7 +103,7 @@ Config.setMethod(function getWidgetConfig(action, conduit) {
 		field_widgets.push({
 			type   : 'html',
 			config : {
-				html : '<button type="submit">Submit</button>'
+				html : '<button class="btn btn-submit" type="submit">Save</button>'
 			}
 		});
 
@@ -115,12 +118,43 @@ Config.setMethod(function getWidgetConfig(action, conduit) {
 								"level": 1,
 								"content": this.ModelClass.title + ' edit',
 							}
-						}, {
-							"type": "alchemy_form",
-							"config": {
-								model     : this.ModelClass.type_name,
-								view_type : 'edit',
-								widgets   : field_widgets
+						},
+						{
+							type: "row",
+							config: {
+								widgets: [
+									{
+										type: "column",
+										config: {
+											widgets: [
+												{
+													"type": "alchemy_form",
+													"config": {
+														model     : this.ModelClass.type_name,
+														view_type : 'edit',
+														widgets   : field_widgets
+													}
+												}
+											]
+										}
+									},
+									{
+										type: 'column',
+										config: {
+											wrapper_class_names: 'toc-col',
+											widgets: [
+												{
+													type: "table_of_contents",
+													config: {
+														parent_selector: 'alchemy-widgets-row',
+														elements_selector: 'alchemy-field',
+														title_selector: 'alchemy-label'
+													}
+												}
+											]
+										}
+									}
+								]
 							}
 						}
 					]
@@ -159,7 +193,5 @@ Config.setMethod(function getWidgetConfig(action, conduit) {
 
 	result.widgets = widgets;
 
-	console.log('Widget config', result, 'for', this);
-
 	return result;
 });

package/package.json

@@ -1,7 +1,7 @@
 {
 	"name": "alchemy-chimera",
 	"description": "Chimera plugin for Alchemy MVC",
-	"version": "1.0.0",
+	"version": "1.0.3",
 	"author": "Jelle De Loecker <jelle@elevenways.be>",
 	"keywords": [
 		"alchemy",
@@ -11,13 +11,12 @@
 	],
 	"repository": "11ways/alchemy-chimera",
 	"peerDependencies": {
-		"alchemy-acl"  : "~0.6.0",
-		"alchemy-menu" : "~0.6.0",
-		"alchemymvc"   : "~1.1.0",
-		"alchemy-widget": "~0.1.0"
+		"alchemy-acl"  : "~0.7.0",
+		"alchemymvc"   : "~1.2.1",
+		"alchemy-widget": "~0.1.2"
 	},
 	"license": "MIT",
 	"engines": {
-		"node" : ">=10.21.0"
+		"node" : ">=12.0.0"
 	}
 }

package/view/chimera/widgets.hwk

@@ -1,4 +1,4 @@
-{% extend "layouts/chimera_body" %}
+{% include "layouts/chimera_basics" %}
 
 {% block "main" %}
 <alchemy-widgets

package/view/layouts/chimera_base.hwk

@@ -3,6 +3,7 @@
 	<head>
 		<!-- This puts in all the required styles, scripts, ... -->
 		<% this.foundation({protoblast: true}) %>
+		<% script('chimera/chimera') %>
 	</head>
 	<body>
 		<!-- This is a block you can assign content to -->

package/view/layouts/chimera_basics.hwk

@@ -1,4 +1,15 @@
 {% extend "layouts/chimera_body" %}
 
-<% console.log('Pagetitle:', page_title) %>
-{% block "page-title" %}{{ page_title }}{% /block %}
+{% if page_title %}
+	{% block "page-title" %}{{ page_title }}{% /block %}
+{% /if %}
+
+{% if window_title %}
+	<% set_title(window_title) %>
+{% elseif page_title %}
+	<% set_title(page_title) %>
+{% /if %}
+
+{% if message %}
+	{% block "page-notification" %}<span class="notification">{{ message }}</span>{% /block %}
+{% /if %}

package/view/layouts/chimera_body.hwk

@@ -6,13 +6,14 @@
 <div class="chimera-wrapper">
 	<div class="chimera-sidebar">
 		<div class="chimera-page-header">
-			Test
+			
 		</div>
 		<%= Alchemy.segment('Chimera.Static#sidebar') %>
 	</div>
 	<div class="chimera-content">
 		<div class="chimera-page-header">
 			<div class="page-title" data-he-name="page-title"></div>
+			<div class="page-notification" data-he-name="page-notification"></div>
 			<div class="page-actions" data-he-name="page-actions"></div>
 		</div>
 		<div data-he-name="main" class="chimera-main">