[useAutocomplete] Improve isOptionEqualToValue value argument type by silviuaavram · Pull Request #47801 · mui/material-ui

silviuaavram · 2026-02-17T14:50:56Z

I have followed (at least) the PR section of the contributing guide.

It's this PR #37291 from @newsiberian but the files have changed since then so created a new PR with the changes on the updated file structure. Same changes, but:

docs/data/base/components/autocomplete/AutocompleteIntroduction/tailwind/index.js
- removed, not found anymore.
docs/pages/base-ui/api/use-autocomplete.json
- removed, not found anymore
packages/mui-base/src/useAutocomplete/useAutocomplete.d.ts
- changed to packages/mui-material/src/useAutocomplete/useAutocomplete.d.ts

Fixes #38322

mui-bot · 2026-02-17T14:51:55Z

Netlify deploy preview

docs/data/material/migration/upgrade-to-v9/upgrade-to-v9.md

Bundle size report

Bundle	Parsed size	Gzip size
@mui/material	0B^(0.00%)	0B^(0.00%)
@mui/lab	0B^(0.00%)	0B^(0.00%)
@mui/system	0B^(0.00%)	0B^(0.00%)
@mui/utils	0B^(0.00%)	0B^(0.00%)

Details of bundle changes

Generated by 🚫 dangerJS against 62319d5

Copilot

Pull request overview

This PR improves the TypeScript type definitions for the isOptionEqualToValue and getOptionLabel props in the Autocomplete component to correctly reflect that in freeSolo mode, the value parameter can be either the option type or a string. This addresses a type safety issue where developers using freeSolo mode were not getting accurate type information.

Changes:

Introduced a new AutocompleteValueOrFreeSoloValueMapping type helper that resolves to Value | string when FreeSolo is true, otherwise just Value
Updated type definitions and documentation for getOptionLabel and isOptionEqualToValue to use this new type helper
Added demo examples showing proper usage of isOptionEqualToValue with freeSolo mode

Reviewed changes

Copilot reviewed 7 out of 8 changed files in this pull request and generated 3 comments.

Show a summary per file

File	Description
packages/mui-material/src/useAutocomplete/useAutocomplete.d.ts	Added new type helper and updated type definitions for getOptionLabel and isOptionEqualToValue
packages/mui-material/src/Autocomplete/Autocomplete.js	Updated JSDoc comments to reflect that parameters can be Value or string
packages/mui-joy/src/Autocomplete/AutocompleteProps.ts	Updated import to use new type helper and applied it to getOptionLabel
packages/mui-joy/src/Autocomplete/Autocomplete.tsx	Updated JSDoc comments to reflect that parameters can be Value or string
docs/pages/material-ui/api/autocomplete.json	Updated API documentation signatures to show Value or string types
docs/pages/joy-ui/api/autocomplete.json	Updated API documentation signatures to show Value or string types
docs/data/material/components/autocomplete/FreeSolo.tsx	Added example demonstrating isOptionEqualToValue with freeSolo mode
docs/data/material/components/autocomplete/FreeSolo.js	Added example demonstrating isOptionEqualToValue with freeSolo mode

💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.

Copilot · 2026-02-17T14:56:58Z

packages/mui-joy/src/Autocomplete/AutocompleteProps.ts

-  AutocompleteFreeSoloValueMapping,
  AutocompleteInputChangeReason,
  AutocompleteValue,
+  AutocompleteValueOrFreeSoloValueMapping,


This import references AutocompleteValueOrFreeSoloValueMapping from the external @mui/base package. Please verify that this type has been added to @mui/base (version 7.0.0-beta.4 or the version being used) before merging this PR. If this type doesn't exist in the current version of @mui/base, this will cause a TypeScript compilation error.

docs/data/material/components/autocomplete/FreeSolo.tsx

docs/data/material/components/autocomplete/FreeSolo.js

siriwatknp

same here, need to add to upgrading guide

packages/mui-joy/src/Autocomplete/AutocompleteProps.ts

packages/mui-material/src/useAutocomplete/useAutocomplete.d.ts

siriwatknp

When it's related to types, I recommend adding .spec.tsx to confirm the behavior.
In this case, let's add a fail case (missing typeof check) and a success case (similar to the demo but can be shorter).

Take a look at packages/mui-material/src/Autocomplete/Autocomplete.spec.tsx

siriwatknp · 2026-02-20T10:50:15Z

packages/mui-material/src/Autocomplete/Autocomplete.spec.tsx

+
+    return option === value;
+  }}
+/>;


Suggested change

/>;

/>;

<Autocomplete

id="free-solo-demo3"

freeSolo

options={top100Films} // array of object

renderInput={() => null}

// @ts-expect-error option could be a string

getOptionLabel={(option) => option.title}

isOptionEqualToValue={(option, value) => {

// @ts-expect-error option could be a string

return option.title === value?.title;

}}

/>

If my understanding is correct, this should be added to ensure typesafety right?

siriwatknp

👍 Please check my last comment related to the spec.

ZeeshanTamboli · 2026-02-20T11:01:54Z

docs/data/material/components/autocomplete/FreeSolo.tsx

+          if (typeof value === 'string') {
+            return option.title === value;
+          }
+          return option.title === value?.title;


Is this optional or no?

Suggested change

return option.title === value?.title;

return option.title === value.title;

silviuaavram self-assigned this Feb 17, 2026

Copilot AI review requested due to automatic review settings February 17, 2026 14:50

silviuaavram added type: bug It doesn't behave as expected. breaking change Introduces changes that are not backward compatible. typescript scope: autocomplete Changes related to the autocomplete. This includes ComboBox. v9.x labels Feb 17, 2026

Copilot started reviewing on behalf of silviuaavram February 17, 2026 14:51 View session

silviuaavram mentioned this pull request Feb 17, 2026

[useAutocomplete] Improve isOptionEqualToValue value argument type #37291

Closed

1 task

Copilot AI reviewed Feb 17, 2026

View reviewed changes

siriwatknp requested changes Feb 19, 2026

View reviewed changes

github-actions bot added the PR: out-of-date The pull request has merge conflicts and can't be merged. label Feb 19, 2026

silviuaavram force-pushed the fix/autocomplete-free-solo-prop-type branch from d5ffd74 to 0a76519 Compare February 19, 2026 11:03

github-actions bot removed the PR: out-of-date The pull request has merge conflicts and can't be merged. label Feb 19, 2026

ZeeshanTamboli reviewed Feb 19, 2026

View reviewed changes

packages/mui-joy/src/Autocomplete/AutocompleteProps.ts Outdated Show resolved Hide resolved

packages/mui-material/src/useAutocomplete/useAutocomplete.d.ts Show resolved Hide resolved

packages/mui-material/src/useAutocomplete/useAutocomplete.d.ts Show resolved Hide resolved

silviuaavram force-pushed the fix/autocomplete-free-solo-prop-type branch from 108071c to 5ef4df5 Compare February 19, 2026 14:39

siriwatknp requested changes Feb 20, 2026

View reviewed changes

github-actions bot added the PR: out-of-date The pull request has merge conflicts and can't be merged. label Feb 20, 2026

silviuaavram added 3 commits February 20, 2026 11:15

[useAutocomplete] Improve isOptionEqualToValue value argument type

df26e9e

change the type in AutocompleteOwnerState

a66c577

add types tests

62319d5

silviuaavram force-pushed the fix/autocomplete-free-solo-prop-type branch from 5ef4df5 to 62319d5 Compare February 20, 2026 09:15

github-actions bot removed the PR: out-of-date The pull request has merge conflicts and can't be merged. label Feb 20, 2026

siriwatknp reviewed Feb 20, 2026

View reviewed changes

siriwatknp approved these changes Feb 20, 2026

View reviewed changes

ZeeshanTamboli reviewed Feb 20, 2026

View reviewed changes

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Uh oh!

[useAutocomplete] Improve isOptionEqualToValue value argument type#47801

[useAutocomplete] Improve isOptionEqualToValue value argument type#47801
silviuaavram wants to merge 3 commits intomui:masterfrom
silviuaavram:fix/autocomplete-free-solo-prop-type

silviuaavram commented Feb 17, 2026 •

edited

Loading

Uh oh!

mui-bot commented Feb 17, 2026 •

edited

Loading

Uh oh!

Copilot AI left a comment

Uh oh!

Copilot AI Feb 17, 2026

Uh oh!

Uh oh!

Uh oh!

siriwatknp left a comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

siriwatknp left a comment

Uh oh!

siriwatknp Feb 20, 2026 •

edited

Loading

Uh oh!

siriwatknp left a comment

Uh oh!

ZeeshanTamboli Feb 20, 2026

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

4 participants

Comments

-/>;
+/>;
+<Autocomplete
+  id="free-solo-demo3"
+  freeSolo
+  options={top100Films} // array of object
+  renderInput={() => null}
+  // @ts-expect-error option could be a string
+  getOptionLabel={(option) => option.title}
+  isOptionEqualToValue={(option, value) => {
+    // @ts-expect-error option could be a string
+    return option.title === value?.title;
+  }}
+/>

	return option.title === value?.title;
	return option.title === value.title;

Uh oh!

Conversation

silviuaavram commented Feb 17, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

mui-bot commented Feb 17, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Netlify deploy preview

Bundle size report

Uh oh!

Copilot AI left a comment

Choose a reason for hiding this comment

Pull request overview

Reviewed changes

Uh oh!

Copilot AI Feb 17, 2026

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

siriwatknp left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

siriwatknp left a comment

Choose a reason for hiding this comment

Uh oh!

siriwatknp Feb 20, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

siriwatknp left a comment

Choose a reason for hiding this comment

Uh oh!

ZeeshanTamboli Feb 20, 2026

Choose a reason for hiding this comment

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

4 participants

Comments

silviuaavram commented Feb 17, 2026 •

edited

Loading

mui-bot commented Feb 17, 2026 •

edited

Loading

siriwatknp Feb 20, 2026 •

edited

Loading