refactor(core): adjust modal animation (#7606)

<div class='graphite__hidden'> <div>🎥 Video uploaded on Graphite:</div> <a href="https://app.graphite.dev/media/video/g3jz87HxbjOJpXV3FPT7/529d6c3f-4b23-43ac-84cc-171713d3dc72.mp4"> <img src="https://app.graphite.dev/api/v1/graphite/video/thumbnail/g3jz87HxbjOJpXV3FPT7/529d6c3f-4b23-43ac-84cc-171713d3dc72.mp4"> </a> </div> <video src="https://graphite-user-uploaded-assets-prod.s3.amazonaws.com/g3jz87HxbjOJpXV3FPT7/529d6c3f-4b23-43ac-84cc-171713d3dc72.mp4">CleanShot 2024-07-25 at 20.04.01.mp4</video> When a modal is closed, sometimes its components are completely unmounted from the component tree, making it difficult to animate. This pr defining a custom element as the container of ReactDOM.portal, rewriting the `removeChild` function, and use `startViewTransition` when ReactDOM calls it to implement the animation. # Save Input Some inputs use blur event to save data, but when they are unmounted, blur event will not be triggered at all. This pr changes blur event to native addEventListener, which will be called after the DOM element is unmounted, so as to save data in time.
2026-02-13 04:48:53 +00:00 · 2024-07-26 08:39:34 +00:00
parent 3eb09cde5e
commit 6bc5337307
12 changed files with 257 additions and 199 deletions
--- a/packages/frontend/component/src/ui/editable/inline-edit.tsx
+++ b/packages/frontend/component/src/ui/editable/inline-edit.tsx
@@ -214,12 +214,12 @@ export const InlineEdit = ({
          className={styles.inlineEditInput}
          value={editingValue}
          placeholder={placeholder}
-          onBlur={onBlur}
          onEnter={onEnter}
          onKeyDown={onKeyDown}
          onChange={inputHandler}
          style={inputWrapperInheritsStyles}
          inputStyle={inputInheritsStyles}
+          onBlur={onBlur}
          {...inputAttrs}
        />
      }
--- a/packages/frontend/component/src/ui/input/input.tsx
+++ b/packages/frontend/component/src/ui/input/input.tsx
@@ -2,21 +2,26 @@ import clsx from 'clsx';
 import type {
  ChangeEvent,
  CSSProperties,
-  FocusEventHandler,
  ForwardedRef,
  InputHTMLAttributes,
  KeyboardEvent,
  KeyboardEventHandler,
  ReactNode,
 } from 'react';
-import { forwardRef, useCallback, useLayoutEffect, useRef } from 'react';
+import {
+  forwardRef,
+  useCallback,
+  useEffect,
+  useLayoutEffect,
+  useRef,
+} from 'react';

 import { input, inputWrapper } from './style.css';

 export type InputProps = {
  disabled?: boolean;
  onChange?: (value: string) => void;
-  onBlur?: FocusEventHandler<HTMLInputElement>;
+  onBlur?: (ev: FocusEvent & { currentTarget: HTMLInputElement }) => void;
  onKeyDown?: KeyboardEventHandler<HTMLInputElement>;
  autoSelect?: boolean;
  noBorder?: boolean;
@@ -27,7 +32,7 @@ export type InputProps = {
  type?: HTMLInputElement['type'];
  inputStyle?: CSSProperties;
  onEnter?: () => void;
-} & Omit<InputHTMLAttributes<HTMLInputElement>, 'onChange' | 'size'>;
+} & Omit<InputHTMLAttributes<HTMLInputElement>, 'onChange' | 'size' | 'onBlur'>;

 export const Input = forwardRef<HTMLInputElement, InputProps>(function Input(
  {
@@ -43,6 +48,7 @@ export const Input = forwardRef<HTMLInputElement, InputProps>(function Input(
    endFix,
    onEnter,
    onKeyDown,
+    onBlur,
    autoFocus,
    autoSelect,
    ...otherProps
@@ -59,6 +65,17 @@ export const Input = forwardRef<HTMLInputElement, InputProps>(function Input(
    }
  }, [autoFocus, autoSelect, upstreamRef]);

+  // use native blur event to get event after unmount
+  // don't use useLayoutEffect here, because the cleanup function will be called before unmount
+  useEffect(() => {
+    if (!onBlur) return;
+    inputRef.current?.addEventListener('blur', onBlur as any);
+    return () => {
+      // eslint-disable-next-line react-hooks/exhaustive-deps
+      inputRef.current?.removeEventListener('blur', onBlur as any);
+    };
+  }, [onBlur]);
+
  return (
    <div
      className={clsx(inputWrapper, className, {
--- a/packages/frontend/component/src/ui/menu/menu.tsx
+++ b/packages/frontend/component/src/ui/menu/menu.tsx
@@ -6,7 +6,6 @@ import type {
 import * as DropdownMenu from '@radix-ui/react-dropdown-menu';
 import clsx from 'clsx';
 import type { ReactNode } from 'react';
-import { useMemo } from 'react';

 import * as styles from './styles.css';

@@ -16,6 +15,7 @@ export interface MenuProps {
  portalOptions?: Omit<DropdownMenuPortalProps, 'children'>;
  rootOptions?: Omit<DropdownMenuProps, 'children'>;
  contentOptions?: Omit<DropdownMenuContentProps, 'children'>;
+  noPortal?: boolean;
 }

 export const Menu = ({
@@ -23,6 +23,7 @@ export const Menu = ({
  items,
  portalOptions,
  rootOptions,
+  noPortal,
  contentOptions: {
    className = '',
    style: contentStyle = {},
@@ -33,12 +34,9 @@ export const Menu = ({
    <DropdownMenu.Root {...rootOptions}>
      <DropdownMenu.Trigger asChild>{children}</DropdownMenu.Trigger>

-      <DropdownMenu.Portal {...portalOptions}>
+      {noPortal ? (
        <DropdownMenu.Content
-          className={useMemo(
-            () => clsx(styles.menuContent, className),
-            [className]
-          )}
+          className={clsx(styles.menuContent, className)}
          sideOffset={5}
          align="start"
          style={{ zIndex: 'var(--affine-z-index-popover)', ...contentStyle }}
@@ -46,7 +44,19 @@ export const Menu = ({
        >
          {items}
        </DropdownMenu.Content>
-      </DropdownMenu.Portal>
+      ) : (
+        <DropdownMenu.Portal {...portalOptions}>
+          <DropdownMenu.Content
+            className={clsx(styles.menuContent, className)}
+            sideOffset={5}
+            align="start"
+            style={{ zIndex: 'var(--affine-z-index-popover)', ...contentStyle }}
+            {...otherContentOptions}
+          >
+            {items}
+          </DropdownMenu.Content>
+        </DropdownMenu.Portal>
+      )}
    </DropdownMenu.Root>
  );
 };
--- a/packages/frontend/component/src/ui/modal/modal.tsx
+++ b/packages/frontend/component/src/ui/modal/modal.tsx
@@ -10,8 +10,7 @@ import * as VisuallyHidden from '@radix-ui/react-visually-hidden';
 import { assignInlineVars } from '@vanilla-extract/dynamic';
 import clsx from 'clsx';
 import type { CSSProperties } from 'react';
-import { forwardRef, useCallback, useEffect } from 'react';
-import { type TransitionState, useTransition } from 'react-transition-state';
+import { forwardRef, useCallback } from 'react';

 import type { IconButtonProps } from '../button';
 import { IconButton } from '../button';
@@ -29,8 +28,6 @@ export interface ModalProps extends DialogProps {
   * @default false
   */
  persistent?: boolean;
-  // animation for modal open/close
-  animationTimeout?: number;
  portalOptions?: DialogPortalProps;
  contentOptions?: DialogContentProps;
  overlayOptions?: DialogOverlayProps;
@@ -48,141 +45,174 @@ const getVar = (style: number | string = '', defaultValue = '') => {
    : defaultValue;
 };

-export const Modal = forwardRef<HTMLDivElement, ModalProps>(
-  (
-    {
-      width,
-      height,
-      minHeight = 194,
-      title,
-      description,
-      withoutCloseButton = false,
-      modal,
-      persistent,
-      animationTimeout = 120,
-      portalOptions,
-      open: customOpen,
-      onOpenChange: customOnOpenChange,
-      contentOptions: {
-        style: contentStyle,
-        className: contentClassName,
-        onPointerDownOutside,
-        onEscapeKeyDown,
-        ...otherContentOptions
-      } = {},
-      overlayOptions: {
-        className: overlayClassName,
-        style: overlayStyle,
-        ...otherOverlayOptions
-      } = {},
-      closeButtonOptions = {},
-      children,
-      ...props
-    },
-    ref
-  ) => {
-    const [{ status }, toggle] = useTransition({
-      timeout: animationTimeout,
-      onStateChange: useCallback(
-        ({ current }: { current: TransitionState }) => {
-          // add more status if needed
-          if (current.status === 'exited') customOnOpenChange?.(false);
-          if (current.status === 'entered') customOnOpenChange?.(true);
-        },
-        [customOnOpenChange]
-      ),
-    });
-    useEffect(() => {
-      toggle(customOpen);
-    }, [customOpen]);
+/**
+ * This component is a hack to support `startViewTransition` in the modal.
+ */
+class ModalTransitionContainer extends HTMLElement {
+  pendingTransitionNodes: Node[] = [];
+  animationFrame: number | null = null;

-    return (
-      <Dialog.Root
-        modal={modal}
-        open={status !== 'exited'}
-        onOpenChange={toggle}
-        {...props}
-      >
-        <Dialog.Portal {...portalOptions}>
-          <Dialog.Overlay
-            className={clsx(styles.modalOverlay, overlayClassName)}
-            data-state={status}
+  /**
+   * This method will be called when the modal is removed from the DOM
+   * https://github.com/facebook/react/blob/e4b4aac2a01b53f8151ca85148873096368a7de2/packages/react-dom-bindings/src/client/ReactFiberConfigDOM.js#L833
+   */
+  override removeChild<T extends Node>(child: T): T {
+    if (typeof document.startViewTransition === 'function') {
+      this.pendingTransitionNodes.push(child);
+      this.requestTransition();
+      return child;
+    } else {
+      // eslint-disable-next-line unicorn/prefer-dom-node-remove
+      return super.removeChild(child);
+    }
+  }
+
+  /**
+   * We collect all the nodes that are removed in the single frame and then trigger the transition.
+   */
+  private requestTransition() {
+    if (this.animationFrame) {
+      cancelAnimationFrame(this.animationFrame);
+    }
+
+    this.animationFrame = requestAnimationFrame(() => {
+      if (typeof document.startViewTransition === 'function') {
+        const nodes = this.pendingTransitionNodes;
+        document.startViewTransition(() => {
+          nodes.forEach(child => {
+            // eslint-disable-next-line unicorn/prefer-dom-node-remove
+            super.removeChild(child);
+          });
+        });
+        this.pendingTransitionNodes = [];
+      }
+    });
+  }
+}
+
+let container: ModalTransitionContainer | null = null;
+function prepareContainer() {
+  if (!container) {
+    customElements.define(
+      'modal-transition-container',
+      ModalTransitionContainer
+    );
+    container = new ModalTransitionContainer();
+    document.body.append(container);
+  }
+  return container;
+}
+
+export const Modal = forwardRef<HTMLDivElement, ModalProps>((props, ref) => {
+  const {
+    modal,
+    portalOptions,
+    open,
+    onOpenChange,
+    width,
+    height,
+    minHeight = 194,
+    title,
+    description,
+    withoutCloseButton = false,
+    persistent,
+    contentOptions: {
+      style: contentStyle,
+      className: contentClassName,
+      onPointerDownOutside,
+      onEscapeKeyDown,
+      ...otherContentOptions
+    } = {},
+    overlayOptions: {
+      className: overlayClassName,
+      style: overlayStyle,
+      ...otherOverlayOptions
+    } = {},
+    closeButtonOptions = {},
+    children,
+    ...otherProps
+  } = props;
+
+  return (
+    <Dialog.Root
+      modal={modal}
+      open={open}
+      onOpenChange={onOpenChange}
+      {...otherProps}
+    >
+      <Dialog.Portal container={prepareContainer()} {...portalOptions}>
+        <Dialog.Overlay
+          className={clsx(styles.modalOverlay, overlayClassName)}
+          style={{
+            ...overlayStyle,
+          }}
+          {...otherOverlayOptions}
+        />
+        <div data-modal={modal} className={clsx(styles.modalContentWrapper)}>
+          <Dialog.Content
+            onPointerDownOutside={useCallback(
+              (e: PointerDownOutsideEvent) => {
+                onPointerDownOutside?.(e);
+                persistent && e.preventDefault();
+              },
+              [onPointerDownOutside, persistent]
+            )}
+            onEscapeKeyDown={useCallback(
+              (e: KeyboardEvent) => {
+                onEscapeKeyDown?.(e);
+                persistent && e.preventDefault();
+              },
+              [onEscapeKeyDown, persistent]
+            )}
+            className={clsx(styles.modalContent, contentClassName)}
            style={{
              ...assignInlineVars({
-                [styles.animationTimeout]: `${animationTimeout}ms`,
+                [styles.widthVar]: getVar(width, '50vw'),
+                [styles.heightVar]: getVar(height, 'unset'),
+                [styles.minHeightVar]: getVar(minHeight, '26px'),
              }),
-              ...overlayStyle,
+              ...contentStyle,
            }}
-            {...otherOverlayOptions}
-          />
-          <div data-modal={modal} className={clsx(styles.modalContentWrapper)}>
-            <Dialog.Content
-              onPointerDownOutside={useCallback(
-                (e: PointerDownOutsideEvent) => {
-                  onPointerDownOutside?.(e);
-                  persistent && e.preventDefault();
-                },
-                [onPointerDownOutside, persistent]
-              )}
-              onEscapeKeyDown={useCallback(
-                (e: KeyboardEvent) => {
-                  onEscapeKeyDown?.(e);
-                  persistent && e.preventDefault();
-                },
-                [onEscapeKeyDown, persistent]
-              )}
-              className={clsx(styles.modalContent, contentClassName)}
-              data-state={status}
-              style={{
-                ...assignInlineVars({
-                  [styles.widthVar]: getVar(width, '50vw'),
-                  [styles.heightVar]: getVar(height, 'unset'),
-                  [styles.minHeightVar]: getVar(minHeight, '26px'),
-                  [styles.animationTimeout]: `${animationTimeout}ms`,
-                }),
-                ...contentStyle,
-              }}
-              {...(description ? {} : { 'aria-describedby': undefined })}
-              {...otherContentOptions}
-              ref={ref}
-            >
-              {withoutCloseButton ? null : (
-                <Dialog.Close asChild>
-                  <IconButton
-                    className={styles.closeButton}
-                    aria-label="Close"
-                    type="plain"
-                    data-testid="modal-close-button"
-                    {...closeButtonOptions}
-                  >
-                    <CloseIcon />
-                  </IconButton>
-                </Dialog.Close>
-              )}
-              {title ? (
-                <Dialog.Title className={styles.modalHeader}>
-                  {title}
-                </Dialog.Title>
-              ) : (
-                // Refer: https://www.radix-ui.com/primitives/docs/components/dialog#title
-                // If you want to hide the title, wrap it inside our Visually Hidden utility like this <VisuallyHidden asChild>.
-                <VisuallyHidden.Root asChild>
-                  <Dialog.Title></Dialog.Title>
-                </VisuallyHidden.Root>
-              )}
-              {description ? (
-                <Dialog.Description className={styles.modalDescription}>
-                  {description}
-                </Dialog.Description>
-              ) : null}
+            {...(description ? {} : { 'aria-describedby': undefined })}
+            {...otherContentOptions}
+            ref={ref}
+          >
+            {withoutCloseButton ? null : (
+              <Dialog.Close asChild>
+                <IconButton
+                  className={styles.closeButton}
+                  aria-label="Close"
+                  type="plain"
+                  data-testid="modal-close-button"
+                  {...closeButtonOptions}
+                >
+                  <CloseIcon />
+                </IconButton>
+              </Dialog.Close>
+            )}
+            {title ? (
+              <Dialog.Title className={styles.modalHeader}>
+                {title}
+              </Dialog.Title>
+            ) : (
+              // Refer: https://www.radix-ui.com/primitives/docs/components/dialog#title
+              // If you want to hide the title, wrap it inside our Visually Hidden utility like this <VisuallyHidden asChild>.
+              <VisuallyHidden.Root asChild>
+                <Dialog.Title></Dialog.Title>
+              </VisuallyHidden.Root>
+            )}
+            {description ? (
+              <Dialog.Description className={styles.modalDescription}>
+                {description}
+              </Dialog.Description>
+            ) : null}

-              {children}
-            </Dialog.Content>
-          </div>
-        </Dialog.Portal>
-      </Dialog.Root>
-    );
-  }
-);
+            {children}
+          </Dialog.Content>
+        </div>
+      </Dialog.Portal>
+    </Dialog.Root>
+  );
+});

 Modal.displayName = 'Modal';
--- a/packages/frontend/component/src/ui/modal/styles.css.ts
+++ b/packages/frontend/component/src/ui/modal/styles.css.ts
@@ -1,9 +1,14 @@
 import { cssVar } from '@toeverything/theme';
-import { createVar, globalStyle, keyframes, style } from '@vanilla-extract/css';
+import {
+  createVar,
+  generateIdentifier,
+  globalStyle,
+  keyframes,
+  style,
+} from '@vanilla-extract/css';
 export const widthVar = createVar('widthVar');
 export const heightVar = createVar('heightVar');
 export const minHeightVar = createVar('minHeightVar');
-export const animationTimeout = createVar();

 const overlayShow = keyframes({
  from: {
@@ -13,15 +18,6 @@ const overlayShow = keyframes({
    opacity: 1,
  },
 });
-const overlayHide = keyframes({
-  to: {
-    opacity: 0,
-  },
-  from: {
-    opacity: 1,
-  },
-});
-
 const contentShow = keyframes({
  from: {
    opacity: 0,
@@ -32,7 +28,7 @@ const contentShow = keyframes({
    transform: 'translateY(0) scale(1)',
  },
 });
-const contentHide = keyframes({
+export const contentHide = keyframes({
  to: {
    opacity: 0,
    transform: 'translateY(-2%) scale(0.96)',
@@ -48,15 +44,9 @@ export const modalOverlay = style({
  inset: 0,
  backgroundColor: cssVar('backgroundModalColor'),
  zIndex: cssVar('zIndexModal'),
-  selectors: {
-    '&[data-state=entered], &[data-state=entering]': {
-      animation: `${overlayShow} ${animationTimeout} forwards`,
-    },
-    '&[data-state=exited], &[data-state=exiting]': {
-      animation: `${overlayHide} ${animationTimeout} forwards`,
-    },
-  },
+  animation: `${overlayShow} 150ms forwards`,
 });
+const modalContentViewTransitionName = generateIdentifier('modal-content');
 export const modalContentWrapper = style({
  position: 'fixed',
  inset: 0,
@@ -64,6 +54,13 @@ export const modalContentWrapper = style({
  alignItems: 'center',
  justifyContent: 'center',
  zIndex: cssVar('zIndexModal'),
+  animation: `${contentShow} 150ms cubic-bezier(0.42, 0, 0.58, 1)`,
+  animationFillMode: 'forwards',
+  viewTransitionName: modalContentViewTransitionName,
+});
+globalStyle(`::view-transition-old(${modalContentViewTransitionName})`, {
+  animation: `${contentHide} 150ms cubic-bezier(0.42, 0, 0.58, 1)`,
+  animationFillMode: 'forwards',
 });

 export const modalContent = style({
@@ -87,16 +84,6 @@ export const modalContent = style({
  maxHeight: 'calc(100vh - 32px)',
  // :focus-visible will set outline
  outline: 'none',
-  selectors: {
-    '&[data-state=entered], &[data-state=entering]': {
-      animation: `${contentShow} ${animationTimeout} cubic-bezier(0.42, 0, 0.58, 1)`,
-      animationFillMode: 'forwards',
-    },
-    '&[data-state=exited], &[data-state=exiting]': {
-      animation: `${contentHide} ${animationTimeout} cubic-bezier(0.42, 0, 0.58, 1)`,
-      animationFillMode: 'forwards',
-    },
-  },
 });
 export const closeButton = style({
  position: 'absolute',