PromucFlow_constructor/app/client/src/pages/AppViewer/SideNav.tsx

114 lines
3.0 KiB
TypeScript
Raw Normal View History

import React from "react";
2019-11-05 05:09:50 +00:00
import styled from "styled-components";
import { Menu, Button } from "@blueprintjs/core";
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 { SideNavItemProps } from "./SideNavItem";
import SideNavItem from "./SideNavItem";
import LetterIcon from "components/editorComponents/LetterIcon";
interface SideNavProps {
items?: SideNavItemProps[];
active?: string;
2019-11-05 05:09:50 +00:00
headeroffset?: number;
open: boolean;
toggleCollapse: (open: boolean) => void;
}
2019-11-05 05:09:50 +00:00
/* eslint-disable no-unexpected-multiline */
const SideNavWrapper = styled.div<{
open: boolean;
headeroffset?: number;
}>`
&&& {
2020-12-24 04:32:25 +00:00
width: ${(props) =>
2019-11-05 05:09:50 +00:00
props.open
? props.theme.sideNav.maxWidth
: props.theme.sideNav.minWidth}px;
transition: width 0.2s ease-in;
2019-11-05 05:09:50 +00:00
height: 100%;
& ul {
2020-12-24 04:32:25 +00:00
min-width: ${(props) => props.theme.sideNav.minWidth}px;
2019-11-05 05:09:50 +00:00
overflow-y: auto;
& a {
text-decoration: none;
2020-12-24 04:32:25 +00:00
color: ${(props) => props.theme.colors.textOnDarkBG};
}
2019-11-05 05:09:50 +00:00
& li > div {
width: 100%;
display: flex;
justify-content: center;
align-items: center;
2020-12-24 04:32:25 +00:00
padding: 0 ${(props) => (props.open ? props.theme.spaces[6] : 0)}px;
height: ${(props) => props.theme.sideNav.navItemHeight}px;
2019-11-05 05:09:50 +00:00
text-transform: capitalize;
& > span {
2020-12-24 04:32:25 +00:00
margin-right: ${(props) =>
props.open ? props.theme.spaces[3] : 0}px;
2019-11-05 05:09:50 +00:00
}
}
}
}
`;
const ToggleButton = styled(Button)<{
open: boolean;
headeroffset?: number;
}>`
&& {
position: fixed;
top: 0;
left: 0;
display: flex;
2020-12-24 04:32:25 +00:00
width: ${(props) =>
props.open
? props.theme.sideNav.maxWidth
: props.theme.sideNav.minWidth}px;
2020-12-24 04:32:25 +00:00
height: ${(props) => props.headeroffset || 50}px;
justify-content: flex-end;
2020-12-24 04:32:25 +00:00
padding-right: ${(props) => props.theme.sideNav.minWidth / 2}px;
transition: width 0.1s ease-in;
}
2019-11-05 05:09:50 +00:00
`;
export function SideNav(props: SideNavProps) {
const { open, toggleCollapse } = props;
const renderItems = (sideNavItems?: SideNavItemProps[]) => {
let items = sideNavItems;
if (!items) {
items = [
{ id: "0", text: "", path: "", loading: true, showText: true },
{ id: "1", text: "", path: "", loading: true, showText: true },
{ id: "2", text: "", path: "", loading: true, showText: true },
];
}
2020-12-24 04:32:25 +00:00
return items.map((item) => {
const icon =
item.text.length > 0 ? (
<LetterIcon
text={String.fromCodePoint(item.text.codePointAt(0) || 0)}
/>
) : null;
return (
<SideNavItem key={item.id} showText={open} {...item} icon={icon} />
2019-11-05 05:09:50 +00:00
);
});
};
return (
<SideNavWrapper headeroffset={props.headeroffset} open={open}>
2019-11-05 05:09:50 +00:00
<ToggleButton
className="sidenav-toggle"
2019-11-05 05:09:50 +00:00
headeroffset={props.headeroffset}
icon={open ? "double-chevron-left" : "menu"}
minimal
onClick={() => {
toggleCollapse(!open);
}}
2019-11-05 05:09:50 +00:00
open={open}
/>
2019-11-05 05:09:50 +00:00
<Menu large>{renderItems(props.items)}</Menu>
</SideNavWrapper>
);
}
2019-11-05 05:09:50 +00:00
export default SideNav;