mirror of https://github.com/apache/superset.git
feat: Stop editor scrolling to top (#26754)
Co-authored-by: Puridach Wutthihathaithamrong <> Co-authored-by: JUST.in DO IT <justin.park@airbnb.com>
This commit is contained in:
parent
11f0dd91db
commit
ed934a93e1
|
@ -59,6 +59,8 @@ export const QUERY_EDITOR_SET_SCHEMA = 'QUERY_EDITOR_SET_SCHEMA';
|
|||
export const QUERY_EDITOR_SET_TITLE = 'QUERY_EDITOR_SET_TITLE';
|
||||
export const QUERY_EDITOR_SET_AUTORUN = 'QUERY_EDITOR_SET_AUTORUN';
|
||||
export const QUERY_EDITOR_SET_SQL = 'QUERY_EDITOR_SET_SQL';
|
||||
export const QUERY_EDITOR_SET_CURSOR_POSITION =
|
||||
'QUERY_EDITOR_SET_CURSOR_POSITION';
|
||||
export const QUERY_EDITOR_SET_QUERY_LIMIT = 'QUERY_EDITOR_SET_QUERY_LIMIT';
|
||||
export const QUERY_EDITOR_SET_TEMPLATE_PARAMS =
|
||||
'QUERY_EDITOR_SET_TEMPLATE_PARAMS';
|
||||
|
@ -881,6 +883,10 @@ export function queryEditorSetSql(queryEditor, sql, queryId) {
|
|||
return { type: QUERY_EDITOR_SET_SQL, queryEditor, sql, queryId };
|
||||
}
|
||||
|
||||
export function queryEditorSetCursorPosition(queryEditor, position) {
|
||||
return { type: QUERY_EDITOR_SET_CURSOR_POSITION, queryEditor, position };
|
||||
}
|
||||
|
||||
export function queryEditorSetAndSaveSql(targetQueryEditor, sql, queryId) {
|
||||
return function (dispatch, getState) {
|
||||
const queryEditor = getUpToDateQuery(getState(), targetQueryEditor);
|
||||
|
|
|
@ -51,6 +51,7 @@ const setup = (queryEditor: QueryEditor, store?: Store) =>
|
|||
onChange={jest.fn()}
|
||||
onBlur={jest.fn()}
|
||||
autocomplete
|
||||
onCursorPositionChange={jest.fn()}
|
||||
/>,
|
||||
{
|
||||
useRedux: true,
|
||||
|
|
|
@ -25,6 +25,7 @@ import { queryEditorSetSelectedText } from 'src/SqlLab/actions/sqlLab';
|
|||
import { FullSQLEditor as AceEditor } from 'src/components/AsyncAceEditor';
|
||||
import type { KeyboardShortcut } from 'src/SqlLab/components/KeyboardShortcutButton';
|
||||
import useQueryEditor from 'src/SqlLab/hooks/useQueryEditor';
|
||||
import type { CursorPosition } from 'src/SqlLab/types';
|
||||
import { useAnnotations } from './useAnnotations';
|
||||
import { useKeywords } from './useKeywords';
|
||||
|
||||
|
@ -40,6 +41,7 @@ type AceEditorWrapperProps = {
|
|||
onBlur: (sql: string) => void;
|
||||
onChange: (sql: string) => void;
|
||||
queryEditorId: string;
|
||||
onCursorPositionChange: (position: CursorPosition) => void;
|
||||
height: string;
|
||||
hotkeys: HotKey[];
|
||||
};
|
||||
|
@ -69,6 +71,7 @@ const AceEditorWrapper = ({
|
|||
onBlur = () => {},
|
||||
onChange = () => {},
|
||||
queryEditorId,
|
||||
onCursorPositionChange,
|
||||
height,
|
||||
hotkeys,
|
||||
}: AceEditorWrapperProps) => {
|
||||
|
@ -79,10 +82,11 @@ const AceEditorWrapper = ({
|
|||
'sql',
|
||||
'schema',
|
||||
'templateParams',
|
||||
'cursorPosition',
|
||||
]);
|
||||
|
||||
const currentSql = queryEditor.sql ?? '';
|
||||
|
||||
const cursorPosition = queryEditor.cursorPosition ?? { row: 0, column: 0 };
|
||||
const [sql, setSql] = useState(currentSql);
|
||||
|
||||
// The editor changeSelection is called multiple times in a row,
|
||||
|
@ -143,6 +147,15 @@ const AceEditorWrapper = ({
|
|||
|
||||
currentSelectionCache.current = selectedText;
|
||||
});
|
||||
editor.selection.on('changeCursor', () => {
|
||||
const cursor = editor.getCursorPosition();
|
||||
onCursorPositionChange(cursor);
|
||||
});
|
||||
|
||||
const { row, column } = cursorPosition;
|
||||
editor.moveCursorToPosition({ row, column });
|
||||
editor.focus();
|
||||
editor.scrollToLine(row, true, true);
|
||||
};
|
||||
|
||||
const onChangeText = (text: string) => {
|
||||
|
|
|
@ -42,7 +42,11 @@ import {
|
|||
QueryResponse,
|
||||
Query,
|
||||
} from '@superset-ui/core';
|
||||
import type { QueryEditor, SqlLabRootState } from 'src/SqlLab/types';
|
||||
import type {
|
||||
QueryEditor,
|
||||
SqlLabRootState,
|
||||
CursorPosition,
|
||||
} from 'src/SqlLab/types';
|
||||
import type { DatabaseObject } from 'src/features/databases/types';
|
||||
import { debounce, throttle, isBoolean, isEmpty } from 'lodash';
|
||||
import Modal from 'src/components/Modal';
|
||||
|
@ -63,6 +67,7 @@ import {
|
|||
postStopQuery,
|
||||
queryEditorSetAutorun,
|
||||
queryEditorSetSql,
|
||||
queryEditorSetCursorPosition,
|
||||
queryEditorSetAndSaveSql,
|
||||
queryEditorSetTemplateParams,
|
||||
runQueryFromSqlEditor,
|
||||
|
@ -757,6 +762,10 @@ const SqlEditor: React.FC<Props> = ({
|
|||
);
|
||||
};
|
||||
|
||||
const handleCursorPositionChange = (newPosition: CursorPosition) => {
|
||||
dispatch(queryEditorSetCursorPosition(queryEditor, newPosition));
|
||||
};
|
||||
|
||||
const queryPane = () => {
|
||||
const { aceEditorHeight, southPaneHeight } =
|
||||
getAceEditorAndSouthPaneHeights(height, northPercent, southPercent);
|
||||
|
@ -787,6 +796,7 @@ const SqlEditor: React.FC<Props> = ({
|
|||
onBlur={onSqlChanged}
|
||||
onChange={onSqlChanged}
|
||||
queryEditorId={queryEditor.id}
|
||||
onCursorPositionChange={handleCursorPositionChange}
|
||||
height={`${aceEditorHeight}px`}
|
||||
hotkeys={hotkeys}
|
||||
/>
|
||||
|
|
|
@ -65,6 +65,7 @@ export default function getInitialState({
|
|||
queryLimit: common.conf.DEFAULT_SQLLAB_LIMIT,
|
||||
hideLeftBar: false,
|
||||
remoteId: null,
|
||||
cursorPosition: { row: 0, column: 0 },
|
||||
};
|
||||
let unsavedQueryEditor: UnsavedQueryEditor = {};
|
||||
|
||||
|
|
|
@ -544,6 +544,18 @@ export default function sqlLabReducer(state = {}, action) {
|
|||
),
|
||||
};
|
||||
},
|
||||
[actions.QUERY_EDITOR_SET_CURSOR_POSITION]() {
|
||||
return {
|
||||
...state,
|
||||
...alterUnsavedQueryEditorState(
|
||||
state,
|
||||
{
|
||||
cursorPosition: action.position,
|
||||
},
|
||||
action.queryEditor.id,
|
||||
),
|
||||
};
|
||||
},
|
||||
[actions.QUERY_EDITOR_SET_QUERY_LIMIT]() {
|
||||
return {
|
||||
...state,
|
||||
|
|
|
@ -35,6 +35,11 @@ export enum QueryEditorVersion {
|
|||
|
||||
export const LatestQueryEditorVersion = QueryEditorVersion.v1;
|
||||
|
||||
export interface CursorPosition {
|
||||
row: number;
|
||||
column: number;
|
||||
}
|
||||
|
||||
export interface QueryEditor {
|
||||
version: QueryEditorVersion;
|
||||
id: string;
|
||||
|
@ -56,6 +61,7 @@ export interface QueryEditor {
|
|||
northPercent?: number;
|
||||
southPercent?: number;
|
||||
updatedAt?: number;
|
||||
cursorPosition?: CursorPosition;
|
||||
}
|
||||
|
||||
export type toastState = {
|
||||
|
|
Loading…
Reference in New Issue