PromucFlow_constructor/app/client/src/widgets/SelectWidget/component/index.tsx
Pawan Kumar 809a633306
feat: App Theming (#9714)
* fix style bugs

* fix select styles

* test: fix font size issue for cypress tests

* incorporate ashit feedback

* test: addresed review comments for cypress tests

* add analytics events

* height issue in view mode

* incorporate code review feedbacks

* incorporate code review feedbacks

* refactor: addressed review comments; removed border radius and box shadow for text widget; Updated migrations

* feat: Makes shadow and radius controls keyboard accessible (#11547)

* makes shadow and radius controls keyboard accessible

* removes unused imports

* moves options out of render method

* fix: changed the misnomer background property name to the relevant property name

* fix: border radius issue for the map widget

* address qa bugs

* address qa bugs

* fix ux of theming pane when widget is selected

* fix:
* added backgroundColor to the video widget
* restricted pop-over border radius to 0.375rem
* added box shadow for the input group for select widget

* fix: added delete icon in the delete theme modal

* address qa bugs

* change checkbox column size in config

* add js convertible to button color

* remove unused imports

* test: fixed jest tests

* fix primary color typo

* fix: migrations for the theming

* fix:
* Removed background color from MultiTreeSelect and TreeSelect component.
* grouped button's menu button pop over border radius restricting to 0.375rem.

* test: updated Dsl migration UT

* address qa bugs

* address qa bugs

* fix: address qa comments

* address qa bugs

* fix:
* migration issue;
* unit test cases;

* fix rating widget scroll issue

* fix youtube video border radius bug

* fix select widget

* fix select widgets styles

* address qa bugs

* merge conflicts

* makes the reset button keyboard accessible (#12134)

* -resolved merge conflicts

* address qa bugs

* fix: labelTextSize migration fixes

* refactor:
* made changes to the fontSizeUtils function
* fixed the issue related to unit tests

* fix button group widget

* remove unused imports

* fix: fixed the text size migration for the table widget

* refactor: addressed review comments for the table widget theming migration

* fix button group widget

* add init calls for view mode

* json form init theme changes

* fix: added migration for boxShadow, borderRadius and textSizes for table widget

* fix broken fields

* test: fixed unit tests

* wip

* inconsistancy fixes and schemaItem update in updateHook/fieldConfiguration

* feat: init json form migration theming

* json form primaryColor -> accentColor

* update table widget

* update table widget

* object field label styling

* fix: migration related to the JSON form

* fix: fixed labelTextSize migration for JSON form nested widgets

* property control nested stylesheet lookup

* JSONForm label styles form array items

* show label for checkbox field array item

* fix button group widget

* wip

* refactor: addressed table widget review comments

* refactor: addressed ashit review comments;
* added childStylesheet for widgets

* feat: Keyboard navigable Color Picker control (#11797)

* Makes ColorPicker keyboard accessible

* seperate out keyboard and mouse interactions

* fix issue with not focusing back to input

* Adds test for Color picker

* chore: added comment for the boxShadow property

* fix:
* added unit test cases for the widget and property utils
* resolved warning messages

* wip

* theme config update

* fix merge conflicts

* refactor: moved theming migration inside the migrations folder

* fix qa bugs

* fix jest test

* fix: unit test cases

* fix table column creation logic

* refactor: addressed review comments for migrations

* fix: Overriding margin and padding for custom render in the dropdown component (#12875)

* * fix for custom render padding and margin in ADS dropdown

* * fix for removing padding from normal render options

* refactor: moved the boxShadow condition to the variable

* fix qa bugs

* fix: migration QA callouts for audio recorder widget

* refactor: added updated comments for boxShadow migration for table widget

* fix theme binfings for JSONForm fields under Object

* fix table widget theming bug

* fix: addressed code review comments

* fix: unit test cases

* fix: qa migration callouts

* fix table widget theming bug

* fix JSONForm currency input dropdown not submit form

* Added new tests - AppThemingSpec

* fix qa bugs

* fix unit test

* fix JSONForm cellBorderWidth to have default value post migration

* fix unit test

* fix qa bugs

* remove unused imports

* fix qa bugs

* fix JSONForm input height issue

* fix qa bugs

* Updating Theming spec

* * dropdown color fixes (#13249)

* fix caching issue
;

* Fixed Theming tests

* fix tests

* fix tab widget tests

* fix: json form children level migration issue

* fix table widget tests

* Updated test

* updated tests

* updated test

* updated tests

* updated tests

* updated pageload

* fix cypress tests

* remove cypress created files

* fix color picker issues

* Failure fixes

* Fixed some more tests

* fix: cypress test failures

* fix tests

* remove consoles

* fix table tests

* fix qa bugs

* updating snapshots for AppPageLayout_spec as per new UI

* fix rating widget bug

* fix qa bugs

* fix:
* cypress failing tests
* Migration QA callouts
* Removed unused imports

* update constract check algo

* fix color contrast issue

* fix: cypress failure test cases

* update font sizes labels

* fix regression bugs

* fix:
* JSON form labelTextSize issue fix
* Updated comment for the fontSizeUtility function
* migrations issues related to table widget borderRadius and boxShadow

* fix: default labelTextSize issue for the Input and Select families

* fix regression bugs

* fix regression bugs

* PassingParams spec - added wait time

* fix: font family default value issue on JS toggle

* fix js toggle issue in text widget

* fix tests

* fix tests

* fix tests

* fix cypress tests

* fix regression bugs

* fix regression bugs

* fix:
* refactored table widget migration function as per review comments,
* added default value to the widget

* fix: failing unit test cases

* fix theming spec

* fix cypress tests

* test: fixed failed cypress test

* incorporate ashit feedback

* fix cypress tests

* fix: addressed review comments

* comment out table cypress test

* fix merge conflicts

* comment out color picker tests

Co-authored-by: Pawan Kumar <pawankumar@Pawans-MacBook-Pro.local>
Co-authored-by: keyurparalkar <keyur@appsmith.com>
Co-authored-by: Aswath K <aswath@appsmith.com>
Co-authored-by: Nayan <nayan@appsmith.com>
Co-authored-by: Ashit Rath <ashit@appsmith.com>
Co-authored-by: balajisoundar <balaji@appsmith.com>
Co-authored-by: albinAppsmith <87797149+albinAppsmith@users.noreply.github.com>
Co-authored-by: Aishwarya UR <aishwarya@appsmith.com>
Co-authored-by: apple <nandan@thinkify.io>
Co-authored-by: Parthvi Goswami <parthvigoswami@Parthvis-MacBook-Pro.local>
2022-05-04 15:15:57 +05:30

415 lines
13 KiB
TypeScript

import React from "react";
import { ComponentProps } from "widgets/BaseComponent";
import { Alignment, Classes } from "@blueprintjs/core";
import { DropdownOption } from "../constants";
import {
IItemListRendererProps,
IItemRendererProps,
} from "@blueprintjs/select";
import { debounce, findIndex, isEmpty, isEqual, isNil, isNumber } from "lodash";
import "../../../../node_modules/@blueprintjs/select/lib/css/blueprint-select.css";
import { FixedSizeList } from "react-window";
import { TextSize } from "constants/WidgetConstants";
import {
StyledControlGroup,
StyledSingleDropDown,
DropdownStyles,
DropdownContainer,
MenuItem,
} from "./index.styled";
import Fuse from "fuse.js";
import { WidgetContainerDiff } from "widgets/WidgetUtils";
import { LabelPosition } from "components/constants";
import SelectButton from "./SelectButton";
import LabelWithTooltip from "components/ads/LabelWithTooltip";
import { labelMargin } from "../../WidgetUtils";
const FUSE_OPTIONS = {
shouldSort: true,
threshold: 0.5,
location: 0,
minMatchCharLength: 3,
findAllMatches: true,
keys: ["label", "value"],
};
const DEBOUNCE_TIMEOUT = 800;
const ITEM_SIZE = 40;
const MAX_RENDER_MENU_ITEMS_HEIGHT = 300;
interface SelectComponentState {
activeItemIndex: number | undefined;
isOpen?: boolean;
}
class SelectComponent extends React.Component<
SelectComponentProps,
SelectComponentState
> {
listRef: any = React.createRef();
labelRef = React.createRef<HTMLDivElement>();
spanRef = React.createRef<HTMLSpanElement>();
state = {
// used to show focused item for keyboard up down key interection
activeItemIndex: -1,
isOpen: false,
};
componentDidMount = () => {
// set default selectedIndex as focused index
this.setState({ activeItemIndex: this.props.selectedIndex });
};
componentDidUpdate = (prevProps: SelectComponentProps) => {
if (
prevProps.selectedIndex !== this.props.selectedIndex &&
this.state.activeItemIndex !== this.props.selectedIndex
) {
// update focus index if selectedIndex changed by property pane
this.setState({ activeItemIndex: this.props.selectedIndex });
}
};
togglePopoverVisibility = () => {
this.setState({ isOpen: !this.state.isOpen });
};
handleActiveItemChange = (activeItem: DropdownOption | null) => {
// Update state.activeItemIndex if activeItem is different from the current value
if (
activeItem?.value !==
this.props?.options[this.state.activeItemIndex]?.value
) {
// find new index from options
const activeItemIndex = findIndex(this.props.options, [
"label",
activeItem?.label,
]);
this.setState({ activeItemIndex });
}
};
itemListPredicate(query: string, items: DropdownOption[]) {
if (!query) return items;
const fuse = new Fuse(items, FUSE_OPTIONS);
return fuse.search(query);
}
onItemSelect = (item: DropdownOption): void => {
this.props.onOptionSelected(item);
// If Popover is open, then toggle visibility.
// Required when item selection is made via keyboard input.
if (this.state.isOpen) this.togglePopoverVisibility();
};
isOptionSelected = (selectedOption: DropdownOption) => {
if (this.props.value) return selectedOption.value === this.props.value;
const optionIndex = findIndex(this.props.options, (option) => {
return option.value === selectedOption.value;
});
return optionIndex === this.props.selectedIndex;
};
onQueryChange = debounce((filterValue: string) => {
if (isEqual(filterValue, this.props.filterText)) return;
this.props.onFilterChange(filterValue);
this.listRef?.current?.scrollTo(0);
}, DEBOUNCE_TIMEOUT);
renderSingleSelectItem = (
option: DropdownOption,
itemProps: IItemRendererProps,
) => {
if (!this.state.isOpen) return null;
if (!itemProps.modifiers.matchesPredicate) {
return null;
}
const isSelected: boolean = this.isOptionSelected(option);
// For tabbable menuItems
const isFocused = itemProps.modifiers.active;
const focusClassName = `${isFocused && "has-focus"}`;
const selectedClassName = `${isSelected && "menu-item-active"}`;
return (
<MenuItem
accentColor={this.props.accentColor}
key={option.value}
onClick={itemProps.handleClick}
>
<a
className={`menu-item-link ${selectedClassName} ${focusClassName}`}
tabIndex={0}
>
<div className="menu-item-text">{option.label}</div>
</a>
</MenuItem>
);
};
handleCancelClick = (event: React.MouseEvent<Element, MouseEvent>) => {
event.stopPropagation();
this.onItemSelect({});
};
handleCloseList = () => {
if (this.state.isOpen) {
this.togglePopoverVisibility();
if (!this.props.selectedIndex) return;
return this.handleActiveItemChange(
this.props.options[this.props.selectedIndex],
);
}
};
noResultsUI = (
<MenuItem accentColor={this.props.accentColor}>
<a className="menu-item-link">
<div className="menu-item-text">No Results Found</div>
</a>
</MenuItem>
);
itemListRenderer = (
props: IItemListRendererProps<any>,
): JSX.Element | null => {
if (!this.state.isOpen) return null;
let activeItemIndex = this.props.selectedIndex || null;
if (props.activeItem && activeItemIndex === null) {
activeItemIndex = props.filteredItems?.findIndex(
(item) => item.value === props.activeItem?.value,
);
}
if (!props.filteredItems || !props.filteredItems.length)
return this.noResultsUI;
return this.renderList(
props.filteredItems,
activeItemIndex,
props.renderItem,
);
};
menuListStyle = { height: "auto", maxHeight: MAX_RENDER_MENU_ITEMS_HEIGHT };
renderList = (
items: DropdownOption[],
activeItemIndex: number | null,
renderItem: (item: any, index: number) => JSX.Element | null,
): JSX.Element | null => {
// Don't scroll if the list is filtered.
const optionsCount = this.props.options.length;
const scrollOffset: number =
!this.props.filterText &&
isNumber(activeItemIndex) &&
optionsCount * ITEM_SIZE > MAX_RENDER_MENU_ITEMS_HEIGHT
? activeItemIndex * ITEM_SIZE
: 0;
const RowRenderer = (itemProps: any) => (
<div key={itemProps.index} style={itemProps.style}>
{renderItem(items[itemProps.index], itemProps.index)}
</div>
);
return (
<FixedSizeList
className="menu-virtual-list"
height={MAX_RENDER_MENU_ITEMS_HEIGHT}
initialScrollOffset={scrollOffset}
itemCount={items.length}
itemSize={ITEM_SIZE}
ref={this.listRef}
style={this.menuListStyle}
width={"100%"}
>
{RowRenderer}
</FixedSizeList>
);
};
getDropdownWidth = () => {
const parentWidth = this.props.width - WidgetContainerDiff;
if (this.props.compactMode && this.labelRef.current) {
const labelWidth = this.labelRef.current.getBoundingClientRect().width;
const widthDiff = parentWidth - labelWidth - labelMargin;
return widthDiff > this.props.dropDownWidth
? widthDiff
: this.props.dropDownWidth;
}
return parentWidth > this.props.dropDownWidth
? parentWidth
: this.props.dropDownWidth;
};
render() {
const {
accentColor,
borderRadius,
boxShadow,
compactMode,
disabled,
isLoading,
labelAlignment,
labelPosition,
labelStyle,
labelText,
labelTextColor,
labelTextSize,
labelWidth,
widgetId,
} = this.props;
// active focused item
const activeItem = () => {
if (
this.state.activeItemIndex === -1 ||
isNil(this.state.activeItemIndex)
)
return undefined;
if (!isEmpty(this.props.options))
return this.props.options[this.state.activeItemIndex];
};
// get selected option label from selectedIndex
const selectedOption =
!isEmpty(this.props.options) &&
this.props.selectedIndex !== undefined &&
this.props.selectedIndex > -1
? this.props.options[this.props.selectedIndex].label
: this.props.label;
// for display selected option, there is no separate option to show placeholder
const value =
!isNil(selectedOption) && selectedOption !== ""
? selectedOption
: this.props.placeholder || "-- Select --";
// Check if text overflows
const tooltipText: string =
this.spanRef.current?.parentElement &&
(this.spanRef.current.parentElement.offsetHeight <
this.spanRef.current.parentElement.scrollHeight ||
this.spanRef.current.parentElement.offsetWidth <
this.spanRef.current.parentElement.scrollWidth)
? value
: "";
return (
<DropdownContainer
compactMode={compactMode}
data-testid="select-container"
labelPosition={labelPosition}
>
<DropdownStyles
accentColor={accentColor}
borderRadius={borderRadius}
dropDownWidth={this.getDropdownWidth()}
id={widgetId}
/>
{labelText && (
<LabelWithTooltip
alignment={labelAlignment}
className={`select-label`}
color={labelTextColor}
compact={compactMode}
disabled={disabled}
fontSize={labelTextSize}
fontStyle={labelStyle}
loading={isLoading}
position={labelPosition}
ref={this.labelRef}
text={labelText}
width={labelWidth}
/>
)}
<StyledControlGroup
compactMode={compactMode}
fill
labelPosition={labelPosition}
>
<StyledSingleDropDown
accentColor={accentColor}
activeItem={activeItem()}
borderRadius={borderRadius}
boxShadow={boxShadow}
className={isLoading ? Classes.SKELETON : ""}
disabled={disabled}
filterable={this.props.isFilterable}
hasError={this.props.hasError}
isValid={this.props.isValid}
itemListPredicate={
!this.props.serverSideFiltering
? this.itemListPredicate
: undefined
}
itemListRenderer={this.itemListRenderer}
itemRenderer={this.renderSingleSelectItem}
items={this.props.options}
noResults={this.noResultsUI}
onActiveItemChange={this.handleActiveItemChange}
onItemSelect={this.onItemSelect}
onQueryChange={this.onQueryChange}
popoverProps={{
portalContainer:
document.getElementById("art-board") || undefined,
boundary: "window",
isOpen: this.state.isOpen,
minimal: true,
usePortal: true,
onClose: this.handleCloseList,
// onActiveItemChange is called twice abd puts the focus on the first item https://github.com/palantir/blueprint/issues/4192
onOpening: () => {
if (!this.props.selectedIndex) {
return this.handleActiveItemChange(null);
}
return this.handleActiveItemChange(
this.props.options[this.props.selectedIndex],
);
},
modifiers: {
preventOverflow: {
enabled: false,
},
},
popoverClassName: `select-popover-wrapper select-popover-width-${this.props.widgetId}`,
}}
query={this.props.filterText}
scrollToActiveItem
value={this.props.value as string}
>
<SelectButton
disabled={disabled}
displayText={value}
handleCancelClick={this.handleCancelClick}
spanRef={this.spanRef}
togglePopoverVisibility={this.togglePopoverVisibility}
tooltipText={tooltipText}
value={this.props.value}
/>
</StyledSingleDropDown>
</StyledControlGroup>
</DropdownContainer>
);
}
}
export interface SelectComponentProps extends ComponentProps {
disabled?: boolean;
onOptionSelected: (optionSelected: DropdownOption) => void;
placeholder?: string;
labelAlignment?: Alignment;
labelPosition?: LabelPosition;
labelText: string;
labelTextColor?: string;
labelTextSize?: TextSize;
labelStyle?: string;
labelWidth?: number;
compactMode: boolean;
selectedIndex?: number;
options: DropdownOption[];
isLoading: boolean;
isFilterable: boolean;
isValid: boolean;
width: number;
dropDownWidth: number;
height: number;
serverSideFiltering: boolean;
hasError?: boolean;
onFilterChange: (text: string) => void;
value?: string;
label?: string;
filterText?: string;
borderRadius: string;
boxShadow?: string;
accentColor?: string;
}
export default React.memo(SelectComponent);