@blueprintjs/select
Version:
Components related to selecting items from a list
173 lines • 9.53 kB
JavaScript
/*
* Copyright 2022 Palantir Technologies, Inc. All rights reserved.
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/
import classNames from "classnames";
import * as React from "react";
import { AbstractPureComponent, Button, Classes as CoreClasses, DISPLAYNAME_PREFIX, InputGroup, Popover, PopupKind, refHandler, setRef, Utils, } from "@blueprintjs/core";
import { Cross, Search } from "@blueprintjs/icons";
import { Classes } from "../../common";
import { QueryList } from "../query-list/queryList";
/**
* Select component.
*
* @see https://blueprintjs.com/docs/#select/select
*/
export class Select extends AbstractPureComponent {
static displayName = `${DISPLAYNAME_PREFIX}.Select`;
/** @deprecated no longer necessary now that the TypeScript parser supports type arguments on JSX element tags */
static ofType() {
return Select;
}
state = { isOpen: false };
inputElement = null;
queryList = null;
previousFocusedElement;
handleInputRef = refHandler(this, "inputElement", this.props.inputProps?.inputRef);
handleQueryListRef = (ref) => (this.queryList = ref);
listboxId = Utils.uniqueId("listbox");
render() {
// omit props specific to this component, spread the rest.
const { filterable, inputProps, menuProps, popoverProps, ...restProps } = this.props;
return (React.createElement(QueryList, { ...restProps, menuProps: { "aria-label": "selectable options", ...menuProps, id: this.listboxId }, onItemSelect: this.handleItemSelect, ref: this.handleQueryListRef, renderer: this.renderQueryList }));
}
componentDidUpdate(prevProps, prevState) {
if (prevProps.inputProps?.inputRef !== this.props.inputProps?.inputRef) {
setRef(prevProps.inputProps?.inputRef, null);
this.handleInputRef = refHandler(this, "inputElement", this.props.inputProps?.inputRef);
setRef(this.props.inputProps?.inputRef, this.inputElement);
}
if (this.state.isOpen && !prevState.isOpen && this.queryList != null) {
this.queryList.scrollActiveItemIntoView();
}
}
renderQueryList = (listProps) => {
// not using defaultProps cuz they're hard to type with generics (can't use <T> on static members)
const { filterable = true, disabled = false, inputProps = {}, placeholder = "Filter...", popoverContentProps = {}, popoverProps = {}, popoverRef, } = this.props;
const input = (React.createElement(InputGroup, { "aria-autocomplete": "list", leftIcon: React.createElement(Search, null), placeholder: placeholder, rightElement: this.maybeRenderClearButton(listProps.query), ...inputProps, inputRef: this.handleInputRef, onChange: listProps.handleQueryChange, value: listProps.query }));
const { handleKeyDown, handleKeyUp } = listProps;
// N.B. no need to set `fill` since that is unused with the `renderTarget` API
return (React.createElement(Popover, { autoFocus: false, enforceFocus: false, isOpen: this.state.isOpen, disabled: disabled, placement: popoverProps.position || popoverProps.placement ? undefined : "bottom-start", ...popoverProps, className: classNames(listProps.className, popoverProps.className), content: React.createElement("div", { ...popoverContentProps, onKeyDown: handleKeyDown, onKeyUp: handleKeyUp },
filterable ? input : undefined,
listProps.itemList), onClosing: this.handlePopoverClosing, onInteraction: this.handlePopoverInteraction, onOpened: this.handlePopoverOpened, onOpening: this.handlePopoverOpening, popoverClassName: classNames(Classes.SELECT_POPOVER, popoverProps.popoverClassName), popupKind: PopupKind.LISTBOX, ref: popoverRef, renderTarget: this.getPopoverTargetRenderer(listProps, this.state.isOpen) }));
};
// We use the renderTarget API to flatten the rendered DOM and make it easier to implement features like
// the "fill" prop. Note that we must take `isOpen` as an argument to force this render function to be called
// again after that state changes.
getPopoverTargetRenderer = (listProps, isOpen) =>
// N.B. pull out `isOpen` so that it's not forwarded to the DOM, but remember not to use it directly
// since it may be stale (`renderTarget` is not re-invoked on this.state changes).
// eslint-disable-next-line react/display-name
({ isOpen: _isOpen, ref, ...targetProps }) => {
const { disabled, popoverProps = {}, popoverTargetProps } = this.props;
const { handleKeyDown, handleKeyUp } = listProps;
const { targetTagName = "div" } = popoverProps;
return React.createElement(targetTagName, {
"aria-controls": this.listboxId,
...popoverTargetProps,
...targetProps,
"aria-disabled": disabled,
"aria-expanded": isOpen,
// Note that we must set FILL here in addition to children to get the wrapper element to full width
className: classNames(targetProps.className, popoverTargetProps?.className, {
[CoreClasses.FILL]: this.props.fill,
}),
// Normally, Popover would also need to attach its own `onKeyDown` handler via `targetProps`,
// but in our case we fully manage that interaction and listen for key events to open/close
// the popover, so we elide it from the DOM.
onKeyDown: this.withPopoverTargetPropsHandler("keydown", isOpen ? handleKeyDown : this.handleTargetKeyDown),
onKeyUp: this.withPopoverTargetPropsHandler("keyup", isOpen ? handleKeyUp : undefined),
ref,
role: "combobox",
}, this.props.children);
};
maybeRenderClearButton(query) {
return query.length > 0 ? (React.createElement(Button, { "aria-label": "Clear filter query", icon: React.createElement(Cross, null), minimal: true, onClick: this.resetQuery, title: "Clear filter query" })) : undefined;
}
withPopoverTargetPropsHandler = (eventType, handler) => {
switch (eventType) {
case "keydown":
return event => {
handler?.(event);
this.props.popoverTargetProps?.onKeyDown?.(event);
};
case "keyup":
return event => {
handler?.(event);
this.props.popoverTargetProps?.onKeyUp?.(event);
};
}
};
/**
* Target wrapper element "keydown" handler while the popover is closed.
*/
handleTargetKeyDown = (event) => {
// open popover when arrow key pressed on target while closed
if (event.key === "ArrowUp" || event.key === "ArrowDown") {
event.preventDefault();
this.setState({ isOpen: true });
}
else if (Utils.isKeyboardClick(event)) {
this.setState({ isOpen: true });
}
};
handleItemSelect = (item, event) => {
const target = event?.target;
const menuItem = target?.closest(`.${CoreClasses.MENU_ITEM}`);
const menuItemDismiss = menuItem?.matches(`.${CoreClasses.POPOVER_DISMISS}`);
const shouldDismiss = menuItemDismiss ?? true;
this.setState({ isOpen: !shouldDismiss });
this.props.onItemSelect?.(item, event);
};
handlePopoverInteraction = (isOpen, event) => {
this.setState({ isOpen });
this.props.popoverProps?.onInteraction?.(isOpen, event);
};
handlePopoverOpening = (node) => {
// save currently focused element before popover steals focus, so we can restore it when closing.
this.previousFocusedElement = Utils.getActiveElement(this.inputElement) ?? undefined;
if (this.props.resetOnClose) {
this.resetQuery();
}
this.props.popoverProps?.onOpening?.(node);
};
handlePopoverOpened = (node) => {
// scroll active item into view after popover transition completes and all dimensions are stable.
if (this.queryList != null) {
this.queryList.scrollActiveItemIntoView();
}
this.requestAnimationFrame(() => {
const { inputProps = {} } = this.props;
// autofocus is enabled by default
if (inputProps.autoFocus !== false) {
this.inputElement?.focus();
}
});
this.props.popoverProps?.onOpened?.(node);
};
handlePopoverClosing = (node) => {
// restore focus to saved element.
// timeout allows popover to begin closing and remove focus handlers beforehand.
/* istanbul ignore next */
this.requestAnimationFrame(() => {
if (this.previousFocusedElement !== undefined) {
this.previousFocusedElement.focus();
this.previousFocusedElement = undefined;
}
});
this.props.popoverProps?.onClosing?.(node);
};
resetQuery = () => this.queryList && this.queryList.setQuery("", true);
}
//# sourceMappingURL=select.js.map