PromucFlow_constructor/app/client/src/components/propertyControls/IconSelectControl.tsx

394 lines
11 KiB
TypeScript
Raw Normal View History

import * as React from "react";
import styled, { createGlobalStyle } from "styled-components";
import { Alignment, Button, Classes, MenuItem } from "@blueprintjs/core";
import { IconName, IconNames } from "@blueprintjs/icons";
import { ItemListRenderer, ItemRenderer, Select } from "@blueprintjs/select";
import {
GridListProps,
VirtuosoGrid,
VirtuosoGridHandle,
} from "react-virtuoso";
import BaseControl, { ControlProps } from "./BaseControl";
import TooltipComponent from "components/ads/Tooltip";
import { Colors } from "constants/Colors";
2021-12-07 09:45:18 +00:00
import { replayHighlightClass } from "globalStyles/portals";
import _ from "lodash";
const IconSelectContainerStyles = createGlobalStyle<{
targetWidth: number | undefined;
}>`
.bp3-select-popover {
width: ${({ targetWidth }) => targetWidth}px;
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 09:45:57 +00:00
background: white;
.bp3-input-group {
margin: 5px !important;
}
}
`;
const StyledButton = styled(Button)`
box-shadow: none !important;
border: 1px solid ${Colors.GREY_5};
border-radius: 0;
height: 36px;
background-color: #ffffff !important;
> span.bp3-icon-caret-down {
color: rgb(169, 167, 167);
}
&:hover,
&:focus {
border: 1.2px solid var(--appsmith-input-focus-border-color);
}
`;
const StyledMenu = styled.ul<GridListProps>`
display: grid;
grid-template-columns: repeat(4, 1fr);
grid-auto-rows: minmax(50px, auto);
gap: 8px;
max-height: 170px !important;
padding-left: 5px !important;
padding-right: 5px !important;
&::-webkit-scrollbar {
width: 8px;
background-color: #eeeeee;
}
&::-webkit-scrollbar-thumb {
border-radius: 10px;
-webkit-box-shadow: inset 0 0 6px rgba(0, 0, 0, 0.3);
background-color: #939090;
}
& li {
list-style: none;
}
`;
const StyledMenuItem = styled(MenuItem)`
flex-direction: column;
align-items: center;
padding: 13px 5px;
&:active,
&:hover,
&.bp3-active {
background-color: #eeeeee !important;
}
> span.bp3-icon {
margin-right: 0;
color: #939090 !important;
}
> div {
width: 100%;
text-align: center;
color: #939090 !important;
}
`;
export interface IconSelectControlProps extends ControlProps {
propertyValue?: IconName;
defaultIconName?: IconName;
}
export interface IconSelectControlState {
activeIcon: IconType;
isOpen: boolean;
}
const NONE = "(none)";
type IconType = IconName | typeof NONE;
const ICON_NAMES = Object.keys(IconNames).map<IconType>(
(name: string) => IconNames[name as keyof typeof IconNames],
);
ICON_NAMES.unshift(NONE);
const TypedSelect = Select.ofType<IconType>();
class IconSelectControl extends BaseControl<
IconSelectControlProps,
IconSelectControlState
> {
private iconSelectTargetRef: React.RefObject<HTMLButtonElement>;
private virtuosoRef: React.RefObject<VirtuosoGridHandle>;
private initialItemIndex: number;
private filteredItems: Array<IconType>;
private searchInput: React.RefObject<HTMLInputElement>;
constructor(props: IconSelectControlProps) {
super(props);
this.iconSelectTargetRef = React.createRef();
this.virtuosoRef = React.createRef();
this.searchInput = React.createRef();
this.initialItemIndex = 0;
this.filteredItems = [];
this.state = {
activeIcon: props.propertyValue ?? NONE,
isOpen: false,
};
}
// debouncedSetState is used to fix the following bug:
// https://github.com/appsmithorg/appsmith/pull/10460#issuecomment-1022895174
private debouncedSetState = _.debounce(
(obj: any, callback?: () => void) => {
this.setState((prevState: IconSelectControlState) => {
return {
...prevState,
...obj,
};
}, callback);
},
300,
{
leading: true,
trailing: false,
},
);
componentDidMount() {
// keydown event is attached to body so that it will not interfere with the keydown handler in GlobalHotKeys
document.body.addEventListener("keydown", this.handleKeydown);
}
componentWillUnmount() {
document.body.removeEventListener("keydown", this.handleKeydown);
}
private handleQueryChange = _.debounce(() => {
if (this.filteredItems.length === 2)
this.setState({ activeIcon: this.filteredItems[1] });
}, 50);
public render() {
const { defaultIconName, propertyValue: iconName } = this.props;
const { activeIcon } = this.state;
const containerWidth =
this.iconSelectTargetRef.current?.getBoundingClientRect?.()?.width || 0;
return (
<>
<IconSelectContainerStyles targetWidth={containerWidth} />
<TypedSelect
activeItem={activeIcon || defaultIconName || NONE}
className="icon-select-container"
inputProps={{
inputRef: this.searchInput,
}}
itemListRenderer={this.renderMenu}
itemPredicate={this.filterIconName}
itemRenderer={this.renderIconItem}
items={ICON_NAMES}
onItemSelect={this.handleIconChange}
onQueryChange={this.handleQueryChange}
popoverProps={{
enforceFocus: false,
minimal: true,
isOpen: this.state.isOpen,
onInteraction: (state) => {
if (this.state.isOpen !== state)
this.debouncedSetState({ isOpen: state });
},
}}
>
<StyledButton
alignText={Alignment.LEFT}
2021-12-07 09:45:18 +00:00
className={
Classes.TEXT_OVERFLOW_ELLIPSIS + " " + replayHighlightClass
}
elementRef={this.iconSelectTargetRef}
fill
icon={iconName || defaultIconName}
onClick={this.handleButtonClick}
rightIcon="caret-down"
text={iconName || defaultIconName || NONE}
/>
</TypedSelect>
</>
);
}
private setActiveIcon(iconIndex: number) {
this.setState(
{
activeIcon: this.filteredItems[iconIndex],
},
() => {
if (this.virtuosoRef.current) {
this.virtuosoRef.current.scrollToIndex(iconIndex);
}
},
);
}
private handleKeydown = (e: KeyboardEvent) => {
if (this.state.isOpen) {
switch (e.key) {
case "Tab":
e.preventDefault();
this.setState({
isOpen: false,
activeIcon: this.props.propertyValue ?? NONE,
});
break;
case "ArrowDown":
case "Down": {
if (document.activeElement === this.searchInput.current) {
(document.activeElement as HTMLElement).blur();
if (this.initialItemIndex < 0) this.initialItemIndex = -4;
else break;
}
const nextIndex = this.initialItemIndex + 4;
if (nextIndex < this.filteredItems.length)
this.setActiveIcon(nextIndex);
e.preventDefault();
break;
}
case "ArrowUp":
case "Up": {
if (document.activeElement === this.searchInput.current) {
break;
} else if (
(e.shiftKey ||
(this.initialItemIndex >= 0 && this.initialItemIndex < 4)) &&
this.searchInput.current
) {
this.searchInput.current.focus();
break;
}
const nextIndex = this.initialItemIndex - 4;
if (nextIndex >= 0) this.setActiveIcon(nextIndex);
e.preventDefault();
break;
}
case "ArrowRight":
case "Right": {
if (document.activeElement === this.searchInput.current) {
break;
}
const nextIndex = this.initialItemIndex + 1;
if (nextIndex < this.filteredItems.length)
this.setActiveIcon(nextIndex);
e.preventDefault();
break;
}
case "ArrowLeft":
case "Left": {
if (document.activeElement === this.searchInput.current) {
break;
}
const nextIndex = this.initialItemIndex - 1;
if (nextIndex >= 0) this.setActiveIcon(nextIndex);
e.preventDefault();
break;
}
case " ":
case "Enter": {
if (
this.searchInput.current === document.activeElement &&
this.filteredItems.length !== 2
)
break;
this.handleIconChange(this.filteredItems[this.initialItemIndex]);
this.debouncedSetState({ isOpen: false });
e.preventDefault();
e.stopPropagation();
break;
}
case "Escape": {
this.setState({
isOpen: false,
activeIcon: this.props.propertyValue ?? NONE,
});
e.stopPropagation();
}
}
} else if (
this.iconSelectTargetRef.current === document.activeElement &&
(e.key === "ArrowUp" ||
e.key === "Up" ||
e.key === "ArrowDown" ||
e.key === "Down")
) {
this.debouncedSetState({ isOpen: true }, this.handleButtonClick);
}
};
private handleButtonClick = () => {
setTimeout(() => {
if (this.virtuosoRef.current) {
this.virtuosoRef.current.scrollToIndex(this.initialItemIndex);
}
}, 0);
};
private renderMenu: ItemListRenderer<IconType> = ({
activeItem,
filteredItems,
renderItem,
}) => {
this.filteredItems = filteredItems;
this.initialItemIndex = filteredItems.findIndex((x) => x === activeItem);
return (
<VirtuosoGrid
components={{
List: StyledMenu,
}}
computeItemKey={(index) => filteredItems[index]}
initialItemCount={16}
itemContent={(index) => renderItem(filteredItems[index], index)}
ref={this.virtuosoRef}
style={{ height: "165px" }}
tabIndex={-1}
totalCount={filteredItems.length}
/>
);
};
private renderIconItem: ItemRenderer<IconName | typeof NONE> = (
icon,
{ handleClick, modifiers },
) => {
if (!modifiers.matchesPredicate) {
return null;
}
return (
<TooltipComponent content={icon}>
<StyledMenuItem
active={modifiers.active}
icon={icon === NONE ? undefined : icon}
key={icon}
onClick={handleClick}
text={icon === NONE ? NONE : undefined}
textClassName={icon === NONE ? "bp3-icon-(none)" : ""}
/>
</TooltipComponent>
);
};
private filterIconName = (
query: string,
iconName: IconName | typeof NONE,
) => {
if (iconName === NONE || query === "") {
return true;
}
return iconName.toLowerCase().indexOf(query.toLowerCase()) >= 0;
};
private handleIconChange = (icon: IconType) => {
this.setState({ activeIcon: icon });
this.updateProperty(
this.props.propertyName,
icon === NONE ? undefined : icon,
);
};
static getControlType() {
return "ICON_SELECT";
}
}
export default IconSelectControl;