alchemy-media 0.6.2 → 0.6.3

package/CHANGELOG.md

@@ -1,3 +1,9 @@
+## 0.6.3 (2022-07-23)
+
+* Fix `al-file` element showing wrong buttons on load
+* Always add `role="presentation"` to images that get a simple placeholder
+* Add support for Fontawesome Pro with the `media.fontawesome_pro` setting
+
 ## 0.6.2 (2022-07-06)
 
 * Upgrade to Fontawesome 6

package/assets/stylesheets/alchemy_icons.scss

@@ -1,66 +1,10 @@
-@import "fontawesome6/fontawesome.scss";
-@import "fontawesome6/solid.scss";
-@import "fontawesome6/brands.scss";
-
 al-ico {
-	--fa-display: inline-flex;
-	@extend %fa-icon;
+	// inline-flex breaks certain (duotone) icons
+	//--fa-display: inline-flex;
 	flex-flow: column;
-    justify-content: center;
-    align-content: center;
-    text-align: center;
-
-	&[type="arrow-left"] {
-		@extend .fas, .fa-angle-left;
-	}
-
-	&[type="arrow-left-double"] {
-		@extend .fas, .fa-angle-double-left;
-	}
-
-	&[type="arrow-right"] {
-		@extend .fas, .fa-angle-right;
-	}
-
-	&[type="arrow-right-double"] {
-		@extend .fas, .fa-angle-double-right;
-	}
-
-	&[type="sorting-arrow"] {
-		@extend .fas;
-
-		&.down {
-			@extend .fa-sort-alpha-up;
-		}
-
-		&.up {
-			@extend .fa-sort-alpha-down;
-		}
-	}
-
-	&[type="menu"] {
-		@extend .fas, .fa-bars;
-	}
-
-	&[type="edit"] {
-		@extend .fas, .fa-pencil-alt;
-	}
-
-	&[type="zoom-in"] {
-		@extend .fas, .fa-search-plus;
-	}
-
-	&[type="microphone"] {
-		@extend .fas, .fa-microphone-alt;
-	}
-
-	&[type="video"] {
-		@extend .fas, .fa-video;
-	}
-
-	&[type="plus"] {
-		@extend .fas, .fa-plus;
-	}
+	justify-content: center;
+	align-content: center;
+	text-align: center;
 
 	&[hidden] {
 		display: none !important;

package/assets/stylesheets/alchemy_icons_fafree.scss

@@ -0,0 +1,59 @@
+@use "fontawesome6/fontawesome.scss";
+@use "fontawesome6/solid.scss";
+@use "fontawesome6/brands.scss";
+
+al-ico {
+	@extend %fa-icon;
+
+	&[type="arrow-left"] {
+		@extend .fas, .fa-angle-left;
+	}
+
+	&[type="arrow-left-double"] {
+		@extend .fas, .fa-angle-double-left;
+	}
+
+	&[type="arrow-right"] {
+		@extend .fas, .fa-angle-right;
+	}
+
+	&[type="arrow-right-double"] {
+		@extend .fas, .fa-angle-double-right;
+	}
+
+	&[type="sorting-arrow"] {
+		@extend .fas;
+
+		&.down {
+			@extend .fa-sort-alpha-up;
+		}
+
+		&.up {
+			@extend .fa-sort-alpha-down;
+		}
+	}
+
+	&[type="menu"] {
+		@extend .fas, .fa-bars;
+	}
+
+	&[type="edit"] {
+		@extend .fas, .fa-pencil-alt;
+	}
+
+	&[type="zoom-in"] {
+		@extend .fas, .fa-search-plus;
+	}
+
+	&[type="microphone"] {
+		@extend .fas, .fa-microphone-alt;
+	}
+
+	&[type="video"] {
+		@extend .fas, .fa-video;
+	}
+
+	&[type="plus"] {
+		@extend .fas, .fa-plus;
+	}
+}

package/bootstrap.js

@@ -21,7 +21,10 @@ var options = {
 	scratch: path.resolve(PATH_TEMP, 'scratch'),
 
 	// The cache map for resized images & thumbnails
-	cache: path.resolve(PATH_TEMP, 'imagecache')
+	cache: path.resolve(PATH_TEMP, 'imagecache'),
+
+	// Path to fontawesome pro
+	fontawesome_pro: null,
 };
 
 // Inject the user-overridden options
@@ -66,6 +69,10 @@ options.veronica = new Veronica({
 
 alchemy.hawkejs.addRawHtml(`<script>document.cookie = 'mediaResolution=' + encodeURIComponent(JSON.stringify({width:Math.max(screen.availWidth||0, window.outerWidth||0) || 1024,height:Math.max(screen.availHeight||0, window.outerHeight||0) || 768,dpr:window.devicePixelRatio}))</script>`);
 
+if (options.fontawesome_pro) {
+	alchemy.exposeStatic('fontawesome_pro', options.fontawesome_pro);
+}
+
 /**
  * Register a profile under the given name
  *

package/element/al_ico_element.js

@@ -14,4 +14,134 @@ const Icon = Function.inherits('Alchemy.Element', 'AlIco');
  * @since    0.6.0
  * @version  0.6.0
  */
-Icon.setStylesheetFile('alchemy_icons');
+Icon.setStylesheetFile('alchemy_icons');
+
+/**
+ * The source to use
+ * (Will default to Fontawesome)
+ *
+ * @author   Jelle De Loecker <jelle@elevenways.be>
+ * @since    0.6.3
+ * @version  0.6.3
+ */
+Icon.setAttribute('source');
+
+/**
+ * The icon-style to use
+ * (Will default to regular for fontawesome)
+ *
+ * @author   Jelle De Loecker <jelle@elevenways.be>
+ * @since    0.6.3
+ * @version  0.6.3
+ */
+Icon.setAttribute('icon-style');
+
+/**
+ * The actual icon name to use
+ *
+ * @author   Jelle De Loecker <jelle@elevenways.be>
+ * @since    0.6.3
+ * @version  0.6.3
+ */
+Icon.setAttribute('icon-name');
+
+/**
+ * The element is being retained
+ *
+ * @author   Jelle De Loecker   <jelle@elevenways.be>
+ * @since    0.6.3
+ * @version  0.6.3
+ */
+Icon.setMethod(function retained() {
+	this.setCssClasses();
+});
+
+/**
+ * The element has been introduced to the DOM for the first time
+ *
+ * @author   Jelle De Loecker   <jelle@elevenways.be>
+ * @since    0.6.3
+ * @version  0.6.3
+ */
+Icon.setMethod(function introduced() {
+	this.setCssClasses();
+});
+
+/**
+ * Try to set the correct icon
+ *
+ * @author   Jelle De Loecker   <jelle@elevenways.be>
+ * @since    0.6.3
+ * @version  0.6.3
+ */
+Icon.setMethod(function setIcon(info) {
+
+	if (!info) {
+		return;
+	}
+
+	if (typeof info == 'string') {
+		info = info.split(' ');
+
+		if (info.length == 2) {
+			this.icon_style = info[0];
+			this.icon_name = info[1];
+		} else {
+			this.icon_name = info[0];
+		}
+	} else if (typeof info == 'object') {
+		let style = info.style || info.icon_style,
+		    name = info.name || info.icon_name;
+		
+		if (style) {
+			this.icon_style = style;
+		}
+
+		if (name) {
+			this.icon_name = name;
+		}
+	}
+
+	if (!this.icon_style) {
+		this.icon_style = 'duotone';
+	}
+});
+
+/**
+ * Set the CSS classes
+ *
+ * @author   Jelle De Loecker   <jelle@elevenways.be>
+ * @since    0.6.3
+ * @version  0.6.3
+ */
+Icon.setMethod(function setCssClasses() {
+
+	if (this.source && this.source != 'fontawesome') {
+		return;
+	}
+
+	let fa_pro = this.hawkejs_renderer.expose('fontawesome_pro'),
+	    style = this.icon_style || 'regular';
+
+	if (fa_pro) {
+		this.hawkejs_renderer.style(fa_pro);
+	} else {
+		this.hawkejs_renderer.style('alchemy_icons_fafree');
+
+		if (style == 'duotone' || style == 'light' || style == 'thin' || style == 'regular') {
+			style = 'solid';
+		}
+	}
+
+	let existing_classes = Array.cast(this.classList);
+
+	// Remove existing fontawesome classes
+	for (let entry of existing_classes) {
+		if (entry.startsWith('fa')) {
+			this.classList.remove(entry);
+		}
+	}
+
+	this.classList.add('fa-' + (this.icon_style || 'solid'));
+	this.classList.add('fa-' + this.icon_name);
+});

package/helper/media_helper.js

@@ -1,3 +1,5 @@
+const PLACEHOLDER = Symbol('placeholder');
+
 /**
  * The Media helper
  *
@@ -7,9 +9,7 @@
  *
  * @param    {ViewRender}    view
  */
-var Media = Function.inherits('Alchemy.Helper', function Media(view) {
-	Media.super.call(this, view);
-});
+const Media = Function.inherits('Alchemy.Helper', 'Media');
 
 /**
  * Function to execute on the client side, when the scene is made
@@ -159,6 +159,11 @@ Media.setMethod(function applyDirective(element, image, options) {
 		return;
 	}
 
+	if (options[PLACEHOLDER]) {
+		element.setAttribute('alt', '');
+		element.setAttribute('role', 'presentation');
+	}
+
 	if (!String(image).isHex()) {
 		return;
 	}
@@ -275,9 +280,9 @@ Media.setMethod(function imageUrl(image_id, options) {
 /**
  * Create a base placeholder image url
  *
- * @author   Jelle De Loecker   <jelle@develry.be>
+ * @author   Jelle De Loecker   <jelle@elevenways.be>
  * @since    0.2.0
- * @version  0.2.0
+ * @version  0.6.2
  *
  * @param    {Object}   options
  *
@@ -306,6 +311,8 @@ Media.setMethod(function placeholderUrl(options) {
 		if (options.text) {
 			url.addQuery('text', options.text);
 		}
+
+		options[PLACEHOLDER] = true;
 	}
 
 	return url;

package/package.json

@@ -1,7 +1,7 @@
 {
 	"name": "alchemy-media",
 	"description": "The media plugin for Alchemy",
-	"version": "0.6.2",
+	"version": "0.6.3",
 	"repository": {
 		"type" : "git",
 		"url"  : "https://github.com/skerit/alchemy-media.git"

package/view/element/al_file.hwk

@@ -1,7 +1,7 @@
 <label class="al-file-drop-target">
 	<div class="al-file-preview"></div>
 	<al-ico class="uploading-icon fa-solid fa-spinner fa-spin-pulse"></al-ico>
-	<al-ico class="empty-icon fa-solid fa-file-arrow-up" hidden></al-ico>
+	<al-ico class="empty-icon fa-solid fa-file-arrow-up"><% if (self.value) $0.hidden = true %></al-ico>
 	<input type="file" tabindex="-1" class="al-file-input" hidden>
 </label>
 
@@ -12,6 +12,7 @@
 	</button>
 
 	<button class="al-file-remove">
+		<% if (!self.value) $0.hidden = true %>
 		<al-ico class="fa-solid fa-trash-can"></al-ico>
 		{%t "remove-current-file" %}
 	</button>