PromucFlow_constructor/app/client/src/components/designSystems/appsmith/Dropdown.tsx

94 lines
2.4 KiB
TypeScript
Raw Normal View History

2019-10-21 15:12:45 +00:00
import React from "react";
import Select from "react-select";
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 { WrappedFieldInputProps } from "redux-form";
import type { SelectComponentsConfig } from "react-select/src/components";
import { LayersContext } from "constants/Layers";
import { Colors } from "constants/Colors";
2019-10-21 15:12:45 +00:00
export type DropdownProps = {
2019-10-21 15:12:45 +00:00
options: Array<{
value: string;
label?: string;
2019-10-21 15:12:45 +00:00
}>;
input: WrappedFieldInputProps;
placeholder: string;
width?: number | string;
isSearchable?: boolean;
isDisabled?: boolean;
customSelectStyles?: any;
maxMenuHeight: number;
components?: SelectComponentsConfig<any>;
2019-10-21 15:12:45 +00:00
};
const selectStyles = {
2020-01-02 13:36:35 +00:00
placeholder: (provided: any) => ({
...provided,
color: "#a3b3bf",
}),
2019-11-14 09:01:23 +00:00
control: (styles: any, state: any) => ({
2019-10-21 15:12:45 +00:00
...styles,
2020-02-07 02:32:52 +00:00
width: state.selectProps.width || 100,
minHeight: "36px",
2019-11-14 09:01:23 +00:00
border: state.isFocused
? `var(--appsmith-input-focus-border-color) solid 1px`
: `${Colors.ALTO2} solid 1px`,
2019-11-14 09:01:23 +00:00
boxShadow: state.isFocused ? 0 : 0,
padding: "1px 3px 1px",
"border-radius": "0px",
2019-11-14 09:01:23 +00:00
"&:hover": {
background: "#FAFAFA",
2019-11-14 09:01:23 +00:00
},
2019-10-21 15:12:45 +00:00
}),
2019-11-13 11:34:11 +00:00
indicatorsContainer: (provided: any) => ({
...provided,
height: "30px",
}),
clearIndicator: (provided: any) => ({
...provided,
padding: "5px",
}),
dropdownIndicator: (provided: any) => ({
...provided,
padding: "5px",
}),
indicatorSeparator: () => ({}),
menu: (provided: any) => ({
...provided,
zIndex: 2,
backgroundColor: Colors.GREY_1,
borderRadius: 0,
}),
menuPortal: (base: any) => ({ ...base, zIndex: 2 }),
2019-10-21 15:12:45 +00:00
};
export function BaseDropdown(props: DropdownProps) {
2021-05-24 09:09:43 +00:00
const layer = React.useContext(LayersContext);
const { customSelectStyles, input, placeholder } = props;
2021-05-24 09:09:43 +00:00
const menuPortalStyle = {
menuPortal: (styles: any) => ({ ...styles, zIndex: layer.max }),
};
2019-10-21 15:12:45 +00:00
return (
<Select
2021-05-07 07:35:00 +00:00
menuPortalTarget={document.body}
2021-05-24 09:09:43 +00:00
styles={{ ...selectStyles, ...customSelectStyles, ...menuPortalStyle }}
2019-10-21 15:12:45 +00:00
{...input}
isDisabled={props.isDisabled}
isSearchable={props.isSearchable}
onChange={(value) => input.onChange(value)}
width={props.width}
{...props}
2021-12-07 09:45:18 +00:00
classNamePrefix="appsmith-select"
2021-09-02 08:33:10 +00:00
menuPlacement="auto"
placeholder={placeholder}
2019-10-21 15:12:45 +00:00
/>
);
}
2019-10-21 15:12:45 +00:00
function Dropdown(props: DropdownProps) {
2019-10-21 15:12:45 +00:00
return <BaseDropdown {...props} />;
}
2019-10-21 15:12:45 +00:00
export default Dropdown;