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.

Sign up for GitHub

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

Jump to bottom

Restore Ctrl/Cmd+A shortcut to select all rows and columns in results grid. #8094

Open
wants to merge 1 commit into
base: master
Choose a base branch
from
Open

Restore Ctrl/Cmd+A shortcut to select all rows and columns in results grid. #8094

Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
65 changes: 49 additions & 16 deletions web/pgadmin/tools/sqleditor/static/js/components/QueryToolDataGrid/index.jsx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -22,6 +22,7 @@ import { QueryToolEventsContext } from '../QueryToolComponent';
import PropTypes from 'prop-types';
import gettext from 'sources/gettext';
import PgReactDataGrid from '../../../../../../static/js/components/PgReactDataGrid';
import { isMac } from '../../../../../../static/js/keyboard_shortcuts';

export const ROWNUM_KEY = '$_pgadmin_rownum_key_$';
export const GRID_ROW_SELECT_KEY = '$_pgadmin_gridrowselect_key_$';
Expand Down Expand Up @@ -92,18 +93,34 @@ const StyledPgReactDataGrid = styled(PgReactDataGrid)(({theme})=>({
export const RowInfoContext = React.createContext();
export const DataGridExtrasContext = React.createContext();

function getCopyShortcutHandler(handleCopy) {
// Handles shortcut key events for the grid.
function handleShortcutKeyDown(props) {

return (e)=>{
if((e.ctrlKey || e.metaKey) && e.key !== 'Control' && e.keyCode == 67) {
const isTextEditorFocused = document.activeElement?.matches('.Editors-textarea');
// Handle Copy shortcut (Cmd/Ctrl + C)
if(((e.metaKey && isMac) || (e.ctrlKey && !isMac)) && e.key !== 'Control' && e.keyCode == 67) {
e.preventDefault();
handleCopy();
props.handleCopy();
}
// Handle Select All (Cmd/Ctrl + A)
if (((e.metaKey && isMac) || (e.ctrlKey && !isMac)) && e.key === 'a') {
// If the text editor is focused, let the default select-all behavior run.
if (!isTextEditorFocused) {
e.preventDefault();
props.eventBus.fireEvent(QUERY_TOOL_EVENTS.ALL_ROWS_SELECTED, true);
}
}
if(e.code === 'Enter' && !props.isRowSelected && props.selectedCellIdx > 0) {
props.selectCell(props.row, props.viewportColumns?.find(columns => columns.idx === props.selectedCellIdx), true);
}
};
}

function CustomRow(props) {
const rowRef = useRef();
const dataGridExtras = useContext(DataGridExtrasContext);
const eventBus = useContext(QueryToolEventsContext);

const rowInfoValue = useMemo(()=>({
getCellElement: (colIdx)=>{
Expand All @@ -116,14 +133,16 @@ function CustomRow(props) {
} else if(props.selectedCellIdx == 0) {
dataGridExtras.onSelectedCellChange?.(null);
}
const handleKeyDown = (e)=>{
const handleCopyShortcut = getCopyShortcutHandler(dataGridExtras.handleCopy);
// Invokes the copy handler.
handleCopyShortcut(e);
if(e.code === 'Enter' && !props.isRowSelected && props.selectedCellIdx > 0) {
props.selectCell(props.row, props.viewportColumns?.find(columns => columns.idx === props.selectedCellIdx), true);
}
};
const handleKeyDown = handleShortcutKeyDown({
handleCopy:dataGridExtras.handleCopy,
eventBus:eventBus,
row:props.row,
isRowSelected:props.isRowSelected,
selectedCellIdx:props.selectedCellIdx,
viewportColumns:props.viewportColumns,
selectCell:props.selectCell
});

return (
<RowInfoContext.Provider value={rowInfoValue}>
<Row ref={rowRef} onKeyDown={handleKeyDown} {...props} />
Expand All @@ -140,12 +159,13 @@ CustomRow.propTypes = {
selectCell: PropTypes.func,
};

function SelectAllHeaderRenderer({isCellSelected}) {
function SelectAllHeaderRenderer({isCellSelected, onSelectedColumnsChange}) {
const [isRowSelected, onRowSelectionChange] = useRowSelection();
const cellRef = useRef();
const eventBus = useContext(QueryToolEventsContext);
const dataGridExtras = useContext(DataGridExtrasContext);
const onClick = ()=>{
onSelectedColumnsChange(new Set());
onRowSelectionChange({ type: 'HEADER', checked: !isRowSelected });
eventBus.fireEvent(QUERY_TOOL_EVENTS.ALL_PAGE_ROWS_SELECTED, !isRowSelected);
};
Expand All @@ -159,17 +179,26 @@ function SelectAllHeaderRenderer({isCellSelected}) {
const unregClear = eventBus.registerListener(QUERY_TOOL_EVENTS.CLEAR_ROWS_SELECTED, ()=>{
onRowSelectionChange({ type: 'HEADER', checked: false });
});
const allRowsSelect = eventBus.registerListener(QUERY_TOOL_EVENTS.ALL_ROWS_SELECTED, (isSelected)=>{
onSelectedColumnsChange(new Set());
onRowSelectionChange({ type: 'HEADER', checked: isSelected });
eventBus.fireEvent(QUERY_TOOL_EVENTS.ALL_PAGE_ROWS_SELECTED, isSelected);
});
return ()=>{
unregClear();
allRowsSelect();
};
}, []);

const handleKeyDown = handleShortcutKeyDown({handleCopy:dataGridExtras.handleCopy, eventBus:eventBus});

return <div ref={cellRef} style={{width: '100%', height: '100%'}} onClick={onClick}
tabIndex="0" onKeyDown={getCopyShortcutHandler(dataGridExtras.handleCopy)}></div>;
tabIndex={0} onKeyDown={handleKeyDown}></div>;
}
SelectAllHeaderRenderer.propTypes = {
onAllRowsSelectionChange: PropTypes.func,
isCellSelected: PropTypes.bool,
onSelectedColumnsChange: PropTypes.func
};

function SelectableHeaderRenderer({column, selectedColumns, onSelectedColumnsChange, isCellSelected}) {
Expand All @@ -181,6 +210,8 @@ function SelectableHeaderRenderer({column, selectedColumns, onSelectedColumnsCha
dataGridExtras.onSelectedCellChange?.(null);
}

const handleKeyDown = handleShortcutKeyDown({handleCopy:dataGridExtras.handleCopy, eventBus:eventBus});

const onClick = ()=>{
const newSelectedCols = new Set(selectedColumns);
if (newSelectedCols.has(column.idx)) {
Expand All @@ -199,8 +230,8 @@ function SelectableHeaderRenderer({column, selectedColumns, onSelectedColumnsCha
}, [isCellSelected]);

return (
<Box ref={cellRef} className={'QueryTool-columnHeader ' + (isSelected ? 'QueryTool-colHeaderSelected' : null)} onClick={onClick} tabIndex="0"
onKeyDown={getCopyShortcutHandler(dataGridExtras.handleCopy)} data-column-key={column.key}>
<Box ref={cellRef} className={'QueryTool-columnHeader ' + (isSelected ? 'QueryTool-colHeaderSelected' : null)} onClick={onClick} tabIndex={0}
onKeyDown={handleKeyDown} data-column-key={column.key}>
{(column.column_type_internal == 'geometry' || column.column_type_internal == 'geography') &&
<Box>
<PgIconButton title={gettext('View all geometries in this column')} icon={<MapIcon data-label="MapIcon"/>} size="small" style={{marginRight: '0.25rem'}} onClick={(e)=>{
Expand Down Expand Up @@ -348,7 +379,9 @@ function formatColumns(columns, dataChangeStore, selectedColumns, onSelectedColu
}

let rowNumCol = retColumns[0];
rowNumCol.renderHeaderCell = SelectAllHeaderRenderer;
rowNumCol.renderHeaderCell = (props)=>{
return <SelectAllHeaderRenderer {...props} onSelectedColumnsChange={onSelectedColumnsChange} />;
};
rowNumCol.renderCell = (props)=>{
return <RowNumColFormatter {...props} rowKeyGetter={rowKeyGetter} dataChangeStore={dataChangeStore} onSelectedColumnsChange={onSelectedColumnsChange} />;
};
Expand Down
Loading