# Modal API Refactoring This PR refactors the modal system to use an imperative approach for setting hotkey scopes, addressing race conditions that occurred with the previous effect-based implementation. Fixes #11986 Closes #12087 ## Key Changes: - **New Modal API**: Introduced a `useModal` hook with `openModal`, `closeModal`, and `toggleModal` functions, similar to the existing dropdown API - **Modal Identification**: Added a `modalId` prop to uniquely identify modals - **State Management**: Introduced `isModalOpenedComponentState` and removed individual boolean state atoms (like `isRemoveSortingModalOpenState`) - **Modal Constants**: Added consistent modal ID constants (e.g., `FavoriteFolderDeleteModalId`, `RecordIndexRemoveSortingModalId`) for better maintainability - **Mount Effects**: Created mount effect components (like `AuthModalMountEffect`) to handle initial modal opening where needed ## Implementation Details: - Modified `Modal` and `ConfirmationModal` components to accept the new `modalId` prop - Added a component-state-based approach using `ModalComponentInstanceContext` to track modal state - Introduced imperative modal handlers that properly manage hotkey scopes - Components like `ActionModal` and `AttachmentList` now use the new `useModal` hook for better control over modal state ## Benefits: - **Race Condition Prevention**: Hotkey scopes are now set imperatively, eliminating race conditions - **Consistent API**: Modal and dropdown now share similar patterns, improving developer experience ## Tests to do before merging: 1. Action Modals (Modal triggered by an action, for example the delete action) 2. Auth Modal (`AuthModal.tsx` and `AuthModalMountEffect.tsx`) - Test that auth modal opens automatically on mount - Verify authentication flow works properly 3. Email Verification Sent Modal (in `SignInUp.tsx`) - Verify this modal displays correctly 4. Attachment Preview Modal (in `AttachmentList.tsx`) - Test opening preview modal by clicking on attachments - Verify close, download functionality works - Test modal navigation and interactions 5. Favorite Folder Delete Modal (`CurrentWorkspaceMemberFavorites.tsx`) - Test deletion confirmation flow - Check that modal opens when attempting to delete folders with favorites 6. Record Board Remove Sorting Modal (`RecordBoard.tsx` using `RecordIndexRemoveSortingModalId`) - Test that modal appears when trying to drag records with sorting enabled - Verify sorting removal works correctly 7. Record Group Reorder Confirmation Modal (`RecordGroupReorderConfirmationModal.tsx`) - Test group reordering with sorting enabled - Verify confirmation modal properly handles sorting removal 8. Confirmation Modal (base component used by several modals) - Test all variants with different confirmation options For each modal, verify: - Opening/closing behavior - Hotkey support (Esc to close, Enter to confirm where applicable) - Click outside behavior - Proper z-index stacking - Any modal-specific functionality
112 lines
3.6 KiB
TypeScript
112 lines
3.6 KiB
TypeScript
import { ConnectedAccount } from '@/accounts/types/ConnectedAccount';
|
|
import { CoreObjectNameSingular } from '@/object-metadata/types/CoreObjectNameSingular';
|
|
import { useDestroyOneRecord } from '@/object-record/hooks/useDestroyOneRecord';
|
|
import { useTriggerApisOAuth } from '@/settings/accounts/hooks/useTriggerApiOAuth';
|
|
import { SettingsPath } from '@/types/SettingsPath';
|
|
import { Dropdown } from '@/ui/layout/dropdown/components/Dropdown';
|
|
import { DropdownMenuItemsContainer } from '@/ui/layout/dropdown/components/DropdownMenuItemsContainer';
|
|
import { useDropdown } from '@/ui/layout/dropdown/hooks/useDropdown';
|
|
import { ConfirmationModal } from '@/ui/layout/modal/components/ConfirmationModal';
|
|
import { useModal } from '@/ui/layout/modal/hooks/useModal';
|
|
import { Trans, useLingui } from '@lingui/react/macro';
|
|
import {
|
|
IconCalendarEvent,
|
|
IconDotsVertical,
|
|
IconMail,
|
|
IconRefresh,
|
|
IconTrash,
|
|
} from 'twenty-ui/display';
|
|
import { LightIconButton } from 'twenty-ui/input';
|
|
import { MenuItem } from 'twenty-ui/navigation';
|
|
import { useNavigateSettings } from '~/hooks/useNavigateSettings';
|
|
|
|
type SettingsAccountsRowDropdownMenuProps = {
|
|
account: ConnectedAccount;
|
|
};
|
|
|
|
const DELETE_ACCOUNT_MODAL_ID = 'delete-account-modal';
|
|
|
|
export const SettingsAccountsRowDropdownMenu = ({
|
|
account,
|
|
}: SettingsAccountsRowDropdownMenuProps) => {
|
|
const dropdownId = `settings-account-row-${account.id}`;
|
|
const { t } = useLingui();
|
|
const { openModal } = useModal();
|
|
|
|
const navigate = useNavigateSettings();
|
|
const { closeDropdown } = useDropdown(dropdownId);
|
|
|
|
const { destroyOneRecord } = useDestroyOneRecord({
|
|
objectNameSingular: CoreObjectNameSingular.ConnectedAccount,
|
|
});
|
|
const { triggerApisOAuth } = useTriggerApisOAuth();
|
|
|
|
const deleteAccount = async () => {
|
|
await destroyOneRecord(account.id);
|
|
};
|
|
|
|
return (
|
|
<>
|
|
<Dropdown
|
|
dropdownId={dropdownId}
|
|
dropdownPlacement="right-start"
|
|
dropdownHotkeyScope={{ scope: dropdownId }}
|
|
clickableComponent={
|
|
<LightIconButton Icon={IconDotsVertical} accent="tertiary" />
|
|
}
|
|
dropdownWidth={160}
|
|
dropdownComponents={
|
|
<DropdownMenuItemsContainer>
|
|
<MenuItem
|
|
LeftIcon={IconMail}
|
|
text={t`Emails settings`}
|
|
onClick={() => {
|
|
navigate(SettingsPath.AccountsEmails);
|
|
closeDropdown();
|
|
}}
|
|
/>
|
|
<MenuItem
|
|
LeftIcon={IconCalendarEvent}
|
|
text={t`Calendar settings`}
|
|
onClick={() => {
|
|
navigate(SettingsPath.AccountsCalendars);
|
|
closeDropdown();
|
|
}}
|
|
/>
|
|
{account.authFailedAt && (
|
|
<MenuItem
|
|
LeftIcon={IconRefresh}
|
|
text={t`Reconnect`}
|
|
onClick={() => {
|
|
triggerApisOAuth(account.provider);
|
|
closeDropdown();
|
|
}}
|
|
/>
|
|
)}
|
|
<MenuItem
|
|
accent="danger"
|
|
LeftIcon={IconTrash}
|
|
text={t`Remove account`}
|
|
onClick={() => {
|
|
closeDropdown();
|
|
openModal(DELETE_ACCOUNT_MODAL_ID);
|
|
}}
|
|
/>
|
|
</DropdownMenuItemsContainer>
|
|
}
|
|
/>
|
|
<ConfirmationModal
|
|
modalId={DELETE_ACCOUNT_MODAL_ID}
|
|
title={t`Data deletion`}
|
|
subtitle={
|
|
<Trans>
|
|
All emails and events linked to this account will be deleted
|
|
</Trans>
|
|
}
|
|
onConfirmClick={deleteAccount}
|
|
confirmButtonText={t`Delete account`}
|
|
/>
|
|
</>
|
|
);
|
|
};
|