import { recordTracksEvent } from '@automattic/calypso-analytics'; import styled from '@emotion/styled'; import { __experimentalHStack as HStack, Modal, TextHighlight } from '@wordpress/components'; import { useDebounce } from '@wordpress/compose'; import { chevronLeft as backIcon, Icon, search as inputIcon } from '@wordpress/icons'; import { useI18n } from '@wordpress/react-i18n'; import { cleanForSlug } from '@wordpress/url'; import clsx from 'clsx'; import { Command, useCommandState } from 'cmdk'; import { useCallback, useEffect, useMemo, useRef, useState } from 'react'; import { CommandPaletteContext, CommandPaletteContextProvider, useCommandPaletteContext, } from './context'; import { recordCommandPaletteOpen } from './tracks'; import { COMMAND_SEPARATOR, useCommandFilter } from './use-command-filter'; import { useCommandPalette } from './use-command-palette'; import { siteUsesWpAdminInterface } from './utils'; import type { Command as PaletteCommand } from './commands'; import type { SiteExcerptData } from '@automattic/sites'; import './style.scss'; const StyledCommandsMenuContainer = styled.div( { '[cmdk-root] > [cmdk-list]': { overflowX: 'hidden', }, '[cmdk-root] > [cmdk-list] [cmdk-empty]': { paddingLeft: '24px', paddingRight: '24px', }, } ); const StyledCommandsEmpty = styled( Command.Empty )( { fontSize: '13px', textAlign: 'center', } ); const BackButton = styled.button( { cursor: 'pointer', } ); const LabelWrapper = styled.div( { display: 'flex', flexDirection: 'column', flex: 1, maxWidth: 'calc(100% - 56px)', justifyContent: 'center', } ); const Label = styled.div( { textOverflow: 'ellipsis', whiteSpace: 'nowrap', overflow: 'hidden', fontSize: '1em', '.commands-command-menu__container [cmdk-item] &': { color: 'var(--studio-gray-100)', }, '.commands-command-menu__container [cmdk-item][aria-selected=true] &': { color: 'var(--studio-white)', }, '.commands-command-menu__container & mark': { fontWeight: 700, }, } ); const SubLabel = styled( Label )( { opacity: 0.7, fontSize: '0.9em', '.commands-command-menu__container [cmdk-item] &': { color: 'var(--studio-gray-60)', }, } ); const StyledCommandsFooter = styled.div( { fontSize: '0.75rem', paddingTop: '12px', paddingLeft: '16px', paddingRight: '16px', paddingBottom: '12px', borderTop: '1px solid var(--studio-gray-5)', color: 'var(--studio-gray-50)', a: { color: 'var(--studio-gray-50)', textDecoration: 'none', }, 'a.command-palette__footer-current-site, a:hover': { color: 'var(--studio-gray-100)', }, 'a:hover': { textDecoration: 'underline' }, } ); export function CommandMenuGroup() { const { search, close, setSearch, setPlaceholderOverride, setFooterMessage, setEmptyListNotice, navigate, currentRoute, currentSiteId, useSites, } = useCommandPaletteContext(); const { commands, filterNotice, emptyListNotice, inSiteContext } = useCommandPalette(); const { __ } = useI18n(); const sites = useSites(); const currentSite = sites.find( ( site: { ID: unknown } ) => site.ID === currentSiteId ); const adminUrl = currentSite && siteUsesWpAdminInterface( currentSite ) ? 'https://' + currentSite.slug + '/wp-admin' : 'https://wordpress.com/home/' + currentSite?.slug; // Should just use the name but need Jetpack change for this to work in wp-admin const siteName = currentSite?.name ?? currentSite?.slug; useEffect( () => { if ( ! filterNotice && inSiteContext ) { const sitesPath = currentRoute.startsWith( '/wp-admin' ) ? 'https://wordpress.com/sites' : '/sites/'; const message = ( <> { __( 'All sites', __i18n_text_domain__ ) } { ' / ' } { adminUrl && ( { siteName } ) } > ); setFooterMessage( message ); return; } setFooterMessage( filterNotice ?? '' ); }, [ setFooterMessage, filterNotice, inSiteContext, currentRoute, adminUrl, siteName, __ ] ); useEffect( () => { setEmptyListNotice( emptyListNotice ?? '' ); }, [ setEmptyListNotice, emptyListNotice ] ); if ( ! commands.length ) { return null; } return ( { commands.map( ( command ) => { const itemValue = [ command.label, command.searchLabel ] .filter( Boolean ) .join( COMMAND_SEPARATOR ); return ( command.callback( { close: () => close( command.name, true ), setSearch, setPlaceholderOverride, command, navigate, currentRoute, } ) } id={ cleanForSlug( itemValue ) } > { command.icon && } { command.image } { command.subLabel && ( ) } ); } ) } ); } function CommandInput() { const { placeHolderOverride, search, selectedCommandName, setSearch, isOpen } = useCommandPaletteContext(); const commandMenuInput = useRef< HTMLInputElement >( null ); const itemValue = useCommandState( ( state ) => state.value ); const itemId = useMemo( () => cleanForSlug( itemValue ), [ itemValue ] ); const { __ } = useI18n(); useEffect( () => { // Focus the command palette input when mounting the modal, // or when a command is selected. if ( isOpen || selectedCommandName ) { commandMenuInput.current?.focus(); } }, [ isOpen, selectedCommandName ] ); return ( ); } const NotFoundMessage = () => { const { currentRoute, emptyListNotice, search, selectedCommandName } = useCommandPaletteContext(); const trackNotFoundDebounced = useDebounce( () => { recordTracksEvent( 'calypso_hosting_command_palette_not_found', { current_route: currentRoute, search_text: search, } ); }, 600 ); const { __ } = useI18n(); useEffect( () => { // Track search queries only for root if ( ! selectedCommandName && search ) { trackNotFoundDebounced(); } return trackNotFoundDebounced.cancel; }, [ search, selectedCommandName, trackNotFoundDebounced ] ); return <>{ emptyListNotice || __( 'No results found.', __i18n_text_domain__ ) }>; }; export interface CommandPaletteProps { currentRoute: string; currentSiteId: number | null; isOpenGlobal?: boolean; navigate: ( path: string, openInNewTab?: boolean ) => void; onClose?: () => void; useCommands: () => PaletteCommand[]; useSites: () => SiteExcerptData[]; userCapabilities: { [ key: number ]: { [ key: string ]: boolean } }; selectedCommand?: PaletteCommand; onBack?: () => void; shouldCloseOnClickOutside?: boolean; } const COMMAND_PALETTE_MODAL_OPEN_CLASSNAME = 'command-palette-modal-open'; // We need to change the `overflow` of the html element because it's set to `scroll` on _reset.scss // Ideally, this would be handled by the `@wordpress/components` `Modal` component, // but it doesn't have a `htmlOpenClassName` prop to go alongside `bodyOpenClassName`. // So we need to toggle both classes manually here. const toggleModalOpenClassnameOnDocumentHtmlElement = ( isModalOpen: boolean ) => { document.documentElement.classList.toggle( COMMAND_PALETTE_MODAL_OPEN_CLASSNAME, isModalOpen ); document.body.classList.toggle( COMMAND_PALETTE_MODAL_OPEN_CLASSNAME, isModalOpen ); }; const CommandPalette = ( { currentRoute, currentSiteId, isOpenGlobal, navigate, onClose = () => {}, useCommands, useSites, userCapabilities, selectedCommand, onBack, shouldCloseOnClickOutside, }: CommandPaletteProps ) => { const [ placeHolderOverride, setPlaceholderOverride ] = useState( '' ); const [ search, setSearch ] = useState( '' ); const [ selectedCommandName, setSelectedCommandName ] = useState( '' ); const [ isOpenLocal, setIsOpenLocal ] = useState( false ); const isOpen = isOpenLocal || isOpenGlobal; const [ footerMessage, setFooterMessage ] = useState< string | JSX.Element >( '' ); const [ emptyListNotice, setEmptyListNotice ] = useState( '' ); const open = useCallback( () => { toggleModalOpenClassnameOnDocumentHtmlElement( true ); setIsOpenLocal( true ); recordCommandPaletteOpen( currentRoute, 'keyboard' ); }, [ currentRoute ] ); const close = useCallback< CommandPaletteContext[ 'close' ] >( ( commandName = '', isExecuted = false ) => { toggleModalOpenClassnameOnDocumentHtmlElement( false ); setIsOpenLocal( false ); onClose?.(); recordTracksEvent( 'calypso_hosting_command_palette_close', { // For nested commands the command.name would be the siteId // For root commands the selectedCommandName would be empty command: selectedCommandName || commandName, current_route: currentRoute, search_text: search, is_executed: isExecuted, } ); }, [ currentRoute, onClose, search, selectedCommandName ] ); const toggle = useCallback( () => ( isOpen ? close() : open() ), [ isOpen, close, open ] ); const commandFilter = useCommandFilter(); const { __ } = useI18n(); const commandListRef = useRef< HTMLDivElement >( null ); useEffect( () => { if ( commandListRef.current !== null ) { commandListRef.current.scrollTop = 0; } }, [ selectedCommandName ] ); // Cmd+K shortcut useEffect( () => { const down = ( e: KeyboardEvent ) => { if ( e.key === 'k' && ( e.metaKey || e.ctrlKey ) ) { e.preventDefault(); toggle(); } }; document.addEventListener( 'keydown', down ); return () => document.removeEventListener( 'keydown', down ); }, [ toggle ] ); useEffect( () => { if ( ! selectedCommand ) { return; } setSearch( '' ); setSelectedCommandName( selectedCommand.name ); if ( selectedCommand.siteSelector ) { setPlaceholderOverride( selectedCommand.siteSelectorLabel || '' ); } }, [ selectedCommand ] ); const reset = () => { setPlaceholderOverride( '' ); setSearch( '' ); setSelectedCommandName( '' ); }; const closeAndReset = () => { reset(); close(); }; const goBackToRootCommands = ( fromKeyboard: boolean ) => { recordTracksEvent( 'calypso_hosting_command_palette_back_to_root', { command: selectedCommandName, current_route: currentRoute, search_text: search, from_keyboard: fromKeyboard, } ); if ( onBack ) { onBack(); } else { reset(); } }; if ( ! isOpen ) { return false; } const onKeyDown = ( event: React.KeyboardEvent< HTMLInputElement > ) => { if ( // Ignore keydowns from IMEs event.nativeEvent.isComposing || // Workaround for Mac Safari where the final Enter/Backspace of an IME composition // is `isComposing=false`, even though it's technically still part of the composition. // These can only be detected by keyCode. event.keyCode === 229 ) { event.preventDefault(); } if ( selectedCommandName && ( event.key === 'Escape' || ( event.key === 'Backspace' && ! search ) ) ) { event.preventDefault(); goBackToRootCommands( true ); } }; return ( { close( commandName, isExecuted ); reset(); } } emptyListNotice={ emptyListNotice } placeHolderOverride={ placeHolderOverride } selectedCommandName={ selectedCommandName } setEmptyListNotice={ setEmptyListNotice } setFooterMessage={ setFooterMessage } setPlaceholderOverride={ setPlaceholderOverride } setSearch={ setSearch } setSelectedCommandName={ setSelectedCommandName } > { selectedCommandName ? ( goBackToRootCommands( false ) } aria-label={ __( 'Go back to the previous screen', __i18n_text_domain__ ) } > ) : ( ) } { footerMessage && { footerMessage } } ); }; export default CommandPalette; export type { Command, CommandCallBackParams } from './commands'; export { useCommands } from './commands'; export { PromptIcon } from './icons/prompt';