Skip to content

combobox: fix controlled value change opening combobox #1

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
pablo-abc wants to merge 1 commit into
base: develop
Choose a base branch
from
Open

combobox: fix controlled value change opening combobox #1

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
52 changes: 20 additions & 32 deletions packages/combobox/src/index.tsx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -292,6 +292,9 @@ export const Combobox = React.forwardRef(function Combobox(

const persistSelectionRef = React.useRef(false);

// We keep a ref to know if the user has focus in <ComboboxInput />
const isFocusedRef = React.useRef(false);

const defaultData: StateData = {
// The value the user has typed. We derive this also when the developer is
// controlling the value of ComboboxInput.
Expand Down Expand Up @@ -327,6 +330,7 @@ export const Combobox = React.forwardRef(function Combobox(
popoverRef,
state,
transition,
isFocusedRef,
};

useCheckStyles("combobox");
Expand Down Expand Up @@ -426,13 +430,6 @@ export const ComboboxInput = React.forwardRef(function ComboboxInput(
},
forwardedRef
) {
// https://github.com/reach/reach-ui/issues/464
let { current: initialControlledValue } = React.useRef(controlledValue);
let controlledValueChangedRef = React.useRef(false);
useUpdateEffect(() => {
controlledValueChangedRef.current = true;
}, [controlledValue]);

let {
data: { navigationValue, value, lastEventType },
inputRef,
Expand All @@ -445,6 +442,9 @@ export const ComboboxInput = React.forwardRef(function ComboboxInput(
ariaLabel,
ariaLabelledby,
persistSelectionRef,
// https://github.com/reach/reach-ui/issues/464
// https://github.com/reach/reach-ui/issues/755
isFocusedRef,
} = React.useContext(ComboboxContext);

let ref = useComposedRefs(inputRef, forwardedRef);
Expand All @@ -470,16 +470,13 @@ export const ComboboxInput = React.forwardRef(function ComboboxInput(
(value: ComboboxValue) => {
if (value.trim() === "") {
transition(CLEAR);
} else if (
value === initialControlledValue &&
!controlledValueChangedRef.current
) {
} else if (!isFocusedRef.current) {
transition(INITIAL_CHANGE, { value });
} else {
transition(CHANGE, { value });
}
},
[initialControlledValue, transition]
[transition, isFocusedRef]
);

React.useEffect(() => {
Expand Down Expand Up @@ -507,6 +504,7 @@ export const ComboboxInput = React.forwardRef(function ComboboxInput(
}

function handleFocus() {
isFocusedRef.current = true;
if (selectOnClick) {
selectOnClickRef.current = true;
}
Expand Down Expand Up @@ -626,9 +624,8 @@ export const ComboboxPopover = React.forwardRef(function ComboboxPopover(
},
forwardedRef
) {
const { popoverRef, inputRef, isExpanded, state } = React.useContext(
ComboboxContext
);
const { popoverRef, inputRef, isExpanded, state } =
React.useContext(ComboboxContext);
const ref = useComposedRefs(popoverRef, forwardedRef);
const handleKeyDown = useKeyDown();
const handleBlur = useBlur();
Expand Down Expand Up @@ -912,13 +909,8 @@ export const ComboboxButton = React.forwardRef(function ComboboxButton(
{ as: Comp = "button", onClick, onKeyDown, ...props },
forwardedRef
) {
const {
transition,
state,
buttonRef,
listboxId,
isExpanded,
} = React.useContext(ComboboxContext);
const { transition, state, buttonRef, listboxId, isExpanded } =
React.useContext(ComboboxContext);
const ref = useComposedRefs(buttonRef, forwardedRef);

const handleKeyDown = useKeyDown();
Expand Down Expand Up @@ -1130,19 +1122,15 @@ function useKeyDown() {
}

function useBlur() {
const {
state,
transition,
popoverRef,
inputRef,
buttonRef,
} = React.useContext(ComboboxContext);
const { state, transition, popoverRef, inputRef, buttonRef, isFocusedRef } =
React.useContext(ComboboxContext);

return function handleBlur(event: React.FocusEvent) {
let popover = popoverRef.current;
let input = inputRef.current;
let button = buttonRef.current;
let activeElement = event.relatedTarget as Node;
isFocusedRef.current = false;

// we on want to close only if focus propss outside the combobox
if (activeElement !== input && activeElement !== button && popover) {
Expand Down Expand Up @@ -1249,9 +1237,8 @@ export function escapeRegexp(str: string) {
* @see Docs https://reach.tech/combobox#usecomboboxcontext
*/
export function useComboboxContext(): ComboboxContextValue {
let { isExpanded, comboboxId, data, state } = React.useContext(
ComboboxContext
);
let { isExpanded, comboboxId, data, state } =
React.useContext(ComboboxContext);
let { navigationValue } = data;
return React.useMemo(
() => ({
Expand Down Expand Up @@ -1320,6 +1307,7 @@ interface InternalComboboxContextValue {
popoverRef: React.MutableRefObject<HTMLElement | undefined>;
state: State;
transition: Transition;
isFocusedRef: React.MutableRefObject<boolean>;
}

type Transition = (event: MachineEventType, payload?: any) => any;
Expand Down