This PR is the first part of a refactoring aiming to deprecate the hotkey scopes api in favor of the new focus stack api which is more robust. The refactored components in this PR are the dropdowns and the side panel/command menu. - Replaced `useScopedHotkeys` by `useHotkeysOnFocusedElement` for all dropdown components, selectable lists and the command menu - Introduced `focusId` for all dropdowns and created a common hotkey scope `DropdownHotkeyScope` for backward compatibility - Replaced `setHotkeyScopeAndMemorizePreviousScope` occurrences with `usePushFocusItemToFocusStack` and `goBackToPreviousHotkeyScope` with `removeFocusItemFromFocusStack` Note: Test that the shorcuts and arrow key navigation still work properly when interacting with dropdowns and the command menu. Bugs that I have spotted during the QA but which are already present on main: - Icon picker select with arrow keys doesn’t work inside dropdowns - Some dropdowns are not selectable with arrow keys (no selectable list) - Dropdowns in dropdowns don’t reset the hotkey scope correctly when closing - The table click outside is not triggered after closing a table cell and clicking outside of the table
155 lines
5.3 KiB
TypeScript
155 lines
5.3 KiB
TypeScript
import { useRef, useState } from 'react';
|
|
import { Key } from 'ts-key-enum';
|
|
|
|
import { FieldMultiSelectValue } from '@/object-record/record-field/types/FieldMetadata';
|
|
import { DEFAULT_CELL_SCOPE } from '@/object-record/record-table/record-table-cell/hooks/useOpenRecordTableCellV2';
|
|
import { DropdownMenuItemsContainer } from '@/ui/layout/dropdown/components/DropdownMenuItemsContainer';
|
|
import { DropdownMenuSearchInput } from '@/ui/layout/dropdown/components/DropdownMenuSearchInput';
|
|
import { DropdownMenuSeparator } from '@/ui/layout/dropdown/components/DropdownMenuSeparator';
|
|
import { SelectableList } from '@/ui/layout/selectable-list/components/SelectableList';
|
|
|
|
import { DropdownContent } from '@/ui/layout/dropdown/components/DropdownContent';
|
|
import { SelectableListItem } from '@/ui/layout/selectable-list/components/SelectableListItem';
|
|
import { useSelectableList } from '@/ui/layout/selectable-list/hooks/useSelectableList';
|
|
import { selectedItemIdComponentState } from '@/ui/layout/selectable-list/states/selectedItemIdComponentState';
|
|
import { useHotkeysOnFocusedElement } from '@/ui/utilities/hotkey/hooks/useHotkeysOnFocusedElement';
|
|
import { useListenClickOutside } from '@/ui/utilities/pointer-event/hooks/useListenClickOutside';
|
|
import { useRecoilComponentValueV2 } from '@/ui/utilities/state/component-state/hooks/useRecoilComponentValueV2';
|
|
import { isDefined } from 'twenty-shared/utils';
|
|
import { SelectOption } from 'twenty-ui/input';
|
|
import { MenuItemMultiSelectTag } from 'twenty-ui/navigation';
|
|
import { turnIntoEmptyStringIfWhitespacesOnly } from '~/utils/string/turnIntoEmptyStringIfWhitespacesOnly';
|
|
|
|
type MultiSelectInputProps = {
|
|
selectableListComponentInstanceId: string;
|
|
values: FieldMultiSelectValue;
|
|
focusId: string;
|
|
onCancel?: () => void;
|
|
options: SelectOption[];
|
|
onOptionSelected: (value: FieldMultiSelectValue) => void;
|
|
dropdownWidth?: number;
|
|
};
|
|
|
|
export const MultiSelectInput = ({
|
|
selectableListComponentInstanceId,
|
|
values,
|
|
options,
|
|
focusId,
|
|
onCancel,
|
|
onOptionSelected,
|
|
dropdownWidth,
|
|
}: MultiSelectInputProps) => {
|
|
const { resetSelectedItem } = useSelectableList(
|
|
selectableListComponentInstanceId,
|
|
);
|
|
|
|
const selectedItemId = useRecoilComponentValueV2(
|
|
selectedItemIdComponentState,
|
|
selectableListComponentInstanceId,
|
|
);
|
|
const [searchFilter, setSearchFilter] = useState('');
|
|
const containerRef = useRef<HTMLDivElement>(null);
|
|
|
|
const selectedOptions = options.filter((option) =>
|
|
values?.includes(option.value),
|
|
);
|
|
|
|
const filteredOptionsInDropDown = options.filter((option) =>
|
|
option.label.toLowerCase().includes(searchFilter.toLowerCase()),
|
|
);
|
|
|
|
const formatNewSelectedOptions = (value: string) => {
|
|
const selectedOptionsValues = selectedOptions.map(
|
|
(selectedOption) => selectedOption.value,
|
|
);
|
|
if (!selectedOptionsValues.includes(value)) {
|
|
return [value, ...selectedOptionsValues];
|
|
} else {
|
|
return selectedOptionsValues.filter(
|
|
(selectedOptionsValue) => selectedOptionsValue !== value,
|
|
);
|
|
}
|
|
};
|
|
|
|
useHotkeysOnFocusedElement({
|
|
keys: Key.Escape,
|
|
callback: () => {
|
|
onCancel?.();
|
|
resetSelectedItem();
|
|
},
|
|
focusId,
|
|
scope: DEFAULT_CELL_SCOPE.scope,
|
|
dependencies: [onCancel, resetSelectedItem],
|
|
});
|
|
|
|
useListenClickOutside({
|
|
refs: [containerRef],
|
|
callback: (event) => {
|
|
event.stopImmediatePropagation();
|
|
|
|
const weAreNotInAnHTMLInput = !(
|
|
event.target instanceof HTMLInputElement &&
|
|
event.target.tagName === 'INPUT'
|
|
);
|
|
if (weAreNotInAnHTMLInput && isDefined(onCancel)) {
|
|
onCancel();
|
|
}
|
|
resetSelectedItem();
|
|
},
|
|
listenerId: 'MultiSelectFieldInput',
|
|
});
|
|
|
|
const optionIds = filteredOptionsInDropDown.map((option) => option.value);
|
|
|
|
return (
|
|
<SelectableList
|
|
selectableListInstanceId={selectableListComponentInstanceId}
|
|
selectableItemIdArray={optionIds}
|
|
focusId={focusId}
|
|
hotkeyScope={DEFAULT_CELL_SCOPE.scope}
|
|
>
|
|
<DropdownContent
|
|
ref={containerRef}
|
|
selectDisabled
|
|
widthInPixels={dropdownWidth}
|
|
>
|
|
<DropdownMenuSearchInput
|
|
value={searchFilter}
|
|
onChange={(event) =>
|
|
setSearchFilter(
|
|
turnIntoEmptyStringIfWhitespacesOnly(event.currentTarget.value),
|
|
)
|
|
}
|
|
autoFocus
|
|
/>
|
|
<DropdownMenuSeparator />
|
|
<DropdownMenuItemsContainer hasMaxHeight>
|
|
{filteredOptionsInDropDown.map((option) => {
|
|
return (
|
|
<SelectableListItem
|
|
key={option.value}
|
|
itemId={option.value}
|
|
onEnter={() => {
|
|
onOptionSelected(formatNewSelectedOptions(option.value));
|
|
}}
|
|
>
|
|
<MenuItemMultiSelectTag
|
|
key={option.value}
|
|
selected={values?.includes(option.value) || false}
|
|
text={option.label}
|
|
color={option.color ?? 'transparent'}
|
|
Icon={option.Icon ?? undefined}
|
|
onClick={() =>
|
|
onOptionSelected(formatNewSelectedOptions(option.value))
|
|
}
|
|
isKeySelected={selectedItemId === option.value}
|
|
/>
|
|
</SelectableListItem>
|
|
);
|
|
})}
|
|
</DropdownMenuItemsContainer>
|
|
</DropdownContent>
|
|
</SelectableList>
|
|
);
|
|
};
|