PromucFlow_constructor/app/client/src/pages/Editor/ToggleModeButton.tsx

85 lines
2.5 KiB
TypeScript
Raw Normal View History

import React, { useCallback } from "react";
import styled from "styled-components";
import { useDispatch, useSelector } from "react-redux";
2023-01-09 14:22:23 +00:00
import {
Button,
Category,
IconPositions,
Size,
TooltipComponent,
feat: Renamed design system package (#19854) ## Description This PR includes changes for renaming design system package. Since we are building new package for the refactored design system components, the old package is renaming to design-system-old. Fixes #19536 ## Type of change - New feature (non-breaking change which adds functionality) - Breaking change (fix or feature that would cause existing functionality to not work as expected) ## How Has This Been Tested? - Manual - 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 - [x] My code follows the style guidelines of this project - [x] 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 - [x] My changes generate no new warnings - [ ] I have added tests that prove my fix is effective or that my feature works - [x] New and existing unit tests pass locally with my changes - [ ] PR is being merged under a feature flag ### QA activity: - [ ] Test plan has been approved by relevant developers - [ ] Test plan has been peer reviewed by QA - [ ] Cypress test cases have been added and approved by either SDET or manual QA - [ ] Organized project review call with relevant stakeholders after Round 1/2 of QA - [ ] Added Test Plan Approved label after reveiwing all Cypress test
2023-01-23 03:50:47 +00:00
} from "design-system-old";
chore: upgrade to prettier v2 + enforce import types (#21013)Co-authored-by: Satish Gandham <hello@satishgandham.com> Co-authored-by: Satish Gandham <satish.iitg@gmail.com> ## Description This PR upgrades Prettier to v2 + enforces TypeScript’s [`import type`](https://www.typescriptlang.org/docs/handbook/release-notes/typescript-3-8.html#type-only-imports-and-export) syntax where applicable. It’s submitted as a separate PR so we can merge it easily. As a part of this PR, we reformat the codebase heavily: - add `import type` everywhere where it’s required, and - re-format the code to account for Prettier 2’s breaking changes: https://prettier.io/blog/2020/03/21/2.0.0.html#breaking-changes This PR is submitted against `release` to make sure all new code by team members will adhere to new formatting standards, and we’ll have fewer conflicts when merging `bundle-optimizations` into `release`. (I’ll merge `release` back into `bundle-optimizations` once this PR is merged.) ### Why is this needed? This PR is needed because, for the Lodash optimization from https://github.com/appsmithorg/appsmith/commit/7cbb12af886621256224be0c93e6a465dd710ad3, we need to use `import type`. Otherwise, `babel-plugin-lodash` complains that `LoDashStatic` is not a lodash function. However, just using `import type` in the current codebase will give you this: <img width="962" alt="Screenshot 2023-03-08 at 17 45 59" src="https://user-images.githubusercontent.com/2953267/223775744-407afa0c-e8b9-44a1-90f9-b879348da57f.png"> That’s because Prettier 1 can’t parse `import type` at all. To parse it, we need to upgrade to Prettier 2. ### Why enforce `import type`? Apart from just enabling `import type` support, this PR enforces specifying `import type` everywhere it’s needed. (Developers will get immediate TypeScript and ESLint errors when they forget to do so.) I’m doing this because I believe `import type` improves DX and makes refactorings easier. Let’s say you had a few imports like below. Can you tell which of these imports will increase the bundle size? (Tip: it’s not all of them!) ```ts // app/client/src/workers/Linting/utils.ts import { Position } from "codemirror"; import { LintError as JSHintError, LintOptions } from "jshint"; import { get, isEmpty, isNumber, keys, last, set } from "lodash"; ``` It’s pretty hard, right? What about now? ```ts // app/client/src/workers/Linting/utils.ts import type { Position } from "codemirror"; import type { LintError as JSHintError, LintOptions } from "jshint"; import { get, isEmpty, isNumber, keys, last, set } from "lodash"; ``` Now, it’s clear that only `lodash` will be bundled. This helps developers to see which imports are problematic, but it _also_ helps with refactorings. Now, if you want to see where `codemirror` is bundled, you can just grep for `import \{.*\} from "codemirror"` – and you won’t get any type-only imports. This also helps (some) bundlers. Upon transpiling, TypeScript erases type-only imports completely. In some environment (not ours), this makes the bundle smaller, as the bundler doesn’t need to bundle type-only imports anymore. ## Type of change - Chore (housekeeping or task changes that don't impact user perception) ## How Has This Been Tested? This was tested to not break the build. ### 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 - [x] 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 - [x] 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: - [ ] Test plan has been approved by relevant developers - [ ] Test plan has been peer reviewed by QA - [ ] Cypress test cases have been added and approved by either SDET or manual QA - [ ] Organized project review call with relevant stakeholders after Round 1/2 of QA - [ ] Added Test Plan Approved label after reveiwing all Cypress test --------- Co-authored-by: Satish Gandham <hello@satishgandham.com> Co-authored-by: Satish Gandham <satish.iitg@gmail.com>
2023-03-16 11:41:47 +00:00
import type { AppState } from "@appsmith/reducers";
import { APP_MODE } from "entities/App";
import { getAppMode } from "@appsmith/selectors/applicationSelectors";
2023-01-09 14:22:23 +00:00
import { setPreviewModeInitAction } from "actions/editorActions";
import { previewModeSelector } from "selectors/editorSelectors";
2021-07-02 06:04:36 +00:00
2022-01-25 13:56:52 +00:00
import { isExploringSelector } from "selectors/onboardingSelectors";
2023-01-09 14:22:23 +00:00
import { Colors } from "constants/Colors";
import { createMessage, EDITOR_HEADER } from "ce/constants/messages";
const StyledButton = styled(Button)<{ active: boolean }>`
${(props) =>
props.active &&
`
background-color: ${Colors.GREY_200};
border: 1.2px solid transparent;
`}
padding: 0 ${(props) => props.theme.spaces[2]}px;
color: ${Colors.GREY_900};
height: ${(props) => props.theme.smallHeaderHeight};
2023-01-09 14:22:23 +00:00
svg {
height: 18px;
width: 18px;
}
2023-01-09 14:22:23 +00:00
`;
2023-01-09 14:22:23 +00:00
function ToggleModeButton() {
const dispatch = useDispatch();
const isExploring = useSelector(isExploringSelector);
const isPreviewMode = useSelector(previewModeSelector);
const appMode = useSelector(getAppMode);
2023-01-09 14:22:23 +00:00
const mode = useSelector((state: AppState) => state.entities.app.mode);
const isViewMode = mode === APP_MODE.PUBLISHED;
2023-01-09 14:22:23 +00:00
const onClickPreviewModeButton = useCallback(() => {
dispatch(setPreviewModeInitAction(!isPreviewMode));
}, [dispatch, setPreviewModeInitAction, isPreviewMode]);
2023-01-09 14:22:23 +00:00
if (isExploring || isViewMode) return null;
return (
<TooltipComponent
content={
<>
2023-01-09 14:22:23 +00:00
{createMessage(EDITOR_HEADER.previewTooltip.text)}
<span style={{ color: "#fff", marginLeft: 20 }}>
{createMessage(EDITOR_HEADER.previewTooltip.shortcut)}
</span>
</>
}
2023-01-09 14:22:23 +00:00
disabled={appMode !== APP_MODE.EDIT}
hoverOpenDelay={1000}
position="bottom"
>
2023-01-09 14:22:23 +00:00
<StyledButton
active={isPreviewMode}
category={Category.tertiary}
data-cy={`${isPreviewMode ? "preview" : "edit"}-mode`}
icon={"play-circle-line"}
iconPosition={IconPositions.left}
onClick={onClickPreviewModeButton}
size={Size.medium}
2023-01-09 14:22:23 +00:00
tag={"button"}
text={createMessage(EDITOR_HEADER.previewTooltip.text).toUpperCase()}
/>
</TooltipComponent>
);
}
export default ToggleModeButton;