CHANGELOG.md

@@ -1,22 +1,5 @@
 # Notice Manager Changelog
 
-## 0.27
-
-Release date: Sep 7 2024
-
-### Dependencies
-- Composer config: `prepend-autoloader: false` - Give precedence to other composer installations if present.
-
-## 0.26
-
-Release date: Sep 1 2024
-
-### Changed
-- Use Mutation Observer instead of deprecated `DOMNodeRemoved` event.
-
-### Added
-- Add method `NoticeManager.bootstrap()` to initialize Notice manager.
-
 ## 0.25
 
 Release date: Feb 18 2024

composer.json

@@ -2,7 +2,7 @@
 	"name": "abuyoyo/notice-manager",
 	"description": "Manage notices on WordPress admin pages. Adds 'Notices' screen-meta-link.",
 	"type": "wordpress-plugin",
-	"version": "0.27",
+	"version": "0.25",
 	"repositories": [
 		{
 			"type": "vcs",
@@ -13,8 +13,5 @@
 		"abuyoyo/screen-meta-links": "~0.13",
 		"abuyoyo/plugincore": "~0.27",
 		"abuyoyo/adminmenupage": "~0.29"
-	},
-	"config": {
-		"prepend-autoloader": false
 	}
 }

js/notice_manager_panel.js

@@ -2,26 +2,27 @@
  * NoticeManager class/module
  * 
  */
-const NoticeManager = function ($) {
+var NoticeManager = (function ($, document) {
+	let options = window.notice_manager_options
 
-	const selectors_notice = [
+	let selectors_notice = [
 		"div.notice",
 		"div.updated",
 	]
 
-	const selectors_warning = [
+	let selectors_warning = [
 		"div.notice-warning",
 		"div.update-nag",
 	]
 
-	const selectors_error = [
+	let selectors_error = [
 		"div.error",
 		"div.notice-error",
 	]
 
-	const selectors_all = selectors_notice.concat(selectors_warning, selectors_error)
+	let selectors_all = selectors_notice.concat(selectors_warning, selectors_error)
 
-	const selectors_skip = [
+	let selectors_skip = [
 		".inline",
 		".below-h2",
 		".theme-info .notice",
@@ -29,133 +30,136 @@ const NoticeManager = function ($) {
 	]
 
 	// wait function used with autoCollapse
-	const wait = function (ms) {
+	let wait = function (ms) {
 		var dfd = $.Deferred()
 		setTimeout(dfd.resolve, ms) //callback, timeout till callback
 		return dfd.promise()
 	}
 
-	const options = window.notice_manager_options
-
 	let notices
 
 	let button
 	let panel
+	let haveClosed // set to true on first close/collect
 	let dismissNoticesButton
 
-	let haveClosed // set to true on first close/collect
+	// bootstrap
-	let panelObserver
+	// some of these need to run BEFORE document.ready - don't know why really
+	button = $("#meta-link-notices")
+	panel = $("#meta-link-notices-wrap")
+	haveClosed = false
+	dismissNoticesButton = $("#meta-link-notices-wrap button.notice-dismiss")
+
+	dismissNoticesButton.on("click", () => {
+		screenMeta.close(panel, button)
+		if (! haveClosed){
+			NoticeManager.collectNotices()
+		}
+		NoticeManager.addCounter()
+	})
+
+	//original wp focus on click function
+	button.on("focus.scroll-into-view", (e) => {
+		if (e.target.scrollIntoView) e.target.scrollIntoView(false)
+	})
+
+	// scroll page to top when closing notice panel
+	// function used to work with $(this)
+	// using e.target instead
+	// not sure if this should perhaps be e.currentTarget
+	button.on("click", (e) => {
+		if ($(e.target).hasClass("screen-meta-active")) {
+			if (haveClosed) {
+				NoticeManager.addCounter()
+			}
+
+			// $(window).scrollTop(true)
+		} else {
+			NoticeManager.removeCounter()
+
+			// wait (500).then(function(){ //still jumpy sometimes - but scrolls to correct position 400 ~ 600
+			// 	$(window).scrollTop(true)
+			// })
+		}
+	})
+
+	/**
+	 * document.on.ready
+	 */
+	$(() => {
+
+		console.log("NoticeManager.on.ready")
+		console.log("options")
+		console.log(options)
+
+		// bootstrap notices
+		// get all notices that are not explicitly marked as `.inline` or `.below-h2`
+		// we add .update-nag.inline for WordPress Update notice
+		notices = $( selectors_all.join(', ') )
+			.not(selectors_skip.join(', '))
+			.add("div.update-nag")
+
+		/**
+		 * Remove panel if there are no notices on this page
+		 */
+		if (options.screen_panel) {
+			NoticeManager.maybeRemoveNoticesPanel()
+		}
+
+		if (options.screen_panel && options.auto_collect) {
+			NoticeManager.collectNotices()
+		} else {
+			if (options.above_title) {
+				NoticeManager.moveAboveTitle()
+			}
+		}
+
+		/**
+		 * auto-open notices panel
+		 */
+		if (button.length && ! options.distraction_free) {
+			panel.toggle()
+			button.addClass("screen-meta-active")
+			screenMeta.open(panel, button)
+		}
+
+		/**
+		 * auto-close notices panel after short delay
+		 * only auto-close if we have collected notices previously
+		 * only auto-close if no error messages
+		 */
+		if (options.auto_collapse && ! options.distraction_free) {
+			wait(4000).then(() => {
+				if (haveClosed && NoticeManager.getNoticesTopPriority() != 'error') {
+					screenMeta.close(panel, button)
+					NoticeManager.addCounter()
+				}
+			})
+		}
+
+		if (options.distraction_free) {
+			NoticeManager.addCounterWhenClosed()
+		}
+
+	}) // end document.on.ready
+
+	// prevent jumpy scrollRestoration on reload page
+	// fixed below on 'beforeunload'
+	// if (history.scrollRestoration) {
+	//	history.scrollRestoration = 'manual'
+	//}
+	/**
+	 * Set history.scrollTop to prevent jump on page refresh when scrollRestoration = auto
+	 */
+	$(window).on("beforeunload", () => {
+		history.pushState(
+			{ scrollTop: document.body.scrollTop },
+			document.title,
+			document.location.pathname
+		)
+	})
 
 	return {
-		bootstrap: () => {
-
-			// Init selectors
-			button = $("#meta-link-notices")
-			panel = $("#meta-link-notices-wrap")
-			dismissNoticesButton = $("#meta-link-notices-wrap button.notice-dismiss")
-
-			// bootstrap notices
-			// get all notices that are not explicitly marked as `.inline` or `.below-h2`
-			// we add .update-nag.inline for WordPress Update notice
-			notices = $(selectors_all.join(', '))
-				.not(selectors_skip.join(', '))
-				.add("div.update-nag")
-
-			// Set state
-			haveClosed = false
-
-			dismissNoticesButton.on("click", () => {
-				screenMeta.close(panel, button)
-				if (!haveClosed) {
-					NoticeManager.collectNotices()
-				}
-				NoticeManager.addCounter()
-			})
-
-			//original wp focus on click function
-			button.on("focus.scroll-into-view", (e) => {
-				if (e.target.scrollIntoView) e.target.scrollIntoView(false)
-			})
-
-			// scroll page to top when closing notice panel
-			// function used to work with $(this)
-			// using e.target instead
-			// not sure if this should perhaps be e.currentTarget
-			button.on("click", (e) => {
-				if ($(e.target).hasClass("screen-meta-active")) {
-					if (haveClosed) {
-						NoticeManager.addCounter()
-					}
-
-					// $(window).scrollTop(true)
-				} else {
-					NoticeManager.removeCounter()
-
-					// wait (500).then(function(){ //still jumpy sometimes - but scrolls to correct position 400 ~ 600
-					// 	$(window).scrollTop(true)
-					// })
-				}
-			})
-
-			// prevent jumpy scrollRestoration on reload page
-			// fixed below on 'beforeunload'
-			// if (history.scrollRestoration) {
-			//	history.scrollRestoration = 'manual'
-			//}
-			/**
-			 * Set history.scrollTop to prevent jump on page refresh when scrollRestoration = auto
-			 */
-			$(window).on('beforeunload', () => history.pushState(
-					{ scrollTop: document.body.scrollTop },
-					document.title,
-					document.location.pathname
-				)
-			)
-
-			/**
-			 * Remove panel if there are no notices on this page
-			 */
-			if (options.screen_panel) {
-				NoticeManager.maybeRemoveNoticesPanel()
-			}
-
-			if (options.screen_panel && options.auto_collect) {
-				NoticeManager.collectNotices()
-			} else {
-				if (options.above_title) {
-					NoticeManager.moveAboveTitle()
-				}
-			}
-
-			/**
-			 * auto-open notices panel
-			 */
-			if (button.length && !options.distraction_free) {
-				panel.toggle()
-				button.addClass("screen-meta-active")
-				screenMeta.open(panel, button)
-			}
-
-			/**
-			 * auto-close notices panel after short delay
-			 * only auto-close if we have collected notices previously
-			 * only auto-close if no error messages
-			 */
-			if (options.auto_collapse && !options.distraction_free) {
-				wait(4000).then(() => {
-					if (haveClosed && NoticeManager.getNoticesTopPriority() != 'error') {
-						screenMeta.close(panel, button)
-						NoticeManager.addCounter()
-					}
-				})
-			}
-
-			if (options.distraction_free) {
-				NoticeManager.addCounterWhenClosed()
-			}
-
-		},
-
 		getNotices: () => notices,
 
 		getNoticesTopPriority: () => {
@@ -193,18 +197,20 @@ const NoticeManager = function ($) {
 			 * When dismissible notices are dismissed, check if any notices are left on page.
 			 * If no notices are left - remove Notice Panel entirely
 			 */
-			panelObserver = new MutationObserver(() => {
+			$(document).on(
-				notices = panel
+				"DOMNodeRemoved",
-					.find(selectors_all.join(", "))
+				"#meta-link-notices-wrap div.notice",
-					.filter(":visible")
+				() => {
-				NoticeManager.maybeRemoveNoticesPanel()
+					notices = panel
-			});
+						.find(selectors_all.join(", "))
-			panelObserver.observe(panel.get(0), { childList: true, subtree: true }); // only run once
+						.filter(":visible")
-
+					NoticeManager.maybeRemoveNoticesPanel()
+				}
+			)
 		},
 
 		addCounter: () => {
-			if (!button.children('.plugin-count').length) {
+			if (!button.children('.plugin-count').length){
 				button.append(
 					$("<span/>").text(notices.filter(":visible").length).attr({
 						class: "plugin-count",
@@ -217,7 +223,7 @@ const NoticeManager = function ($) {
 		 * cannot rely on filter(:visible)
 		 */
 		addCounterWhenClosed: () => {
-			if (!button.children('.plugin-count').length) {
+			if (!button.children('.plugin-count').length){
 				button.append(
 					$("<span/>").text(notices.length).attr({
 						class: "plugin-count",
@@ -241,7 +247,7 @@ const NoticeManager = function ($) {
 				$("#meta-link-notices-link-wrap").detach()
 				$("#meta-link-notices-wrap").detach()
 
-				if ($("#screen-meta-links").children().length == 0) {
+				if ($("#screen-meta-links").children().length == 0){
 					$("#screen-meta-links").detach()
 				}
 			}
@@ -256,6 +262,4 @@ const NoticeManager = function ($) {
 			notices.insertBefore(".wrap:first")
 		},
 	}
-}(jQuery);
+}(jQuery,document) )
-
-jQuery(NoticeManager.bootstrap);

notice-manager.php

@@ -2,7 +2,7 @@
 /**
  * Plugin Name: Notice Manager
  * Description: Manage notices on WordPress admin pages. Adds 'Notices' screen-meta-link panel to collect notices from page.
- * Version: 0.27
+ * Version: 0.25
  * Author: abuyoyo
  * Author URI: https://github.com/abuyoyo/
  * Plugin URI: https://github.com/abuyoyo/notice-manager