Merge pull request #54 from Codeinwp/chore/notices

chore: add design pack notice

assets/css/src/design-pack-notice.scss

@@ -0,0 +1,118 @@
+@custom-media --max-tablet (max-width: 769px);
+@custom-media --max-desktop (max-width: 1200px);
+
+#riverbank-design-pack-notice {
+
+	.notice-wrap {
+		display: flex;
+		align-items: center;
+		gap: 15px;
+		border: 0;
+		border-radius: 8px;
+		padding: 20px 25px;
+		opacity: 0;
+		animation: fade-down-in 0.3s ease forwards 0.3s;
+		z-index: 10000;
+		position: fixed;
+		background: #fff;
+		box-shadow: 0 0 10px rgba(0, 0, 0, 0.1);
+		right: 10px;
+		bottom: 35px;
+
+		@media (--max-desktop) {
+			bottom: 10px;
+			right: 10px;
+			padding: 10px 15px;
+			margin-left: 10px;
+		}
+
+		&.dismissed {
+			animation: fade-up-out 0.3s ease forwards 0s;
+		}
+	}
+
+	svg {
+		flex-shrink: 0;
+	}
+
+	button {
+		border: 0;
+		background: 0;
+		cursor: pointer;
+		padding: 0;
+		border-radius: 5px;
+
+		&:hover {
+			background: #e7e7e7;
+		}
+	}
+
+	.content-wrap {
+		display: grid;
+	}
+
+	span {
+		font-weight: 600;
+		color: #6a6a6a;
+		font-size: 12px;
+
+		@media (--max-desktop) {
+			font-size: 10px;
+		}
+	}
+
+	p {
+
+		@media (--max-desktop) {
+			font-size: 12px;
+		}
+		font-size: 16px;
+		margin: 0;
+		padding: 0;
+	}
+
+	a {
+		margin-left: 35px;
+		font-weight: 700;
+		font-size: 16px;
+		text-decoration: 0;
+		color: #fff;
+		background: #383fef;
+		border-radius: 5px;
+		padding: 12px 16px;
+		text-align: center;
+
+		@media (--max-desktop) {
+			font-size: 14px;
+			padding: 7px 10px;
+			margin-left: 0;
+			flex-shrink: 0;
+		}
+	}
+}
+
+@keyframes fade-down-in {
+
+	0% {
+		opacity: 0;
+		transform: translateY(-20px);
+	}
+
+	100% {
+		opacity: 1;
+		transform: translateY(0);
+	}
+}
+
+@keyframes fade-up-out {
+
+	0% {
+		opacity: 1;
+		transform: translateY(0);
+	}
+
+	100% {
+		opacity: 0;
+		transform: translateY(-20px);
+	}
+}

assets/js/src/components/DesignPackNotice.js

@@ -0,0 +1,98 @@
+/* global designPackNoticeData */
+import { useSelect } from '@wordpress/data';
+import { Icon, closeSmall } from '@wordpress/icons';
+import { useEffect, useState } from '@wordpress/element';
+
+const logo = (
+	<svg
+		width="45"
+		height="45"
+		viewBox="0 0 45 45"
+		fill="none"
+		xmlns="http://www.w3.org/2000/svg"
+	>
+		<path
+			fillRule="evenodd"
+			clipRule="evenodd"
+			d="M14.2605 34.0991C16.1724 35.2426 18.397 35.8142 20.9347 35.8142C22.4643 35.8142 23.9067 35.5197 25.2623 34.9306C25.799 34.6974 26.3031 34.4343 26.7744 34.1413V35.2946H36.7336V5.07344C41.7793 9.19954 45 15.4737 45 22.5C45 34.9264 34.9264 45 22.5 45C10.0736 45 0 34.9264 0 22.5C0 10.0736 10.0736 0 22.5 0C23.8699 0 25.2113 0.122431 26.5137 0.356948V10.5154C26.1184 10.3146 25.7013 10.1357 25.2623 9.97864C23.9067 9.4588 22.4643 9.19889 20.9347 9.19889C18.397 9.19889 16.1724 9.77069 14.2605 10.9143C12.3834 12.0233 10.9061 13.5828 9.82848 15.5928C8.78562 17.6027 8.26423 19.9076 8.26423 22.5066C8.26423 25.1057 8.78562 27.4106 9.82848 29.4206C10.9061 31.3957 12.3834 32.9552 14.2605 34.0991ZM25.0537 26.3536C24.4282 26.7001 23.6806 26.8732 22.8118 26.8732C22.0124 26.8732 21.2822 26.6826 20.6217 26.3016C19.9613 25.9201 19.4401 25.4002 19.0575 24.7421C18.7099 24.0836 18.536 23.3382 18.536 22.5066C18.536 21.6751 18.7274 20.9297 19.1097 20.2712C19.4919 19.6131 19.9959 19.0931 20.6217 18.7117C21.2822 18.3306 22.0295 18.1401 22.864 18.1401C23.6981 18.1401 24.4282 18.3306 25.0537 18.7117C25.7142 19.0931 26.2183 19.6131 26.5658 20.2712C26.9134 20.8951 27.0874 21.6402 27.0874 22.5066C27.0874 23.3731 26.8963 24.1356 26.5137 24.7941C26.1661 25.4522 25.6796 25.9721 25.0537 26.3536Z"
+			fill="#383FEF"
+		/>
+	</svg>
+);
+
+const BLOCK_PATTERN_INSERTED_NOTICE = 'block-pattern-inserted-notice';
+export default () => {
+	const [ dismissed, setDismissed ] = useState( false );
+	const [ noticeTriggered, setNoticeTriggered ] = useState( false );
+
+	const patternInserted = useSelect(
+		( select ) =>
+			select( 'core/notices' )
+				.getNotices()
+				.filter( ( n ) => n.id === BLOCK_PATTERN_INSERTED_NOTICE )
+				.length > 0
+	);
+
+	useEffect( () => {
+		if ( noticeTriggered ) {
+			return;
+		}
+		if ( patternInserted ) {
+			setNoticeTriggered( true );
+		}
+	}, [ patternInserted ] );
+
+	const { ajaxUrl, ajaxAction, nonce, strings, buttonLink } =
+		designPackNoticeData;
+	const { dismiss, recommends, learnMore, noticeHtml } = strings;
+
+	const dismissNotice = () => {
+		const data = new window.FormData();
+
+		data.append( 'action', ajaxAction );
+		data.append( 'nonce', nonce );
+
+		fetch( ajaxUrl, {
+			method: 'POST',
+			body: data,
+		} ).then( () => {
+			setDismissed( true );
+		} );
+	};
+
+	const classes = [ 'notice-wrap' ];
+
+	if ( dismissed ) {
+		classes.push( 'dismissed' );
+	}
+
+	if ( ! noticeTriggered ) {
+		return null;
+	}
+
+	return (
+		<div className={ classes.join( ' ' ) }>
+			{ logo }
+
+			<div className="content-wrap">
+				<span>{ recommends }</span>
+
+				<p dangerouslySetInnerHTML={ { __html: noticeHtml } }></p>
+			</div>
+
+			<a
+				onClick={ dismissNotice }
+				href={ buttonLink }
+				target="_blank"
+				rel="noopener noreferrer"
+			>
+				{ learnMore }
+			</a>
+
+			<button onClick={ dismissNotice }>
+				<Icon icon={ closeSmall }></Icon>
+				<span hidden>{ dismiss }</span>
+			</button>
+		</div>
+	);
+};

assets/js/src/design-pack-notice.js

@@ -0,0 +1,9 @@
+import { createRoot } from '@wordpress/element';
+
+import DesignPackNotice from './components/DesignPackNotice';
+
+const container = document.getElementById( 'riverbank-design-pack-notice' );
+
+if ( container ) {
+	createRoot( container ).render( <DesignPackNotice /> );
+}

inc/Admin.php

@@ -34,6 +34,84 @@ public function setup_admin_hooks() {
 		add_action( 'wp_ajax_riverbank_dismiss_welcome_notice', array( $this, 'remove_welcome_notice' ) );
 		add_action( 'wp_ajax_riverbank_set_otter_ref', array( $this, 'set_otter_ref' ) );
 		add_action( 'admin_print_scripts', array( $this, 'add_nps_form' ) );
+
+		add_action( 'enqueue_block_editor_assets', array( $this, 'add_fse_design_pack_notice' ) );
+		add_action( 'wp_ajax_riverbank_dismiss_design_pack_notice', array( $this, 'remove_design_pack_notice' ) );
+	}
+	/**
+	 * Render design pack notice.
+	 *
+	 * @return void
+	 */
+	public function add_fse_design_pack_notice() {
+		if ( ! $this->should_render_design_pack_notice() ) {
+			return;
+		}
+
+		Assets_Manager::enqueue_style( Assets_Manager::ASSETS_SLUGS['design-pack-notice'], 'design-pack-notice' );
+		Assets_Manager::enqueue_script(
+			Assets_Manager::ASSETS_SLUGS['design-pack-notice'],
+			'design-pack-notice',
+			true,
+			array(),
+			array(
+				'nonce'      => wp_create_nonce( 'riverbank-dismiss-design-pack-notice' ),
+				'ajaxUrl'    => esc_url( admin_url( 'admin-ajax.php' ) ),
+				'ajaxAction' => 'riverbank_dismiss_design_pack_notice',
+				'buttonLink' => tsdk_utmify( 'https://themeisle.com/plugins/fse-design-pack', 'editor', 'riverbank' ),
+				'strings'    => array(
+					'dismiss'    => __( 'Dismiss', 'riverbank' ),
+					'recommends' => __( 'Riverbank recommends', 'riverbank' ),
+					'learnMore'  => __( 'Learn More', 'riverbank' ),
+					'noticeHtml' => sprintf(
+					/* translators: %s: FSE Design Pack: */
+						__( '%s Access a collection of 40+ layout patterns ready to import to your website', 'riverbank' ),
+						'<strong>FSE Design Pack:</strong>'
+					),
+				),
+			),
+			'designPackNoticeData'
+		);
+
+
+		echo '<div id="riverbank-design-pack-notice"></div>';
+	}
+
+
+	/**
+	 * Should we show the design pack notice?
+	 *
+	 * @return bool
+	 */
+	private function should_render_design_pack_notice() {
+		// Already using.
+		if ( is_plugin_active( 'fse-design-pack/fse-design-pack.php' ) ) {
+			return false;
+		}
+
+		// Notice was dismissed.
+		if ( get_option( Constants::CACHE_KEYS['dismissed-fse-design-pack-notice'], 'no' ) === 'yes' ) {
+			return false;
+		}
+
+		return true;
+	}
+
+
+	/**
+	 * Dismiss the design pack notice.
+	 *
+	 * @return void
+	 */
+	public function remove_design_pack_notice() {
+		if ( ! isset( $_POST['nonce'] ) ) {
+			return;
+		}
+		if ( ! wp_verify_nonce( sanitize_text_field( $_POST['nonce'] ), 'riverbank-dismiss-design-pack-notice' ) ) {
+			return;
+		}
+		update_option( Constants::CACHE_KEYS['dismissed-fse-design-pack-notice'], 'yes' );
+		wp_die();
 	}
 
 	/**

inc/Assets_Manager.php

@@ -16,9 +16,10 @@
  */
 class Assets_Manager {
 	const ASSETS_SLUGS = array(
-		'frontend-css'   => 'riverbank-style',
-		'editor-css'     => 'riverbank-editor',
-		'welcome-notice' => 'riverbank-welcome-notice',
+		'frontend-css'       => 'riverbank-style',
+		'editor-css'         => 'riverbank-editor',
+		'welcome-notice'     => 'riverbank-welcome-notice',
+		'design-pack-notice' => 'riverbank-design-pack-notice',
 	);
 
 	/**

inc/Constants.php

@@ -16,6 +16,7 @@
  */
 class Constants {
 	const CACHE_KEYS = array(
-		'dismissed-welcome-notice' => 'riverbank-welcome-notice-dismissed',
+		'dismissed-welcome-notice'         => 'riverbank-welcome-notice-dismissed',
+		'dismissed-fse-design-pack-notice' => 'riverbank-design-pack-dismissed',
 	);
 }

package.json

@@ -29,6 +29,7 @@
     "@semantic-release/exec": "^6.0.3",
     "@semantic-release/git": "^10.0.1",
     "@wordpress/eslint-plugin": "^12.8.0",
+    "@wordpress/icons": "^9.47.0",
     "@wordpress/scripts": "^23.6.0",
     "@wordpress/stylelint-config": "^20.0.2",
     "conventional-changelog-simple-preset": "^1.0.20",