## Description Adds local persistence to IDE level features - IDE Tabs - IDE View mode (Split screen preference) To achieve this, added a new option: `persist` in Focus Retention. This will persist any Focus state and restore it when requested for the first time. #### PR fixes following issue(s) Fixes #31135 Fixes #31025 #### Media > A video or a GIF is preferred. when using Loom, don’t embed because it looks like it’s a GIF. instead, just link to the video > > #### Type of change > Please delete options that are not relevant. - Bug fix (non-breaking change which fixes an issue) - New feature (non-breaking change which adds functionality) - Breaking change (fix or feature that would cause existing functionality to not work as expected) - Chore (housekeeping or task changes that don't impact user perception) - This change requires a documentation update > > > ## Testing > #### How Has This Been Tested? > Please describe the tests that you ran to verify your changes. Also list any relevant details for your test configuration. > Delete anything that is not relevant - [ ] Manual - [ ] JUnit - [ ] Jest - [ ] Cypress > > #### Test Plan > Add Testsmith test cases links that relate to this PR > > #### Issues raised during DP testing > Link issues raised during DP testing for better visiblity and tracking (copy link from comments dropped on this PR) > > > ## Checklist: #### Dev activity - [ ] My code follows the style guidelines of this project - [ ] I have performed a self-review of my own code - [ ] I have commented my code, particularly in hard-to-understand areas - [ ] I have made corresponding changes to the documentation - [ ] My changes generate no new warnings - [ ] I have added tests that prove my fix is effective or that my feature works - [ ] New and existing unit tests pass locally with my changes - [ ] PR is being merged under a feature flag #### QA activity: - [ ] [Speedbreak features](https://github.com/appsmithorg/TestSmith/wiki/Guidelines-for-test-plans#speedbreakers-) have been covered - [ ] Test plan covers all impacted features and [areas of interest](https://github.com/appsmithorg/TestSmith/wiki/Guidelines-for-test-plans#areas-of-interest-) - [ ] Test plan has been peer reviewed by project stakeholders and other QA members - [ ] Manually tested functionality on DP - [ ] We had an implementation alignment call with stakeholders post QA Round 2 - [ ] Cypress test cases have been added and approved by SDET/manual QA - [ ] Added `Test Plan Approved` label after Cypress tests were reviewed - [ ] Added `Test Plan Approved` label after JUnit tests were reviewed <!-- This is an auto-generated comment: release notes by coderabbit.ai --> ## Summary by CodeRabbit - **New Features** - Introduced the ability to restore the IDE editor view mode to its last state. - Enhanced IDE tabs functionality with separate handling for query and JS tabs. - Added persistence of certain IDE states to local storage for improved user experience. - **Refactor** - Updated focus management strategies to accommodate new IDE features and state persistence. - Streamlined IDE actions and sagas for better state management and action handling. - **Bug Fixes** - Fixed an issue with the visibility of buttons in the IDE's segmented header based on specific conditions. <!-- end of auto-generated comment: release notes by coderabbit.ai -->
58 lines
1.9 KiB
TypeScript
58 lines
1.9 KiB
TypeScript
import type { ReduxAction } from "@appsmith/constants/ReduxActionConstants";
|
|
import type { AppState } from "@appsmith/reducers";
|
|
|
|
export enum FocusElement {
|
|
ApiPaneConfigTabs = "ApiPaneConfigTabs",
|
|
CodeEditorHistory = "CodeEditorHistory",
|
|
EntityCollapsibleState = "EntityCollapsibleState",
|
|
EntityExplorerWidth = "EntityExplorerWidth",
|
|
ExplorerSwitchIndex = "ExplorerSwitchIndex",
|
|
DatasourceViewMode = "DatasourceViewMode",
|
|
SelectedDatasource = "SelectedDatasource",
|
|
DebuggerContext = "DebuggerContext",
|
|
ApiRightPaneTabs = "ApiRightPaneTabs",
|
|
QueryPaneConfigTabs = "QueryPaneConfigTabs",
|
|
JSPaneConfigTabs = "JSPaneConfigTabs",
|
|
PropertySections = "PropertySections",
|
|
PropertyField = "PropertyField",
|
|
PropertyTabs = "PropertyTabs",
|
|
PropertyPanelContext = "PropertyPanelContext",
|
|
PropertyPaneWidth = "PropertyPaneWidth",
|
|
SelectedPropertyPanel = "SelectedPropertyPanel",
|
|
SelectedWidgets = "SelectedWidgets",
|
|
SubEntityCollapsibleState = "SubEntityCollapsibleState",
|
|
InputField = "InputField",
|
|
SelectedQuery = "SelectedQuery",
|
|
SelectedJSObject = "SelectedJSObject",
|
|
SelectedSegment = "SelectedSegment",
|
|
IDETabs = "IDETabs",
|
|
}
|
|
|
|
export enum FocusElementConfigType {
|
|
Redux = "Redux",
|
|
URL = "URL",
|
|
}
|
|
|
|
interface ConfigOther {
|
|
name: FocusElement;
|
|
/* If a selector is added for default value, it will be supplied the state to
|
|
derive a default value */
|
|
defaultValue?: unknown | ((state: AppState) => unknown);
|
|
subTypes?: Record<string, { defaultValue: unknown }>;
|
|
persist?: boolean;
|
|
}
|
|
|
|
type ConfigRedux = {
|
|
type: FocusElementConfigType.Redux;
|
|
selector: (state: AppState) => unknown;
|
|
setter: (payload: any) => ReduxAction<any>;
|
|
} & ConfigOther;
|
|
|
|
type ConfigURL = {
|
|
type: FocusElementConfigType.URL;
|
|
selector: (url: string) => unknown;
|
|
setter: (payload: any) => void;
|
|
} & ConfigOther;
|
|
|
|
export type FocusElementConfig = ConfigRedux | ConfigURL;
|