mirror of https://github.com/apache/superset.git
feat: Save datapanel state in local storage (#12996)
* Save datapanel state in local storage * Export string to a constant * Move local storage helpers to separate file * Use helper functions in ExploreViewContainer
This commit is contained in:
parent
69b0ed663d
commit
2ce79823df
|
@ -24,6 +24,10 @@ import Loading from 'src/components/Loading';
|
||||||
import TableView, { EmptyWrapperType } from 'src/components/TableView';
|
import TableView, { EmptyWrapperType } from 'src/components/TableView';
|
||||||
import { getChartDataRequest } from 'src/chart/chartAction';
|
import { getChartDataRequest } from 'src/chart/chartAction';
|
||||||
import { getClientErrorObject } from 'src/utils/getClientErrorObject';
|
import { getClientErrorObject } from 'src/utils/getClientErrorObject';
|
||||||
|
import {
|
||||||
|
getFromLocalStorage,
|
||||||
|
setInLocalStorage,
|
||||||
|
} from 'src/utils/localStorageHelpers';
|
||||||
import {
|
import {
|
||||||
CopyToClipboardButton,
|
CopyToClipboardButton,
|
||||||
FilterInput,
|
FilterInput,
|
||||||
|
@ -44,6 +48,12 @@ const NULLISH_RESULTS_STATE = {
|
||||||
|
|
||||||
const DATA_TABLE_PAGE_SIZE = 50;
|
const DATA_TABLE_PAGE_SIZE = 50;
|
||||||
|
|
||||||
|
const STORAGE_KEYS = {
|
||||||
|
isOpen: 'is_datapanel_open',
|
||||||
|
};
|
||||||
|
|
||||||
|
const DATAPANEL_KEY = 'data';
|
||||||
|
|
||||||
const TableControlsWrapper = styled.div`
|
const TableControlsWrapper = styled.div`
|
||||||
display: flex;
|
display: flex;
|
||||||
align-items: center;
|
align-items: center;
|
||||||
|
@ -98,7 +108,9 @@ export const DataTablesPane = ({
|
||||||
[RESULT_TYPES.results]?: boolean;
|
[RESULT_TYPES.results]?: boolean;
|
||||||
[RESULT_TYPES.samples]?: boolean;
|
[RESULT_TYPES.samples]?: boolean;
|
||||||
}>(NULLISH_RESULTS_STATE);
|
}>(NULLISH_RESULTS_STATE);
|
||||||
const [panelOpen, setPanelOpen] = useState(false);
|
const [panelOpen, setPanelOpen] = useState(
|
||||||
|
getFromLocalStorage(STORAGE_KEYS.isOpen, false),
|
||||||
|
);
|
||||||
|
|
||||||
const getData = useCallback(
|
const getData = useCallback(
|
||||||
(resultType: string) => {
|
(resultType: string) => {
|
||||||
|
@ -140,6 +152,10 @@ export const DataTablesPane = ({
|
||||||
[queryFormData],
|
[queryFormData],
|
||||||
);
|
);
|
||||||
|
|
||||||
|
useEffect(() => {
|
||||||
|
setInLocalStorage(STORAGE_KEYS.isOpen, panelOpen);
|
||||||
|
}, [panelOpen]);
|
||||||
|
|
||||||
useEffect(() => {
|
useEffect(() => {
|
||||||
setIsRequestPending(prevState => ({
|
setIsRequestPending(prevState => ({
|
||||||
...prevState,
|
...prevState,
|
||||||
|
@ -244,11 +260,12 @@ export const DataTablesPane = ({
|
||||||
<Collapse
|
<Collapse
|
||||||
accordion
|
accordion
|
||||||
bordered={false}
|
bordered={false}
|
||||||
|
defaultActiveKey={panelOpen ? DATAPANEL_KEY : undefined}
|
||||||
onChange={handleCollapseChange}
|
onChange={handleCollapseChange}
|
||||||
bold
|
bold
|
||||||
ghost
|
ghost
|
||||||
>
|
>
|
||||||
<Collapse.Panel header={t('Data')} key="data">
|
<Collapse.Panel header={t('Data')} key={DATAPANEL_KEY}>
|
||||||
<Tabs
|
<Tabs
|
||||||
fullWidth={false}
|
fullWidth={false}
|
||||||
tabBarExtraContent={TableControls}
|
tabBarExtraContent={TableControls}
|
||||||
|
|
|
@ -23,6 +23,10 @@ import { styled, useTheme } from '@superset-ui/core';
|
||||||
import { useResizeDetector } from 'react-resize-detector';
|
import { useResizeDetector } from 'react-resize-detector';
|
||||||
import { chartPropShape } from 'src/dashboard/util/propShapes';
|
import { chartPropShape } from 'src/dashboard/util/propShapes';
|
||||||
import ChartContainer from 'src/chart/ChartContainer';
|
import ChartContainer from 'src/chart/ChartContainer';
|
||||||
|
import {
|
||||||
|
getFromLocalStorage,
|
||||||
|
setInLocalStorage,
|
||||||
|
} from 'src/utils/localStorageHelpers';
|
||||||
import ConnectedExploreChartHeader from './ExploreChartHeader';
|
import ConnectedExploreChartHeader from './ExploreChartHeader';
|
||||||
import { DataTablesPane } from './DataTablesPane';
|
import { DataTablesPane } from './DataTablesPane';
|
||||||
|
|
||||||
|
@ -56,6 +60,10 @@ const GUTTER_SIZE_FACTOR = 1.25;
|
||||||
const CHART_PANEL_PADDING = 30;
|
const CHART_PANEL_PADDING = 30;
|
||||||
const HEADER_PADDING = 15;
|
const HEADER_PADDING = 15;
|
||||||
|
|
||||||
|
const STORAGE_KEYS = {
|
||||||
|
sizes: 'chart_split_sizes',
|
||||||
|
};
|
||||||
|
|
||||||
const INITIAL_SIZES = [90, 10];
|
const INITIAL_SIZES = [90, 10];
|
||||||
const MIN_SIZES = [300, 50];
|
const MIN_SIZES = [300, 50];
|
||||||
const DEFAULT_SOUTH_PANE_HEIGHT_PERCENT = 40;
|
const DEFAULT_SOUTH_PANE_HEIGHT_PERCENT = 40;
|
||||||
|
@ -114,7 +122,9 @@ const ExploreChartPanel = props => {
|
||||||
refreshMode: 'debounce',
|
refreshMode: 'debounce',
|
||||||
refreshRate: 300,
|
refreshRate: 300,
|
||||||
});
|
});
|
||||||
const [splitSizes, setSplitSizes] = useState(INITIAL_SIZES);
|
const [splitSizes, setSplitSizes] = useState(
|
||||||
|
getFromLocalStorage(STORAGE_KEYS.sizes, INITIAL_SIZES),
|
||||||
|
);
|
||||||
|
|
||||||
const calcSectionHeight = useCallback(
|
const calcSectionHeight = useCallback(
|
||||||
percent => {
|
percent => {
|
||||||
|
@ -149,6 +159,10 @@ const ExploreChartPanel = props => {
|
||||||
recalcPanelSizes(splitSizes);
|
recalcPanelSizes(splitSizes);
|
||||||
}, [recalcPanelSizes, splitSizes]);
|
}, [recalcPanelSizes, splitSizes]);
|
||||||
|
|
||||||
|
useEffect(() => {
|
||||||
|
setInLocalStorage(STORAGE_KEYS.sizes, splitSizes);
|
||||||
|
}, [splitSizes]);
|
||||||
|
|
||||||
const onDragEnd = sizes => {
|
const onDragEnd = sizes => {
|
||||||
setSplitSizes(sizes);
|
setSplitSizes(sizes);
|
||||||
};
|
};
|
||||||
|
|
|
@ -30,6 +30,10 @@ import { Global } from '@emotion/core';
|
||||||
import { Tooltip } from 'src/common/components/Tooltip';
|
import { Tooltip } from 'src/common/components/Tooltip';
|
||||||
import { usePrevious } from 'src/common/hooks/usePrevious';
|
import { usePrevious } from 'src/common/hooks/usePrevious';
|
||||||
import Icon from 'src/components/Icon';
|
import Icon from 'src/components/Icon';
|
||||||
|
import {
|
||||||
|
getFromLocalStorage,
|
||||||
|
setInLocalStorage,
|
||||||
|
} from 'src/utils/localStorageHelpers';
|
||||||
import ExploreChartPanel from './ExploreChartPanel';
|
import ExploreChartPanel from './ExploreChartPanel';
|
||||||
import ConnectedControlPanelsContainer from './ControlPanelsContainer';
|
import ConnectedControlPanelsContainer from './ControlPanelsContainer';
|
||||||
import SaveModal from './SaveModal';
|
import SaveModal from './SaveModal';
|
||||||
|
@ -379,20 +383,12 @@ function ExploreViewContainer(props) {
|
||||||
}
|
}
|
||||||
|
|
||||||
function getSidebarWidths(key) {
|
function getSidebarWidths(key) {
|
||||||
try {
|
return getFromLocalStorage(key, defaultSidebarsWidth[key]);
|
||||||
return localStorage.getItem(key) || defaultSidebarsWidth[key];
|
|
||||||
} catch {
|
|
||||||
return defaultSidebarsWidth[key];
|
|
||||||
}
|
|
||||||
}
|
}
|
||||||
|
|
||||||
function setSidebarWidths(key, dimension) {
|
function setSidebarWidths(key, dimension) {
|
||||||
try {
|
const newDimension = Number(getSidebarWidths(key)) + dimension.width;
|
||||||
const newDimension = Number(getSidebarWidths(key)) + dimension.width;
|
setInLocalStorage(key, newDimension);
|
||||||
localStorage.setItem(key, newDimension);
|
|
||||||
} catch {
|
|
||||||
// Catch in case localStorage is unavailable
|
|
||||||
}
|
|
||||||
}
|
}
|
||||||
|
|
||||||
if (props.standalone) {
|
if (props.standalone) {
|
||||||
|
|
|
@ -0,0 +1,35 @@
|
||||||
|
/**
|
||||||
|
* Licensed to the Apache Software Foundation (ASF) under one
|
||||||
|
* or more contributor license agreements. See the NOTICE file
|
||||||
|
* distributed with this work for additional information
|
||||||
|
* regarding copyright ownership. The ASF licenses this file
|
||||||
|
* to you under the Apache License, Version 2.0 (the
|
||||||
|
* "License"); you may not use this file except in compliance
|
||||||
|
* with the License. You may obtain a copy of the License at
|
||||||
|
*
|
||||||
|
* http://www.apache.org/licenses/LICENSE-2.0
|
||||||
|
*
|
||||||
|
* Unless required by applicable law or agreed to in writing,
|
||||||
|
* software distributed under the License is distributed on an
|
||||||
|
* "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
|
||||||
|
* KIND, either express or implied. See the License for the
|
||||||
|
* specific language governing permissions and limitations
|
||||||
|
* under the License.
|
||||||
|
*/
|
||||||
|
|
||||||
|
export const getFromLocalStorage = (key: string, defaultValue: any) => {
|
||||||
|
try {
|
||||||
|
const value = localStorage.getItem(key);
|
||||||
|
return JSON.parse(value || 'null') || defaultValue;
|
||||||
|
} catch {
|
||||||
|
return defaultValue;
|
||||||
|
}
|
||||||
|
};
|
||||||
|
|
||||||
|
export const setInLocalStorage = (key: string, value: any) => {
|
||||||
|
try {
|
||||||
|
localStorage.setItem(key, JSON.stringify(value));
|
||||||
|
} catch {
|
||||||
|
// Catch in case localStorage is unavailable
|
||||||
|
}
|
||||||
|
};
|
Loading…
Reference in New Issue