2022-03-17 05:27:39 +00:00
|
|
|
import React from "react";
|
2022-02-02 14:15:07 +00:00
|
|
|
import { ComponentProps } from "widgets/BaseComponent";
|
2022-03-17 05:27:39 +00:00
|
|
|
import { Classes } from "@blueprintjs/core";
|
2022-02-02 14:15:07 +00:00
|
|
|
import { DropdownOption } from "../constants";
|
2022-03-17 05:00:24 +00:00
|
|
|
import {
|
|
|
|
|
IItemListRendererProps,
|
|
|
|
|
IItemRendererProps,
|
|
|
|
|
} from "@blueprintjs/select";
|
2022-03-17 05:27:39 +00:00
|
|
|
import { debounce, findIndex, isEmpty, isNil, isNumber } from "lodash";
|
2022-02-02 14:15:07 +00:00
|
|
|
import "../../../../node_modules/@blueprintjs/select/lib/css/blueprint-select.css";
|
2022-03-17 05:00:24 +00:00
|
|
|
import { FixedSizeList } from "react-window";
|
2022-02-02 14:15:07 +00:00
|
|
|
import { TextSize } from "constants/WidgetConstants";
|
|
|
|
|
import {
|
|
|
|
|
StyledLabel,
|
|
|
|
|
TextLabelWrapper,
|
|
|
|
|
StyledControlGroup,
|
|
|
|
|
StyledSingleDropDown,
|
|
|
|
|
DropdownStyles,
|
|
|
|
|
DropdownContainer,
|
2022-03-07 14:36:35 +00:00
|
|
|
MenuItem,
|
2022-02-02 14:15:07 +00:00
|
|
|
} from "./index.styled";
|
|
|
|
|
import Fuse from "fuse.js";
|
|
|
|
|
import { WidgetContainerDiff } from "widgets/WidgetUtils";
|
2022-03-17 05:27:39 +00:00
|
|
|
import SelectButton from "./SelectButton";
|
2022-04-04 05:12:33 +00:00
|
|
|
import { labelMargin } from "../../WidgetUtils";
|
2022-02-02 14:15:07 +00:00
|
|
|
|
|
|
|
|
const FUSE_OPTIONS = {
|
|
|
|
|
shouldSort: true,
|
|
|
|
|
threshold: 0.5,
|
|
|
|
|
location: 0,
|
|
|
|
|
minMatchCharLength: 3,
|
|
|
|
|
findAllMatches: true,
|
|
|
|
|
keys: ["label", "value"],
|
|
|
|
|
};
|
|
|
|
|
|
|
|
|
|
const DEBOUNCE_TIMEOUT = 800;
|
2022-03-17 05:00:24 +00:00
|
|
|
const ITEM_SIZE = 40;
|
2022-02-02 14:15:07 +00:00
|
|
|
|
|
|
|
|
interface SelectComponentState {
|
|
|
|
|
activeItemIndex: number | undefined;
|
|
|
|
|
query?: string;
|
2022-03-07 07:42:49 +00:00
|
|
|
isOpen?: boolean;
|
2022-02-02 14:15:07 +00:00
|
|
|
}
|
2022-03-04 08:06:38 +00:00
|
|
|
|
2022-02-02 14:15:07 +00:00
|
|
|
class SelectComponent extends React.Component<
|
|
|
|
|
SelectComponentProps,
|
|
|
|
|
SelectComponentState
|
|
|
|
|
> {
|
2022-03-17 05:40:22 +00:00
|
|
|
listRef: any = React.createRef();
|
2022-03-11 05:35:05 +00:00
|
|
|
labelRef = React.createRef<HTMLDivElement>();
|
|
|
|
|
spanRef = React.createRef<HTMLSpanElement>();
|
|
|
|
|
|
2022-02-02 14:15:07 +00:00
|
|
|
state = {
|
|
|
|
|
// used to show focused item for keyboard up down key interection
|
2022-03-11 05:35:05 +00:00
|
|
|
activeItemIndex: -1,
|
2022-02-02 14:15:07 +00:00
|
|
|
query: "",
|
2022-03-07 07:42:49 +00:00
|
|
|
isOpen: false,
|
2022-02-02 14:15:07 +00:00
|
|
|
};
|
2022-03-11 05:35:05 +00:00
|
|
|
|
2022-02-02 14:15:07 +00:00
|
|
|
componentDidMount = () => {
|
|
|
|
|
// set default selectedIndex as focused index
|
2022-03-11 05:35:05 +00:00
|
|
|
this.setState({ activeItemIndex: this.props.selectedIndex });
|
2022-02-02 14:15:07 +00:00
|
|
|
this.setState({ query: this.props.filterText });
|
|
|
|
|
};
|
|
|
|
|
|
|
|
|
|
componentDidUpdate = (prevProps: SelectComponentProps) => {
|
2022-03-04 08:06:38 +00:00
|
|
|
if (
|
|
|
|
|
prevProps.selectedIndex !== this.props.selectedIndex &&
|
|
|
|
|
this.state.activeItemIndex !== this.props.selectedIndex
|
|
|
|
|
) {
|
2022-02-02 14:15:07 +00:00
|
|
|
// update focus index if selectedIndex changed by property pane
|
|
|
|
|
this.setState({ activeItemIndex: this.props.selectedIndex });
|
|
|
|
|
}
|
|
|
|
|
};
|
|
|
|
|
|
2022-03-07 07:42:49 +00:00
|
|
|
togglePopoverVisibility = () => {
|
|
|
|
|
this.setState({ isOpen: !this.state.isOpen });
|
|
|
|
|
};
|
|
|
|
|
|
2022-02-02 14:15:07 +00:00
|
|
|
handleActiveItemChange = (activeItem: DropdownOption | null) => {
|
2022-03-04 08:06:38 +00:00
|
|
|
// 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);
|
2022-03-07 07:42:49 +00:00
|
|
|
// If Popover is open, then toggle visibility.
|
|
|
|
|
// Required when item selection is made via keyboard input.
|
|
|
|
|
if (this.state.isOpen) this.togglePopoverVisibility();
|
2022-03-04 08:06:38 +00:00
|
|
|
};
|
|
|
|
|
|
|
|
|
|
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 = (filterValue: string) => {
|
|
|
|
|
this.setState({ query: filterValue });
|
2022-03-24 12:57:39 +00:00
|
|
|
this.props.onFilterChange(filterValue);
|
2022-03-17 05:40:22 +00:00
|
|
|
this.listRef?.current?.scrollTo(0);
|
2022-03-04 08:06:38 +00:00
|
|
|
if (!this.props.serverSideFiltering) return;
|
|
|
|
|
return this.serverSideSearch(filterValue);
|
|
|
|
|
};
|
|
|
|
|
serverSideSearch = debounce((filterValue: string) => {
|
|
|
|
|
this.props.onFilterChange(filterValue);
|
|
|
|
|
}, DEBOUNCE_TIMEOUT);
|
|
|
|
|
|
|
|
|
|
renderSingleSelectItem = (
|
|
|
|
|
option: DropdownOption,
|
|
|
|
|
itemProps: IItemRendererProps,
|
|
|
|
|
) => {
|
2022-03-07 07:42:49 +00:00
|
|
|
if (!this.state.isOpen) return null;
|
2022-03-04 08:06:38 +00:00
|
|
|
if (!itemProps.modifiers.matchesPredicate) {
|
|
|
|
|
return null;
|
|
|
|
|
}
|
|
|
|
|
const isSelected: boolean = this.isOptionSelected(option);
|
|
|
|
|
// For tabbable menuItems
|
|
|
|
|
const isFocused = itemProps.modifiers.active;
|
2022-03-07 14:36:35 +00:00
|
|
|
const focusClassName = `${isFocused && "has-focus"}`;
|
2022-03-21 14:45:17 +00:00
|
|
|
const selectedClassName = `${isSelected && "menu-item-active"}`;
|
2022-03-04 08:06:38 +00:00
|
|
|
return (
|
2022-03-07 14:36:35 +00:00
|
|
|
<MenuItem 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>
|
2022-03-04 08:06:38 +00:00
|
|
|
);
|
|
|
|
|
};
|
|
|
|
|
handleCancelClick = (event: React.MouseEvent<Element, MouseEvent>) => {
|
|
|
|
|
event.stopPropagation();
|
|
|
|
|
this.onItemSelect({});
|
|
|
|
|
};
|
|
|
|
|
handleCloseList = () => {
|
2022-03-07 07:42:49 +00:00
|
|
|
if (this.state.isOpen) {
|
|
|
|
|
this.togglePopoverVisibility();
|
|
|
|
|
if (!this.props.selectedIndex) return;
|
|
|
|
|
return this.handleActiveItemChange(
|
|
|
|
|
this.props.options[this.props.selectedIndex],
|
|
|
|
|
);
|
|
|
|
|
}
|
2022-02-02 14:15:07 +00:00
|
|
|
};
|
2022-03-07 14:36:35 +00:00
|
|
|
noResultsUI = (
|
|
|
|
|
<MenuItem>
|
|
|
|
|
<a className="menu-item-link">
|
|
|
|
|
<div className="menu-item-text">No Results Found</div>
|
|
|
|
|
</a>
|
|
|
|
|
</MenuItem>
|
|
|
|
|
);
|
2022-03-17 05:00:24 +00:00
|
|
|
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,
|
|
|
|
|
);
|
|
|
|
|
};
|
2022-03-28 06:03:43 +00:00
|
|
|
menuListStyle = { height: "auto", maxHeight: 300 };
|
2022-03-17 05:00:24 +00:00
|
|
|
renderList = (
|
|
|
|
|
items: DropdownOption[],
|
|
|
|
|
activeItemIndex: number | null,
|
|
|
|
|
renderItem: (item: any, index: number) => JSX.Element | null,
|
|
|
|
|
): JSX.Element | null => {
|
2022-03-17 05:40:22 +00:00
|
|
|
// Don't scroll if the list is filtered.
|
|
|
|
|
const scrollOffset: number =
|
|
|
|
|
!this.state.query && isNumber(activeItemIndex)
|
|
|
|
|
? activeItemIndex * ITEM_SIZE
|
|
|
|
|
: 0;
|
2022-03-17 05:00:24 +00:00
|
|
|
const RowRenderer = (itemProps: any) => (
|
|
|
|
|
<div key={itemProps.index} style={itemProps.style}>
|
|
|
|
|
{renderItem(items[itemProps.index], itemProps.index)}
|
|
|
|
|
</div>
|
|
|
|
|
);
|
|
|
|
|
return (
|
|
|
|
|
<FixedSizeList
|
2022-03-21 14:45:17 +00:00
|
|
|
className="menu-virtual-list"
|
2022-03-17 05:00:24 +00:00
|
|
|
height={300}
|
2022-03-17 05:40:22 +00:00
|
|
|
initialScrollOffset={scrollOffset}
|
2022-03-17 05:00:24 +00:00
|
|
|
itemCount={items.length}
|
|
|
|
|
itemSize={ITEM_SIZE}
|
2022-03-17 05:40:22 +00:00
|
|
|
ref={this.listRef}
|
2022-03-28 06:03:43 +00:00
|
|
|
style={this.menuListStyle}
|
2022-03-21 07:48:51 +00:00
|
|
|
width={"100%"}
|
2022-03-17 05:00:24 +00:00
|
|
|
>
|
|
|
|
|
{RowRenderer}
|
|
|
|
|
</FixedSizeList>
|
|
|
|
|
);
|
|
|
|
|
};
|
2022-03-04 08:06:38 +00:00
|
|
|
|
2022-03-11 05:35:05 +00:00
|
|
|
getDropdownWidth = () => {
|
|
|
|
|
const parentWidth = this.props.width - WidgetContainerDiff;
|
|
|
|
|
if (this.props.compactMode && this.labelRef.current) {
|
2022-04-04 05:12:33 +00:00
|
|
|
const labelWidth = this.labelRef.current.getBoundingClientRect().width;
|
|
|
|
|
const widthDiff = parentWidth - labelWidth - labelMargin;
|
2022-03-11 05:35:05 +00:00
|
|
|
return widthDiff > this.props.dropDownWidth
|
|
|
|
|
? widthDiff
|
|
|
|
|
: this.props.dropDownWidth;
|
|
|
|
|
}
|
2022-04-04 05:12:33 +00:00
|
|
|
return parentWidth > this.props.dropDownWidth
|
|
|
|
|
? parentWidth
|
|
|
|
|
: this.props.dropDownWidth;
|
2022-03-11 05:35:05 +00:00
|
|
|
};
|
|
|
|
|
|
2022-02-02 14:15:07 +00:00
|
|
|
render() {
|
|
|
|
|
const {
|
|
|
|
|
compactMode,
|
|
|
|
|
disabled,
|
|
|
|
|
isLoading,
|
|
|
|
|
labelStyle,
|
|
|
|
|
labelText,
|
|
|
|
|
labelTextColor,
|
|
|
|
|
labelTextSize,
|
|
|
|
|
widgetId,
|
|
|
|
|
} = this.props;
|
2022-03-07 07:42:49 +00:00
|
|
|
// active focused item
|
2022-03-11 05:35:05 +00:00
|
|
|
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];
|
|
|
|
|
};
|
2022-02-02 14:15:07 +00:00
|
|
|
// get selected option label from selectedIndex
|
|
|
|
|
const selectedOption =
|
2022-02-22 08:43:35 +00:00
|
|
|
!isEmpty(this.props.options) &&
|
2022-02-02 14:15:07 +00:00
|
|
|
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
|
2022-02-22 08:43:35 +00:00
|
|
|
const value =
|
|
|
|
|
!isNil(selectedOption) && selectedOption !== ""
|
|
|
|
|
? selectedOption
|
|
|
|
|
: this.props.placeholder || "-- Select --";
|
2022-02-02 14:15:07 +00:00
|
|
|
|
2022-03-11 05:35:05 +00:00
|
|
|
// Check if text overflows
|
2022-03-17 06:26:44 +00:00
|
|
|
const tooltipText: string =
|
2022-03-11 05:35:05 +00:00
|
|
|
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
|
|
|
|
|
: "";
|
|
|
|
|
|
2022-02-02 14:15:07 +00:00
|
|
|
return (
|
|
|
|
|
<DropdownContainer compactMode={compactMode}>
|
2022-03-11 05:35:05 +00:00
|
|
|
<DropdownStyles dropDownWidth={this.getDropdownWidth()} id={widgetId} />
|
2022-02-02 14:15:07 +00:00
|
|
|
{labelText && (
|
2022-03-11 05:35:05 +00:00
|
|
|
<TextLabelWrapper compactMode={compactMode} ref={this.labelRef}>
|
2022-02-02 14:15:07 +00:00
|
|
|
<StyledLabel
|
|
|
|
|
$compactMode={compactMode}
|
|
|
|
|
$disabled={!!disabled}
|
|
|
|
|
$labelStyle={labelStyle}
|
|
|
|
|
$labelText={labelText}
|
|
|
|
|
$labelTextColor={labelTextColor}
|
|
|
|
|
$labelTextSize={labelTextSize}
|
|
|
|
|
className={`select-label ${
|
|
|
|
|
isLoading ? Classes.SKELETON : Classes.TEXT_OVERFLOW_ELLIPSIS
|
|
|
|
|
}`}
|
|
|
|
|
>
|
|
|
|
|
{labelText}
|
|
|
|
|
</StyledLabel>
|
|
|
|
|
</TextLabelWrapper>
|
|
|
|
|
)}
|
2022-03-07 07:42:49 +00:00
|
|
|
<StyledControlGroup fill>
|
|
|
|
|
<StyledSingleDropDown
|
2022-03-11 05:35:05 +00:00
|
|
|
activeItem={activeItem()}
|
2022-03-07 07:42:49 +00:00
|
|
|
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
|
|
|
|
|
}
|
2022-03-17 05:00:24 +00:00
|
|
|
itemListRenderer={this.itemListRenderer}
|
2022-03-07 07:42:49 +00:00
|
|
|
itemRenderer={this.renderSingleSelectItem}
|
|
|
|
|
items={this.props.options}
|
|
|
|
|
noResults={this.noResultsUI}
|
|
|
|
|
onActiveItemChange={this.handleActiveItemChange}
|
|
|
|
|
onItemSelect={this.onItemSelect}
|
|
|
|
|
onQueryChange={this.onQueryChange}
|
|
|
|
|
popoverProps={{
|
|
|
|
|
boundary: "window",
|
|
|
|
|
isOpen: this.state.isOpen,
|
|
|
|
|
minimal: true,
|
|
|
|
|
usePortal: true,
|
|
|
|
|
onClose: this.handleCloseList,
|
2022-03-11 05:35:05 +00:00
|
|
|
// 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],
|
|
|
|
|
);
|
|
|
|
|
},
|
2022-03-07 07:42:49 +00:00
|
|
|
modifiers: {
|
|
|
|
|
preventOverflow: {
|
|
|
|
|
enabled: false,
|
|
|
|
|
},
|
|
|
|
|
},
|
|
|
|
|
popoverClassName: `select-popover-wrapper select-popover-width-${this.props.widgetId}`,
|
|
|
|
|
}}
|
|
|
|
|
query={this.state.query}
|
|
|
|
|
scrollToActiveItem
|
|
|
|
|
value={this.props.value as string}
|
|
|
|
|
>
|
|
|
|
|
<SelectButton
|
2022-03-04 08:06:38 +00:00
|
|
|
disabled={disabled}
|
2022-03-07 07:42:49 +00:00
|
|
|
displayText={value}
|
|
|
|
|
handleCancelClick={this.handleCancelClick}
|
2022-03-17 06:26:44 +00:00
|
|
|
spanRef={this.spanRef}
|
2022-03-07 07:42:49 +00:00
|
|
|
togglePopoverVisibility={this.togglePopoverVisibility}
|
2022-03-17 06:26:44 +00:00
|
|
|
tooltipText={tooltipText}
|
2022-03-07 07:42:49 +00:00
|
|
|
value={this.props.value}
|
|
|
|
|
/>
|
|
|
|
|
</StyledSingleDropDown>
|
|
|
|
|
</StyledControlGroup>
|
2022-02-02 14:15:07 +00:00
|
|
|
</DropdownContainer>
|
|
|
|
|
);
|
|
|
|
|
}
|
|
|
|
|
}
|
|
|
|
|
|
|
|
|
|
export interface SelectComponentProps extends ComponentProps {
|
|
|
|
|
disabled?: boolean;
|
|
|
|
|
onOptionSelected: (optionSelected: DropdownOption) => void;
|
|
|
|
|
placeholder?: string;
|
|
|
|
|
labelText?: string;
|
|
|
|
|
labelTextColor?: string;
|
|
|
|
|
labelTextSize?: TextSize;
|
|
|
|
|
labelStyle?: string;
|
|
|
|
|
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;
|
|
|
|
|
}
|
|
|
|
|
|
2022-03-04 08:06:38 +00:00
|
|
|
export default React.memo(SelectComponent);
|