Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Command Center: Add an API to open/close the command center #50423

Merged
merged 1 commit into from
May 8, 2023
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
27 changes: 16 additions & 11 deletions packages/commands/src/components/command-menu.js
Original file line number Diff line number Diff line change
Expand Up @@ -139,13 +139,14 @@ export function CommandMenuGroup( { group, search, setLoader, close } ) {
export function CommandMenu() {
const { registerShortcut } = useDispatch( keyboardShortcutsStore );
const [ search, setSearch ] = useState( '' );
const [ open, setOpen ] = useState( false );
const { groups } = useSelect( ( select ) => {
const { getGroups } = select( commandsStore );
const { groups, isOpen } = useSelect( ( select ) => {
const { getGroups, isOpen: _isOpen } = select( commandsStore );
return {
groups: getGroups(),
isOpen: _isOpen(),
};
}, [] );
const { open, close } = useDispatch( commandsStore );
const [ loaders, setLoaders ] = useState( {} );
const commandMenuInput = useRef();

Expand All @@ -165,7 +166,11 @@ export function CommandMenu() {
'core/commands',
( event ) => {
event.preventDefault();
setOpen( ( prevOpen ) => ! prevOpen );
if ( isOpen ) {
close();
} else {
open();
}
},
{
bindGlobal: true,
Expand All @@ -180,19 +185,19 @@ export function CommandMenu() {
} ) ),
[]
);
const close = () => {
const closeAndReset = () => {
setSearch( '' );
setOpen( false );
close();
};

useEffect( () => {
// Focus the command menu input when mounting the modal.
if ( open ) {
if ( isOpen ) {
commandMenuInput.current.focus();
}
}, [ open ] );
}, [ isOpen ] );

if ( ! open ) {
if ( ! isOpen ) {
return false;
}
const isLoading = Object.values( loaders ).some( Boolean );
Expand All @@ -201,7 +206,7 @@ export function CommandMenu() {
<Modal
className="commands-command-menu"
overlayClassName="commands-command-menu__overlay"
onRequestClose={ close }
onRequestClose={ closeAndReset }
__experimentalHideHeader
>
<div className="commands-command-menu__container">
Expand All @@ -227,7 +232,7 @@ export function CommandMenu() {
group={ group }
search={ search }
setLoader={ setLoader }
close={ close }
close={ closeAndReset }
/>
) ) }
</Command.List>
Expand Down
2 changes: 2 additions & 0 deletions packages/commands/src/private-apis.js
Original file line number Diff line number Diff line change
Expand Up @@ -8,6 +8,7 @@ import { __dangerousOptInToUnstableAPIsOnlyForCoreModules } from '@wordpress/pri
*/
import { default as useCommand } from './hooks/use-command';
import { default as useCommandLoader } from './hooks/use-command-loader';
import { store } from './store';

export const { lock, unlock } =
__dangerousOptInToUnstableAPIsOnlyForCoreModules(
Expand All @@ -19,4 +20,5 @@ export const privateApis = {};
lock( privateApis, {
useCommand,
useCommandLoader,
store,
} );
22 changes: 22 additions & 0 deletions packages/commands/src/store/actions.js
Original file line number Diff line number Diff line change
Expand Up @@ -91,3 +91,25 @@ export function unregisterCommandLoader( name, group ) {
group,
};
}

/**
* Opens the command center.
*
* @return {Object} action.
*/
export function open() {
return {
type: 'OPEN',
};
}

/**
* Closes the command center.
*
* @return {Object} action.
*/
export function close() {
return {
type: 'CLOSE',
};
}
20 changes: 20 additions & 0 deletions packages/commands/src/store/reducer.js
Original file line number Diff line number Diff line change
Expand Up @@ -74,9 +74,29 @@ function commandLoaders( state = {}, action ) {
return state;
}

/**
* Reducer returning the command center open state.
*
* @param {Object} state Current state.
* @param {Object} action Dispatched action.
*
* @return {boolean} Updated state.
*/
function isOpen( state = false, action ) {
switch ( action.type ) {
case 'OPEN':
return true;
case 'CLOSE':
return false;
}

return state;
}

const reducer = combineReducers( {
commands,
commandLoaders,
isOpen,
} );

export default reducer;
5 changes: 5 additions & 0 deletions packages/commands/src/store/selectors.js
Original file line number Diff line number Diff line change
Expand Up @@ -18,6 +18,7 @@ export const getGroups = createSelector(
),
( state ) => [ state.commands, state.commandLoaders ]
);

export const getCommands = createSelector(
( state, group ) => Object.values( state.commands[ group ] ?? {} ),
( state, group ) => [ state.commands[ group ] ]
Expand All @@ -27,3 +28,7 @@ export const getCommandLoaders = createSelector(
( state, group ) => Object.values( state.commandLoaders[ group ] ?? {} ),
( state, group ) => [ state.commandLoaders[ group ] ]
);

export function isOpen( state ) {
return state.isOpen;
}