woocommerce/plugins/woocommerce-admin/client/navigation/components/intro-modal/index.js

/**
 * External dependencies
 */
import { __ } from '@wordpress/i18n';
import { Guide } from '@wordpress/components';
import { OPTIONS_STORE_NAME } from '@woocommerce/data';
import { recordEvent } from '@woocommerce/tracks';
import { Text } from '@woocommerce/experimental';
import { useEffect, useState } from '@wordpress/element';
import { useSelect, useDispatch } from '@wordpress/data';

/**
 * Internal dependencies
 */
import './style.scss';
import NavInto1 from './images/nav-intro-1.png';
import NavInto2 from './images/nav-intro-2.png';
import NavInto3 from './images/nav-intro-3.png';
import { WELCOME_MODAL_DISMISSED_OPTION_NAME } from '../../../homescreen/constants';

export const INTRO_MODAL_DISMISSED_OPTION_NAME =
	'woocommerce_navigation_intro_modal_dismissed';

export const IntroModal = () => {
	const [ isOpen, setOpen ] = useState( true );

	const { updateOptions } = useDispatch( OPTIONS_STORE_NAME );

	const { isDismissed, isResolving, isWelcomeModalShown } = useSelect(
		( select ) => {
			const { getOption, isResolving: isOptionResolving } = select(
				OPTIONS_STORE_NAME
			);
			const dismissedOption = getOption(
				INTRO_MODAL_DISMISSED_OPTION_NAME
			);

			return {
				isDismissed: dismissedOption === 'yes',
				isWelcomeModalShown:
					getOption( WELCOME_MODAL_DISMISSED_OPTION_NAME ) !== 'yes',
				isResolving:
					typeof dismissedOption === 'undefined' ||
					isOptionResolving( 'getOption', [
						INTRO_MODAL_DISMISSED_OPTION_NAME,
					] ) ||
					isOptionResolving( 'getOption', [
						WELCOME_MODAL_DISMISSED_OPTION_NAME,
					] ),
			};
		}
	);

	const dismissModal = () => {
		updateOptions( {
			[ INTRO_MODAL_DISMISSED_OPTION_NAME ]: 'yes',
		} );
		recordEvent( 'navigation_intro_modal_close', {} );
		setOpen( false );
	};

	// Dismiss the modal when the welcome modal is shown.
	// It is likely in this case that the navigation is on by default.
	useEffect( () => {
		if ( ! isResolving && isWelcomeModalShown && ! isDismissed ) {
			dismissModal();
		}
	}, [ isDismissed, isResolving, isWelcomeModalShown ] );

	if ( ! isOpen || isDismissed || isResolving || isWelcomeModalShown ) {
		return null;
	}

	const getPage = ( title, description, imageUrl ) => {
		return {
			content: (
				<div className="woocommerce-navigation-intro-modal__page-wrapper">
					<div className="woocommerce-navigation-intro-modal__page-text">
						<Text variant="title.large" as="h2">
							{ title }
						</Text>
						<Text variant="body.large">{ description }</Text>
					</div>
					<div className="woocommerce-navigation-intro-modal__image-wrapper">
						<img alt={ title } src={ imageUrl } />
					</div>
				</div>
			),
		};
	};

	return (
		<Guide
			className="woocommerce-navigation-intro-modal"
			onFinish={ dismissModal }
			pages={ [
				getPage(
					__(
						'A new navigation for WooCommerce',
						'woocommerce-admin'
					),
					__(
						'All of your store management features in one place',
						'woocommerce-admin'
					),
					NavInto1
				),
				getPage(
					__( 'Focus on managing your store', 'woocommerce-admin' ),
					__(
						'Give your attention to key areas of WooCommerce with little distraction',
						'woocommerce-admin'
					),
					NavInto2
				),
				getPage(
					__(
						'Easily find and favorite your extensions',
						'woocommerce-admin'
					),
					__(
						"They'll appear in the top level of the navigation for quick access",
						'woocommerce-admin'
					),
					NavInto3
				),
			] }
		/>
	);
};