/** * External dependencies */ import { __, sprintf } from '@wordpress/i18n'; import { Fragment, Suspense, lazy, useState } from '@wordpress/element'; import { compose } from '@wordpress/compose'; import { partial } from 'lodash'; import { Dropdown, Button, Icon } from '@wordpress/components'; import { applyFilters } from '@wordpress/hooks'; import { Icon as WPIcon, plusCircleFilled } from '@wordpress/icons'; /** * WooCommerce dependencies */ import { H, Spinner } from '@woocommerce/components'; import { SETTINGS_STORE_NAME, OPTIONS_STORE_NAME, useUserPreferences, } from '@woocommerce/data'; /** * Internal dependencies */ import './style.scss'; import defaultSections from './default-sections'; import Section from './section'; import withSelect from 'wc-api/with-select'; import { recordEvent } from 'lib/tracks'; import { isOnboardingEnabled } from 'dashboard/utils'; import { getCurrentDates, getDateParamsFromQuery, isoDateFormat, } from 'lib/date'; import ReportFilters from 'analytics/components/report-filters'; const TaskList = lazy( () => import( /* webpackChunkName: "task-list" */ '../task-list' ) ); const DASHBOARD_FILTERS_FILTER = 'woocommerce_admin_dashboard_filters'; const filters = applyFilters( DASHBOARD_FILTERS_FILTER, [] ); const mergeSectionsWithDefaults = ( prefSections ) => { if ( ! prefSections || prefSections.length === 0 ) { return defaultSections; } const defaultKeys = defaultSections.map( ( section ) => section.key ); const prefKeys = prefSections.map( ( section ) => section.key ); const keys = new Set( [ ...prefKeys, ...defaultKeys ] ); const sections = []; keys.forEach( ( key ) => { const defaultSection = defaultSections.find( ( section ) => section.key === key ); if ( ! defaultSection ) { return; } const prefSection = prefSections.find( ( section ) => section.key === key ); sections.push( { ...defaultSection, ...prefSection, } ); } ); return sections; } const CustomizableDashboard = ( { defaultDateRange, path, query, taskListComplete, taskListHidden, } ) => { const { isRequesting, updateUserPreferences, ...userPrefs } = useUserPreferences(); const [ dashSections, setSections ] = useState( isRequesting ? false : mergeSectionsWithDefaults( userPrefs.dashboard_sections ) ); // Update sections when the request is finished (and they weren't hydrated). if ( ! isRequesting && dashSections === false ) { setSections( mergeSectionsWithDefaults( userPrefs.dashboard_sections ) ); } const sections = dashSections || defaultSections; const isTaskListEnabled = isOnboardingEnabled() && ! taskListHidden; const isDashboardShown = ! isTaskListEnabled || ( ! query.task && taskListComplete ); const updateSections = ( newSections ) => { setSections( newSections ); updateUserPreferences( { dashboard_sections: newSections } ); } const updateSection = ( updatedKey, newSettings ) => { const newSections = sections.map( ( section ) => { if ( section.key === updatedKey ) { return { ...section, ...newSettings, }; } return section; } ); updateSections( newSections ); } const onChangeHiddenBlocks = ( updatedKey ) => { return ( updatedHiddenBlocks ) => { updateSection( updatedKey, { hiddenBlocks: updatedHiddenBlocks, } ); }; } const onSectionTitleUpdate = ( updatedKey ) => { return ( updatedTitle ) => { recordEvent( 'dash_section_rename', { key: updatedKey } ); updateSection( updatedKey, { title: updatedTitle } ); }; } const toggleVisibility = ( key, onToggle ) => { return () => { if ( onToggle ) { // Close the dropdown before setting state so an action is not performed on an unmounted component. onToggle(); } // When toggling visibility, place section at the end of the array. const index = sections.findIndex( ( s ) => key === s.key ); const toggledSection = sections.splice( index, 1 ).shift(); toggledSection.isVisible = ! toggledSection.isVisible; sections.push( toggledSection ); if ( toggledSection.isVisible ) { recordEvent( 'dash_section_add', { key: toggledSection.key } ); } else { recordEvent( 'dash_section_remove', { key: toggledSection.key, } ); } updateSections( sections ); }; } const onMove = ( index, change ) => { const movedSection = sections.splice( index, 1 ).shift(); const newIndex = index + change; // Figure out the index of the skipped section. const nextJumpedSectionIndex = change < 0 ? newIndex : newIndex - 1; if ( sections[ nextJumpedSectionIndex ].isVisible || // Is the skipped section visible? index === 0 || // Will this be the first element? index === sections.length - 1 // Will this be the last element? ) { // Yes, lets insert. sections.splice( newIndex, 0, movedSection ); updateSections( sections ); const eventProps = { key: movedSection.key, direction: change > 0 ? 'down' : 'up', }; recordEvent( 'dash_section_order_change', eventProps ); } else { // No, lets try the next one. onMove( index, change + change ); } } const renderAddMore = () => { const hiddenSections = sections.filter( ( section ) => section.isVisible === false ); if ( hiddenSections.length === 0 ) { return null; } return ( ( ) } renderContent={ ( { onToggle } ) => ( { __( 'Dashboard Sections', 'woocommerce-admin' ) }
{ hiddenSections.map( ( section ) => { return ( ); } ) }
) } /> ); } const renderDashboardReports = () => { const { period, compare, before, after } = getDateParamsFromQuery( query, defaultDateRange ); const { primary: primaryDate, secondary: secondaryDate, } = getCurrentDates( query, defaultDateRange ); const dateQuery = { period, compare, before, after, primaryDate, secondaryDate, }; const visibleSectionKeys = sections .filter( ( section ) => section.isVisible ) .map( ( section ) => section.key ); return ( { sections.map( ( section, index ) => { if ( section.isVisible ) { return (
); } return null; } ) } { renderAddMore() } ); } return ( { isTaskListEnabled && ( }> ) } { isDashboardShown && renderDashboardReports() } ); } export default compose( withSelect( ( select ) => { const { getOption } = select( OPTIONS_STORE_NAME ); const { woocommerce_default_date_range: defaultDateRange } = select( SETTINGS_STORE_NAME ).getSetting( 'wc_admin', 'wcAdminSettings' ); const withSelectData = { defaultDateRange, }; if ( isOnboardingEnabled() ) { withSelectData.homepageEnabled = window.wcAdminFeatures.homescreen && getOption( 'woocommerce_homescreen_enabled' ) === 'yes'; withSelectData.taskListHidden = getOption( 'woocommerce_task_list_hidden' ) === 'yes'; withSelectData.taskListComplete = getOption( 'woocommerce_task_list_complete' ) === 'yes'; } return withSelectData; } ) )( CustomizableDashboard );