Skip to content

The easy-to-use open source Business Intelligence and Embedded Analytics tool that lets everyone work with data :bar_chart:

Improve searchable <Select /> default behavior (#73753)

Oleh K5ac5e447b881
diff --git a/enterprise/frontend/src/metabase-enterprise/whitelabel/components/FontWidget/FontWidget.tsx b/enterprise/frontend/src/metabase-enterprise/whitelabel/components/FontWidget/FontWidget.tsx
index 87e96531f93..3b05338c079 100644
--- a/enterprise/frontend/src/metabase-enterprise/whitelabel/components/FontWidget/FontWidget.tsx
+++ b/enterprise/frontend/src/metabase-enterprise/whitelabel/components/FontWidget/FontWidget.tsx
@@ -57,6 +57,7 @@ export const FontWidget = () => {
value={fontValue}
name="application-font"
inputType="select"
+ searchable
onChange={(newValue) => handleChange(newValue as string)}
options={fontOptions}
/>
diff --git a/frontend/src/metabase/account/profile/components/UserProfileForm/UserProfileForm.tsx b/frontend/src/metabase/account/profile/components/UserProfileForm/UserProfileForm.tsx
index 8eeb76a188d..1868f99015c 100644
--- a/frontend/src/metabase/account/profile/components/UserProfileForm/UserProfileForm.tsx
+++ b/frontend/src/metabase/account/profile/components/UserProfileForm/UserProfileForm.tsx
@@ -107,6 +107,7 @@ const UserProfileForm = ({
name="locale"
label={t`Language`}
data={localeOptions}
+ searchable
description={
<CommunityLocalizationNotice isAdminView={false} />
}
diff --git a/frontend/src/metabase/admin/settings/components/SettingsPages/LocalizationSettingsPage.tsx b/frontend/src/metabase/admin/settings/components/SettingsPages/LocalizationSettingsPage.tsx
index 00407639cff..f840ca98780 100644
--- a/frontend/src/metabase/admin/settings/components/SettingsPages/LocalizationSettingsPage.tsx
+++ b/frontend/src/metabase/admin/settings/components/SettingsPages/LocalizationSettingsPage.tsx
@@ -25,6 +25,7 @@ export function LocalizationSettingsPage() {
<AdminSettingInput
name="site-locale"
title={t`Instance language`}
+ searchable
options={_.sortBy(availableLocales || [], ([, label]) => label).map(
([code, label]) => ({ label, value: code }),
)}
diff --git a/frontend/src/metabase/admin/settings/components/widgets/FormattingWidget.tsx b/frontend/src/metabase/admin/settings/components/widgets/FormattingWidget.tsx
index 128d908ceeb..e78052d25eb 100644
--- a/frontend/src/metabase/admin/settings/components/widgets/FormattingWidget.tsx
+++ b/frontend/src/metabase/admin/settings/components/widgets/FormattingWidget.tsx
@@ -184,6 +184,7 @@ export function FormattingWidget() {
label={t`Unit of currency`}
value={currency}
inputType="select"
+ searchable
options={currencyOptions}
onChange={(newValue) =>
handleChange({
@@ -225,6 +226,7 @@ function FormattingInput({
onChange,
options,
inputType,
+ searchable,
}: {
id: string;
label: string;
@@ -232,6 +234,7 @@ function FormattingInput({
onChange: (newValue: string | boolean | number) => void;
options?: { label: string; value: string }[];
inputType: "boolean" | "select" | "radio";
+ searchable?: boolean;
}) {
const [localValue, setLocalValue] = useState(value);
@@ -255,6 +258,7 @@ function FormattingInput({
value={localValue}
onChange={handleChange}
data={options ?? []}
+ searchable={searchable}
/>
)}
{inputType === "boolean" && (
diff --git a/frontend/src/metabase/dashboard/components/ParameterSettings/MoveParameterMenu/MoveParameterMenu.module.css b/frontend/src/metabase/dashboard/components/ParameterSettings/MoveParameterMenu/MoveParameterMenu.module.css
index d71d21de4cc..00cb5d431d8 100644
--- a/frontend/src/metabase/dashboard/components/ParameterSettings/MoveParameterMenu/MoveParameterMenu.module.css
+++ b/frontend/src/metabase/dashboard/components/ParameterSettings/MoveParameterMenu/MoveParameterMenu.module.css
@@ -2,11 +2,7 @@
text-align: center;
border-radius: var(--mantine-radius-sm);
cursor: pointer;
-
- &::placeholder {
- color: var(--mb-color-text-primary);
- font-weight: 700;
- }
+ color: transparent;
&:hover {
background-color: var(--mb-color-background-hover);
@@ -17,6 +13,21 @@
}
}
+.CollapsedMoveParameterMenuInputWrapper {
+ position: relative;
+
+ &::after {
+ content: attr(data-label);
+ color: var(--mb-color-text-primary);
+ font-weight: 700;
+ position: absolute;
+ top: 50%;
+ left: 50%;
+ transform: translate(-50%, -50%);
+ pointer-events: none;
+ }
+}
+
.MoveParameterMenuOptionIcon {
color: var(--mb-color-text-tertiary);
}
diff --git a/frontend/src/metabase/dashboard/components/ParameterSettings/MoveParameterMenu/MoveParameterMenu.tsx b/frontend/src/metabase/dashboard/components/ParameterSettings/MoveParameterMenu/MoveParameterMenu.tsx
index 6f0edca6e3a..4370b1f71c4 100644
--- a/frontend/src/metabase/dashboard/components/ParameterSettings/MoveParameterMenu/MoveParameterMenu.tsx
+++ b/frontend/src/metabase/dashboard/components/ParameterSettings/MoveParameterMenu/MoveParameterMenu.tsx
@@ -95,12 +95,10 @@ export function MoveParameterMenu({ parameterId }: MoveParameterMenuProps) {
[dashcardMap],
);
- const value = useMemo(() => {
- if (!isOpen) {
- return;
- }
- return parameterDashcard ? String(parameterDashcard?.id) : TOP_NAV_VALUE;
- }, [isOpen, parameterDashcard]);
+ const value = useMemo(
+ () => (parameterDashcard ? String(parameterDashcard?.id) : TOP_NAV_VALUE),
+ [parameterDashcard],
+ );
const options = useMemo(() => {
const rootGroup = {
@@ -140,6 +138,12 @@ export function MoveParameterMenu({ parameterId }: MoveParameterMenuProps) {
// Hides the chevron-down icon on the right to make it look like a button
section: !isOpen ? CS.hidden : undefined,
}}
+ wrapperProps={{
+ className: !isOpen
+ ? S.CollapsedMoveParameterMenuInputWrapper
+ : undefined,
+ "data-label": t`Move filter`,
+ }}
placeholder={t`Move filter`}
data={options}
renderOption={renderOption}
diff --git a/frontend/src/metabase/metadata/components/CurrencyPicker/CurrencyPicker.tsx b/frontend/src/metabase/metadata/components/CurrencyPicker/CurrencyPicker.tsx
index 820ce193631..6bc912d2470 100644
--- a/frontend/src/metabase/metadata/components/CurrencyPicker/CurrencyPicker.tsx
+++ b/frontend/src/metabase/metadata/components/CurrencyPicker/CurrencyPicker.tsx
@@ -1,4 +1,3 @@
-import type { FocusEvent } from "react";
import { t } from "ttag";
import {
@@ -26,14 +25,8 @@ export const CurrencyPicker = ({
comboboxProps,
value,
onChange,
- onFocus,
...props
}: Props) => {
- const handleFocus = (event: FocusEvent<HTMLInputElement>) => {
- event.target.select();
- onFocus?.(event);
- };
-
return (
<Select
comboboxProps={{
@@ -83,7 +76,6 @@ export const CurrencyPicker = ({
searchable
value={value}
onChange={(value) => onChange(value)}
- onFocus={handleFocus}
{...props}
/>
);
diff --git a/frontend/src/metabase/metadata/components/EntityTypeInput.tsx b/frontend/src/metabase/metadata/components/EntityTypeInput.tsx
index ec92e4afc56..090b68818a4 100644
--- a/frontend/src/metabase/metadata/components/EntityTypeInput.tsx
+++ b/frontend/src/metabase/metadata/components/EntityTypeInput.tsx
@@ -1,4 +1,3 @@
-import type { FocusEvent } from "react";
import { t } from "ttag";
import { getEntityIcon } from "metabase/detail-view/utils";
@@ -14,14 +13,8 @@ export const EntityTypeInput = ({
comboboxProps,
value,
onChange,
- onFocus,
...props
}: Props) => {
- const handleFocus = (event: FocusEvent<HTMLInputElement>) => {
- event.target.select();
- onFocus?.(event);
- };
-
const entities = [
{ value: "entity/GenericTable", label: t`Generic` },
{ value: "entity/UserTable", label: t`Person` },
@@ -62,7 +55,6 @@ export const EntityTypeInput = ({
placeholder={t`Select entity type`}
value={value}
onChange={(value) => onChange(value)}
- onFocus={handleFocus}
{...props}
/>
);
diff --git a/frontend/src/metabase/metadata/components/FkTargetPicker/FkTargetPicker.tsx b/frontend/src/metabase/metadata/components/FkTargetPicker/FkTargetPicker.tsx
index ae370dc7a66..33086a6c498 100644
--- a/frontend/src/metabase/metadata/components/FkTargetPicker/FkTargetPicker.tsx
+++ b/frontend/src/metabase/metadata/components/FkTargetPicker/FkTargetPicker.tsx
@@ -1,4 +1,4 @@
-import { type FocusEvent, useMemo } from "react";
+import { useMemo } from "react";
import { t } from "ttag";
import {
@@ -32,7 +32,6 @@ export const FkTargetPicker = ({
idFields,
value,
onChange,
- onFocus,
...props
}: Props) => {
const { comparableIdFields, hasIdFields, data, optionsByFieldId } =
@@ -76,11 +75,6 @@ export const FkTargetPicker = ({
}
};
- const handleFocus = (event: FocusEvent<HTMLInputElement>) => {
- event.target.select();
- onFocus?.(event);
- };
-
return (
<Select
aria-label={t`Foreign key target`}
@@ -148,7 +142,6 @@ export const FkTargetPicker = ({
searchable
value={stringifyValue(value)}
onChange={handleChange}
- onFocus={handleFocus}
{...props}
/>
);
diff --git a/frontend/src/metabase/metadata/components/LayerInput.tsx b/frontend/src/metabase/metadata/components/LayerInput.tsx
index 21c6ac9a4eb..7ee66129c09 100644
--- a/frontend/src/metabase/metadata/components/LayerInput.tsx
+++ b/frontend/src/metabase/metadata/components/LayerInput.tsx
@@ -1,4 +1,3 @@
-import type { FocusEvent } from "react";
import { t } from "ttag";
import { Group, Icon, Select, SelectItem, type SelectProps } from "metabase/ui";
@@ -15,14 +14,8 @@ export const LayerInput = ({
comboboxProps,
value,
onChange,
- onFocus,
...props
}: Props) => {
- const handleFocus = (event: FocusEvent<HTMLInputElement>) => {
- event.target.select();
- onFocus?.(event);
- };
-
return (
<Select
comboboxProps={{
@@ -57,7 +50,6 @@ export const LayerInput = ({
placeholder={t`Select visibility layer`}
value={value}
onChange={(value) => onChange(value)}
- onFocus={handleFocus}
{...props}
/>
);
diff --git a/frontend/src/metabase/metadata/components/SemanticTypePicker/SemanticTypePicker.tsx b/frontend/src/metabase/metadata/components/SemanticTypePicker/SemanticTypePicker.tsx
index f9701060023..4bf80345f65 100644
--- a/frontend/src/metabase/metadata/components/SemanticTypePicker/SemanticTypePicker.tsx
+++ b/frontend/src/metabase/metadata/components/SemanticTypePicker/SemanticTypePicker.tsx
@@ -1,4 +1,4 @@
-import { type FocusEvent, useMemo } from "react";
+import { useMemo } from "react";
import { t } from "ttag";
import _ from "underscore";
@@ -21,7 +21,6 @@ export const SemanticTypePicker = ({
field,
value,
onChange,
- onFocus,
...props
}: Props) => {
const data = useMemo(() => getData({ field, value }), [field, value]);
@@ -31,11 +30,6 @@ export const SemanticTypePicker = ({
onChange(parsedValue);
};
- const handleFocus = (event: FocusEvent<HTMLInputElement>) => {
- event.target.select();
- onFocus?.(event);
- };
-
return (
<Select
comboboxProps={{
@@ -54,7 +48,6 @@ export const SemanticTypePicker = ({
searchable
value={stringifyValue(value)}
onChange={handleChange}
- onFocus={handleFocus}
{...props}
/>
);
diff --git a/frontend/src/metabase/metadata/components/UserInput.tsx b/frontend/src/metabase/metadata/components/UserInput.tsx
index e2140f252c4..7c6b885c7d7 100644
--- a/frontend/src/metabase/metadata/components/UserInput.tsx
+++ b/frontend/src/metabase/metadata/components/UserInput.tsx
@@ -1,4 +1,4 @@
-import { type FocusEvent, useMemo, useState } from "react";
+import { useMemo, useState } from "react";
import { t } from "ttag";
import { useListUsersQuery } from "metabase/api";
@@ -19,7 +19,6 @@ export const UserInput = ({
email,
userId,
onEmailChange,
- onFocus,
onUserIdChange,
unknownUserLabel = t`Unspecified`,
...props
@@ -40,11 +39,6 @@ export const UserInput = ({
return users.find((user) => user.id === userId)?.common_name;
}, [users, userId]);
- const handleFocus = (event: FocusEvent<HTMLInputElement>) => {
- event.target.select();
- onFocus?.(event);
- };
-
const handleChange = (value: string | null) => {
if (value == null) {
onUserIdChange(null);
@@ -111,7 +105,6 @@ export const UserInput = ({
}}
value={email ? email : userId ? String(userId) : null}
onChange={handleChange}
- onFocus={handleFocus}
onSearchChange={setSearch}
{...props}
/>
diff --git a/frontend/src/metabase/ui/components/inputs/Select/Select.tsx b/frontend/src/metabase/ui/components/inputs/Select/Select.tsx
index 9311aab0b73..ca4d3df984e 100644
--- a/frontend/src/metabase/ui/components/inputs/Select/Select.tsx
+++ b/frontend/src/metabase/ui/components/inputs/Select/Select.tsx
@@ -4,7 +4,8 @@ import type {
SelectProps as MantineSelectProps,
} from "@mantine/core";
import { Select as MantineSelect } from "@mantine/core";
-import { type Ref, forwardRef } from "react";
+import mergeRefs from "merge-refs";
+import { type Ref, forwardRef, useCallback, useMemo, useRef } from "react";
import type { IconName } from "../../icons";
@@ -34,18 +35,38 @@ export interface SelectProps<Value extends string | null = string> extends Omit<
onChange?: (newValue: Value) => void;
}
-function _Select<Value extends string | null>(
+function SelectWrapper<Value extends string | null>(
props: SelectProps<Value>,
ref: Ref<HTMLElement>,
) {
+ const { onDropdownOpen, searchable } = props;
+ const inputRef = useRef<HTMLInputElement>(null);
+ const combinedRef = useMemo(() => mergeRefs(ref, inputRef), [ref]);
+ const handleDropdownOpen = useCallback(() => {
+ if (searchable) {
+ inputRef.current?.select();
+ }
+ onDropdownOpen?.();
+ }, [searchable, onDropdownOpen]);
+
return (
- // @ts-expect-error -- our tighter types are better
- <MantineSelect {...props} ref={ref} />
+ <MantineSelect
+ {...props}
+ // @ts-expect-error -- our tighter types are better
+ ref={combinedRef}
+ // A bit confusing prop name but it actually means "on change of search input", not Select's value
+ selectFirstOptionOnChange={
+ props.selectFirstOptionOnChange ?? props.searchable
+ }
+ onDropdownOpen={handleDropdownOpen}
+ />
);
}
// forwardRef is hard to type with generics
// see https://stackoverflow.com/questions/58469229/react-with-typescript-generics-while-using-react-forwardref
-export const Select = forwardRef(_Select) as <Value extends string | null>(
+export const Select = forwardRef(SelectWrapper) as <
+ Value extends string | null,
+>(
props: SelectProps<Value> & { ref?: Ref<HTMLElement> },
) => React.ReactNode;
diff --git a/frontend/src/metabase/ui/components/inputs/Select/Select.unit.spec.tsx b/frontend/src/metabase/ui/components/inputs/Select/Select.unit.spec.tsx
new file mode 100644
index 00000000000..afcba5c0ca3
--- /dev/null
+++ b/frontend/src/metabase/ui/components/inputs/Select/Select.unit.spec.tsx
@@ -0,0 +1,92 @@
+import userEvent from "@testing-library/user-event";
+
+import { render, screen } from "__support__/ui";
+import { Select, type SelectProps } from "metabase/ui";
+
+const DATA = [
+ { value: "apple", label: "Apple" },
+ { value: "apricot", label: "Apricot" },
+ { value: "banana", label: "Banana" },
+];
+
+type SetupOpts = Omit<Partial<SelectProps>, "onChange" | "onDropdownOpen">;
+
+function setup({ data = DATA, ...props }: SetupOpts = {}) {
+ const onChange = jest.fn();
+ const onDropdownOpen = jest.fn();
+
+ render(
+ <Select
+ label="Fruit"
+ data={data}
+ onChange={onChange}
+ onDropdownOpen={onDropdownOpen}
+ {...props}
+ />,
+ );
+
+ const input = screen.getByLabelText<HTMLInputElement>("Fruit");
+
+ return { input, onChange, onDropdownOpen };
+}
+
+describe("Select", () => {
+ describe("searchable", () => {
+ it("should select existing input text when the dropdown opens, so typing replaces it", async () => {
+ const { input } = setup({ searchable: true, defaultValue: "apple" });
+ expect(input).toHaveValue("Apple");
+
+ await userEvent.click(input);
+
+ expect(input.selectionStart).toBe(0);
+ expect(input.selectionEnd).toBe("Apple".length);
+
+ await userEvent.keyboard("ban");
+ expect(input).toHaveValue("ban");
+ });
+
+ it("should auto-highlight the first matching option so Enter selects it", async () => {
+ const { input, onChange } = setup({ searchable: true });
+
+ await userEvent.click(input);
+ await userEvent.keyboard("ap");
+ await userEvent.keyboard("{Enter}");
+
+ expect(onChange).toHaveBeenCalledWith("apple", expect.anything());
+ });
+
+ it("should still call a user-provided onDropdownOpen handler", async () => {
+ const { input, onDropdownOpen } = setup({ searchable: true });
+
+ await userEvent.click(input);
+
+ expect(onDropdownOpen).toHaveBeenCalledTimes(1);
+ });
+
+ it("should respect an explicit selectFirstOptionOnChange={false} override", async () => {
+ const { input, onChange } = setup({
+ searchable: true,
+ selectFirstOptionOnChange: false,
+ });
+
+ await userEvent.click(input);
+ await userEvent.keyboard("ap");
+ await userEvent.keyboard("{Enter}");
+
+ expect(onChange).not.toHaveBeenCalled();
+ });
+ });
+
+ describe("non-searchable", () => {
+ it("should not pre-select input text on open and should still open the dropdown", async () => {
+ const { input } = setup({ defaultValue: "apple" });
+
+ await userEvent.click(input);
+
+ expect(
+ screen.getByRole("option", { name: "Banana" }),
+ ).toBeInTheDocument();
+ expect(input.selectionStart).toBe(input.selectionEnd);
+ });
+ });
+});