Skip to content

The open alternative to Salesforce, designed for AI.

Support bounded front component portals (#27392)

Raphaël Bosicac8019e5936
diff --git a/packages/twenty-docs/developers/extend/apps/layout/front-components.mdx b/packages/twenty-docs/developers/extend/apps/layout/front-components.mdx
index 1fd7adba18b..fb36a238039 100644
--- a/packages/twenty-docs/developers/extend/apps/layout/front-components.mdx
+++ b/packages/twenty-docs/developers/extend/apps/layout/front-components.mdx
@@ -963,7 +963,7 @@ To branch on the active scheme explicitly, read it with `useColorScheme()` from
## Current limitations
-Front components are under active development. Rendering, styling, handling events, measuring elements and browser storage work well. Anything that reaches _past_ those (calling a DOM method on a ref, observing element resizes, portaling outside your tree) is missing or incomplete today, and most of it fails silently: no exception, and no TypeScript error either, since the scaffold is typed against the full browser DOM.
+Front components are under active development. Rendering, styling, handling events, measuring elements, body portals and browser storage work well. Anything that reaches _past_ those (calling a DOM method on a ref, observing element resizes) is missing or incomplete today, and most of it fails silently: no exception, and no TypeScript error either, since the scaffold is typed against the full browser DOM.
If one of these blocks you, [open an issue](https://github.com/twentyhq/twenty/issues/new/choose) so it gets prioritized.
@@ -1012,11 +1012,11 @@ A `ref` gives you a sandbox element, not an `HTMLElement`.
| `document.createTreeWalker()` | Throws | `querySelector()` / `querySelectorAll()`, `matches()`, `closest()` (including pseudo-classes such as `:disabled` and `:not()`), `getElementById()`, `contains()` and `compareDocumentPosition()` work; `getElementsByClassName()` works too, but returns a static collection, not a live `HTMLCollection` |
| `document.activeElement` | Follows the page's focus inside the component and updates when sandbox code calls `focus()` or `blur()` | `onFocus` / `onBlur` to react to the page's focus |
| `canvas` | Renders nothing, no error | SVG, or draw offscreen and show the result in an `img` element |
-| `createPortal(node, document.body)` | Renders nothing, while `isConnected` reports success | Overlays inline with `position: absolute`, or pass the library your own container element |
+| `createPortal(node, document.body)` | Renders in a host overlay layer bounded to 200px around the component | Keep overlays within this area, or add scrolling for larger content |
`element.classList` works, backed by the `class` attribute: `add`, `remove`, `toggle`, `replace`, `contains`, `item`, `length`, `value` and iteration all behave as they do in a browser, and `className` stays in sync. `element.dataset` works the same way, backed by the `data-*` attributes; write `data-*` names in lowercase, since the sandbox keeps attribute names as written instead of lowercasing them like a browser.
-The portal gap is why Radix, Headless UI, MUI and react-select popovers render nothing by default. Most accept a container prop; point it at an element you rendered.
+Body portals can extend up to 200px beyond each edge of your component, including outside a widget's scroll frame. Larger overlays are clipped to this area, so give long menus their own scrolling container. Native top-layer APIs such as `showModal()`, `showPopover()` and `requestFullscreen()` are blocked.
### Events
diff --git a/packages/twenty-front-component-renderer/src/__stories__/TwentyUiGallery.stories.tsx b/packages/twenty-front-component-renderer/src/__stories__/TwentyUiGallery.stories.tsx
index 8a55f63d4b4..e32516a99a3 100644
--- a/packages/twenty-front-component-renderer/src/__stories__/TwentyUiGallery.stories.tsx
+++ b/packages/twenty-front-component-renderer/src/__stories__/TwentyUiGallery.stories.tsx
@@ -40,6 +40,9 @@ import {
avatarControlsTest,
chipControlsTest,
} from '@/__stories__/twenty-ui-gallery/utils/displayControlTests';
+import { PortalBoundsDecorator } from '@/__stories__/twenty-ui-gallery/components/PortalBoundsDecorator';
+import { portalBoundsTest } from '@/__stories__/twenty-ui-gallery/utils/portalBoundsTest';
+
import { createGalleryStory } from '@/__stories__/twenty-ui-gallery/utils/createGalleryStory';
import { typographyTest } from '@/__stories__/twenty-ui-gallery/utils/typographyTest';
import {
@@ -371,6 +374,20 @@ export const MenuPreact: Story = createGalleryStory({
play: menuTest,
});
+export const PortalBoundsReact: Story = createGalleryStory({
+ frontComponentBundleName: 'twenty-ui-portals',
+ runtime: 'react',
+ decorators: [PortalBoundsDecorator],
+ play: portalBoundsTest,
+});
+
+export const PortalBoundsPreact: Story = createGalleryStory({
+ frontComponentBundleName: 'twenty-ui-portals',
+ runtime: 'preact',
+ decorators: [PortalBoundsDecorator],
+ play: portalBoundsTest,
+});
+
export const DropdownReact: Story = createGalleryStory({
frontComponentBundleName: 'twenty-ui-dropdown',
runtime: 'react',
diff --git a/packages/twenty-front-component-renderer/src/__stories__/shared/test-utils/matchers/expectElementToReceivePointer.ts b/packages/twenty-front-component-renderer/src/__stories__/shared/test-utils/matchers/expectElementToReceivePointer.ts
new file mode 100644
index 00000000000..a2c5fb9ad60
--- /dev/null
+++ b/packages/twenty-front-component-renderer/src/__stories__/shared/test-utils/matchers/expectElementToReceivePointer.ts
@@ -0,0 +1,11 @@
+import { expect } from 'storybook/test';
+
+export const expectElementToReceivePointer = (element: Element): void => {
+ const elementRectangle = element.getBoundingClientRect();
+ const elementAtCenter = element.ownerDocument.elementFromPoint(
+ elementRectangle.left + elementRectangle.width / 2,
+ elementRectangle.top + elementRectangle.height / 2,
+ );
+
+ expect(element.contains(elementAtCenter)).toBe(true);
+};
diff --git a/packages/twenty-front-component-renderer/src/__stories__/shared/test-utils/waitForAnimationFrames.ts b/packages/twenty-front-component-renderer/src/__stories__/shared/test-utils/waitForAnimationFrames.ts
new file mode 100644
index 00000000000..f07b897ee71
--- /dev/null
+++ b/packages/twenty-front-component-renderer/src/__stories__/shared/test-utils/waitForAnimationFrames.ts
@@ -0,0 +1,7 @@
+export const waitForAnimationFrames = async (
+ frameCount: number,
+): Promise<void> => {
+ for (let frameIndex = 0; frameIndex < frameCount; frameIndex += 1) {
+ await new Promise((resolve) => requestAnimationFrame(resolve));
+ }
+};
diff --git a/packages/twenty-front-component-renderer/src/__stories__/twenty-ui-gallery/README.md b/packages/twenty-front-component-renderer/src/__stories__/twenty-ui-gallery/README.md
index 1e065f6a1e6..af85c1c4e37 100644
--- a/packages/twenty-front-component-renderer/src/__stories__/twenty-ui-gallery/README.md
+++ b/packages/twenty-front-component-renderer/src/__stories__/twenty-ui-gallery/README.md
@@ -20,9 +20,9 @@ scenarios. Shared types live in `types/` and shared constants in `constants/`;
known-failure scenarios that assert sandbox errors declare the patterns they
require.
`createGalleryRenderTest` checks the exact set of expected failed components.
-`createOverlayOpenTest` checks that a trigger opens its overlay and pins the
-popup content as absent from the page. `createDropdownOpenTest` applies it to
-the Dropdown-based popups.
+`createOverlayOpenTest` checks that a trigger opens its overlay and waits for
+visible popup content. `createDropdownOpenTest` applies it to the Dropdown-based
+popups.
`expectSandboxErrors` requires each listed known error and rejects any other
error. `expectAssertionToKeepFailing` pins an interaction that must have no
effect within the interaction timeout.
@@ -46,6 +46,7 @@ effect within the interaction timeout.
| `twenty-ui-dialog` | SDK `openCommandConfirmationModal` confirmation request |
| `twenty-ui-menu` | Menu |
| `twenty-ui-select` | Select |
+| `twenty-ui-portals` | Body portal callbacks, removal, nearby overflow, menu placement and confinement |
| `twenty-ui-dropdown` | Dropdown |
| `twenty-ui-toast` | Toast |
| `twenty-ui-switch` | Switch (interaction coverage in addition to the original input gallery) |
@@ -74,6 +75,12 @@ responses and closes them on teardown or timeout. These delayed-response steps
run only in test mode; the regular and static stories use data images and
retain working source controls, fallback, replacement and unmount/remount checks.
+Body portals render in a host layer outside widget scroll frames, clipped to
+200px around the component, and the worker's `window.visualViewport` reports
+that area so Floating UI popups flip and size themselves to fit it. The portal
+fixture covers callbacks, removal, menu placement, interface zoom, and an
+oversized portal that stays clipped while a host control remains usable.
+
The Autocomplete fixture uses the public inline list interface to isolate input
behavior from popup support. Its Empty section runs Base UI's live-region marker
through a narrow worker TreeWalker that supports SHOW_TEXT, nextNode and
@@ -96,12 +103,12 @@ must change the corresponding story to assert successful behavior; do not keep
or broaden an obsolete expectation. No stories are skipped or marked as
expected-to-fail by the runner.
-| Component | Current limitation |
-| ------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
-| ImageInput | Native file picker activation and usable file contents are unavailable in the sandbox. The fixture checks forwarded file metadata, preview recovery, action callbacks, and supplied error changes. See the [ImageInput documentation](../../../../twenty-docs/ui/components/input/image-input.mdx). |
-| Popover, Menu, Select, Dropdown, CurrencyPicker, PhoneCountryPicker, CountrySelect, Autocomplete (React and Preact) | The trigger opens the overlay, but the popup portals into the sandbox `document.body`, which never reaches the host, so its content stays invisible. Search, selection, dismissal and focus restoration are not covered yet. |
-| Slider | Thumbs stay hidden because the sandbox has no `ResizeObserver` to re-measure after the first geometry batch. |
-| Responsive hooks | The sandbox `window.matchMedia` answers for the widget's own box, so `useIsMobile` follows the widget width rather than the browser viewport: a widget 768px wide or narrower gets the mobile layout, and Button drops its hotkey hint, on any screen. `useIsTouchDevice` follows the primary input of the host device, so it is `false` under the desktop Chromium that runs these stories. The fixture asserts both at a 1024px and a 400px widget width. |
+| Component | Current limitation |
+| ----------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
+| ImageInput | Native file picker activation and usable file contents are unavailable in the sandbox. The fixture checks forwarded file metadata, preview recovery, action callbacks, and supplied error changes. See the [ImageInput documentation](../../../../twenty-docs/ui/components/input/image-input.mdx). |
+| Popover, Menu, Select, Dropdown, CurrencyPicker, PhoneCountryPicker, CountrySelect (React and Preact) | Body portal content reaches the host inside the component portal area. These fixtures cover opening and visible content; search, selection, dismissal and focus restoration are not covered yet. |
+| Slider | Thumbs stay hidden because the sandbox has no `ResizeObserver` to re-measure after the first geometry batch. |
+| Responsive hooks | The sandbox `window.matchMedia` answers for the widget's own box, so `useIsMobile` follows the widget width rather than the browser viewport: a widget 768px wide or narrower gets the mobile layout, and Button drops its hotkey hint, on any screen. `useIsTouchDevice` follows the primary input of the host device, so it is `false` under the desktop Chromium that runs these stories. The fixture asserts both at a 1024px and a 400px widget width. |
The worker DOM now provides `Node.contains`, `compareDocumentPosition`,
`getRootNode`, `Element.matches`, `closest`, `querySelector` backed by
@@ -153,7 +160,7 @@ component never reach the worker, so dismissal on a press elsewhere on the page
is not covered.
Once the remaining gaps are fixed, extend the stories to verify keyboard
-navigation, and overlay content, dismissal, and focus restoration. The fixtures
+navigation, dismissal, and focus restoration across overlay components. The fixtures
already include the controlled state, compound parts, and callback output for
those checks. Passing display, ListItem, and Toast stories verify rendering/CSS
or interaction behavior directly.
diff --git a/packages/twenty-front-component-renderer/src/__stories__/twenty-ui-gallery/components/PortalBoundsDecorator.tsx b/packages/twenty-front-component-renderer/src/__stories__/twenty-ui-gallery/components/PortalBoundsDecorator.tsx
new file mode 100644
index 00000000000..d0401c59278
--- /dev/null
+++ b/packages/twenty-front-component-renderer/src/__stories__/twenty-ui-gallery/components/PortalBoundsDecorator.tsx
@@ -0,0 +1,42 @@
+import { type Decorator } from '@storybook/react-vite';
+import { useState } from 'react';
+import { Button } from 'twenty-ui/primitives/input';
+import { Text } from 'twenty-ui/primitives/typography';
+
+export const PortalBoundsDecorator: Decorator = (Story) => {
+ const [hostActionCount, setHostActionCount] = useState(0);
+
+ return (
+ <div style={{ minHeight: 700 }}>
+ <Button
+ style={{ position: 'absolute', left: 8, top: 8 }}
+ onClick={() => setHostActionCount(hostActionCount + 1)}
+ >
+ Host action
+ </Button>
+ <Text role="status" aria-label="Host actions">
+ Host actions: {hostActionCount}
+ </Text>
+ <div
+ style={{
+ width: 320,
+ height: 180,
+ margin: '240px 320px',
+ overflow: 'hidden',
+ position: 'relative',
+ zIndex: 2,
+ }}
+ >
+ <div
+ role="region"
+ aria-label="Widget scroll frame"
+ style={{ width: '100%', height: '100%', overflow: 'auto' }}
+ >
+ <div role="group" aria-label="Widget" style={{ height: 260 }}>
+ <Story />
+ </div>
+ </div>
+ </div>
+ </div>
+ );
+};
diff --git a/packages/twenty-front-component-renderer/src/__stories__/twenty-ui-gallery/twenty-ui-portals.front-component.tsx b/packages/twenty-front-component-renderer/src/__stories__/twenty-ui-gallery/twenty-ui-portals.front-component.tsx
new file mode 100644
index 00000000000..2ecef0888b3
--- /dev/null
+++ b/packages/twenty-front-component-renderer/src/__stories__/twenty-ui-gallery/twenty-ui-portals.front-component.tsx
@@ -0,0 +1,79 @@
+import { useState } from 'react';
+import { createPortal } from 'react-dom';
+import { defineFrontComponent } from 'twenty-sdk/define';
+import { Button } from 'twenty-ui/primitives/input';
+import { Menu } from 'twenty-ui/primitives/surfaces';
+import { Text } from 'twenty-ui/primitives/typography';
+
+import { TwentyUiGalleryCard } from '@/__stories__/shared/front-components/twenty-ui-gallery-card';
+
+const OVERSIZED_PORTAL_EXTENT = 4000;
+const OVERSIZED_PORTAL_OFFSET = -1000;
+const OVERSIZED_PORTAL_Z_INDEX = 2147483647;
+const MENU_ITEM_LABELS = Array.from(
+ { length: 16 },
+ (_, itemIndex) => `Menu item ${itemIndex + 1}`,
+);
+
+const PortalsExample = () => {
+ const [isOpen, setIsOpen] = useState(false);
+ const [isOversizedOpen, setIsOversizedOpen] = useState(false);
+ const [actionCount, setActionCount] = useState(0);
+
+ return (
+ <TwentyUiGalleryCard title="Portals">
+ <Menu.Root>
+ <Menu.Trigger>Open menu</Menu.Trigger>
+ <Menu.Popup>
+ {MENU_ITEM_LABELS.map((menuItemLabel) => (
+ <Menu.Item key={menuItemLabel}>{menuItemLabel}</Menu.Item>
+ ))}
+ </Menu.Popup>
+ </Menu.Root>
+ <Button onClick={() => setIsOpen(!isOpen)}>Toggle popup</Button>
+ <Button onClick={() => setIsOversizedOpen(!isOversizedOpen)}>
+ Fill portal area
+ </Button>
+ <Text role="status" aria-label="Portal actions">
+ Portal actions: {actionCount}
+ </Text>
+ {isOpen &&
+ createPortal(
+ <div style={{ position: 'absolute', top: '100%', left: 0 }}>
+ <Button onClick={() => setActionCount(actionCount + 1)}>
+ Portal action
+ </Button>
+ </div>,
+ document.body,
+ )}
+ {isOversizedOpen &&
+ createPortal(
+ <Button
+ aria-label="Oversized portal"
+ onClick={() => setIsOversizedOpen(false)}
+ style={{
+ position: 'fixed',
+ top: OVERSIZED_PORTAL_OFFSET,
+ left: OVERSIZED_PORTAL_OFFSET,
+ width: OVERSIZED_PORTAL_EXTENT,
+ height: OVERSIZED_PORTAL_EXTENT,
+ maxWidth: 'none',
+ maxHeight: 'none',
+ zIndex: OVERSIZED_PORTAL_Z_INDEX,
+ background: '#f00080',
+ }}
+ >
+ Oversized portal
+ </Button>,
+ document.body,
+ )}
+ </TwentyUiGalleryCard>
+ );
+};
+
+export default defineFrontComponent({
+ universalIdentifier: 'd6a7d90d-30e8-46c0-8d91-71b1cb33a1c7',
+ name: 'twenty-ui-portals',
+ description: 'Body portal visibility, interaction and bounded rendering',
+ component: PortalsExample,
+});
diff --git a/packages/twenty-front-component-renderer/src/__stories__/twenty-ui-gallery/utils/createOverlayOpenTest.ts b/packages/twenty-front-component-renderer/src/__stories__/twenty-ui-gallery/utils/createOverlayOpenTest.ts
index 2f0e36795f8..51170818cda 100644
--- a/packages/twenty-front-component-renderer/src/__stories__/twenty-ui-gallery/utils/createOverlayOpenTest.ts
+++ b/packages/twenty-front-component-renderer/src/__stories__/twenty-ui-gallery/utils/createOverlayOpenTest.ts
@@ -40,6 +40,8 @@ export const createOverlayOpenTest =
expect(canvas.getByRole('status')).toHaveTextContent(expectedOpenStatus);
}
- expect(page.queryByText(popupText)).not.toBeInTheDocument();
+ await waitFor(() =>
+ expect(page.getByText(popupText, { exact: false })).toBeVisible(),
+ );
expect(errorHandler).not.toHaveBeenCalled();
};
diff --git a/packages/twenty-front-component-renderer/src/__stories__/twenty-ui-gallery/utils/portalBoundsTest.ts b/packages/twenty-front-component-renderer/src/__stories__/twenty-ui-gallery/utils/portalBoundsTest.ts
new file mode 100644
index 00000000000..ab3ec8cc1da
--- /dev/null
+++ b/packages/twenty-front-component-renderer/src/__stories__/twenty-ui-gallery/utils/portalBoundsTest.ts
@@ -0,0 +1,202 @@
+import { expect, userEvent, waitFor, within } from 'storybook/test';
+
+import { errorHandler } from '@/__stories__/shared/test-utils/createFrontComponentStoryMeta';
+import { expectElementToReceivePointer } from '@/__stories__/shared/test-utils/matchers/expectElementToReceivePointer';
+import { expectFrontComponentMounted } from '@/__stories__/shared/test-utils/matchers/expectFrontComponentMounted';
+import { waitForAnimationFrames } from '@/__stories__/shared/test-utils/waitForAnimationFrames';
+import { type TwentyUiGalleryPlayFunction } from '@/__stories__/twenty-ui-gallery/types/TwentyUiGalleryPlayFunction';
+import { FRONT_COMPONENT_PORTAL_MARGIN } from '@/constants/FrontComponentPortalMargin';
+import { GEOMETRY_IDLE_FRAME_THRESHOLD } from '@/host/geometry/constants/GeometryIdleFrameThreshold';
+
+const MAXIMUM_MENU_TRIGGER_GAP = 16;
+const WIDGET_SCROLL_OFFSET = 40;
+
+const waitForGeometryTrackerToIdle = () =>
+ waitForAnimationFrames(GEOMETRY_IDLE_FRAME_THRESHOLD * 2);
+
+const expectPortalActionAtOwnerBottom = ({
+ portalAction,
+ ownerRoot,
+}: {
+ portalAction: Element;
+ ownerRoot: Element;
+}) => {
+ expect(portalAction.getBoundingClientRect().top).toBeCloseTo(
+ ownerRoot.getBoundingClientRect().bottom,
+ 0,
+ );
+ expectElementToReceivePointer(portalAction);
+};
+
+const expectPortalActionHiddenWhileScrollFrameStyleIsNone = async ({
+ scrollFrame,
+ propertyName,
+ portalAction,
+ ownerRoot,
+}: {
+ scrollFrame: HTMLElement;
+ propertyName: 'display' | 'pointer-events';
+ portalAction: Element;
+ ownerRoot: Element;
+}) => {
+ await waitForGeometryTrackerToIdle();
+
+ try {
+ scrollFrame.style.setProperty(propertyName, 'none');
+ await waitFor(() => expect(portalAction).not.toBeVisible());
+ } finally {
+ scrollFrame.style.removeProperty(propertyName);
+ }
+
+ await waitFor(() =>
+ expectPortalActionAtOwnerBottom({ portalAction, ownerRoot }),
+ );
+};
+
+const expectMenuAttachedToTriggerWithinPortalArea = ({
+ menu,
+ menuTrigger,
+ ownerRoot,
+}: {
+ menu: Element;
+ menuTrigger: Element;
+ ownerRoot: Element;
+}) => {
+ const menuRectangle = menu.getBoundingClientRect();
+ const menuTriggerRectangle = menuTrigger.getBoundingClientRect();
+ const ownerRectangle = ownerRoot.getBoundingClientRect();
+ const menuTriggerGap = Math.max(
+ menuRectangle.top - menuTriggerRectangle.bottom,
+ menuTriggerRectangle.top - menuRectangle.bottom,
+ );
+
+ expect(menuTriggerGap).toBeGreaterThanOrEqual(0);
+ expect(menuTriggerGap).toBeLessThanOrEqual(MAXIMUM_MENU_TRIGGER_GAP);
+ expect(menuRectangle.left).toBeLessThan(menuTriggerRectangle.right);
+ expect(menuRectangle.right).toBeGreaterThan(menuTriggerRectangle.left);
+ expect(menuRectangle.top).toBeGreaterThanOrEqual(
+ ownerRectangle.top - FRONT_COMPONENT_PORTAL_MARGIN,
+ );
+ expect(menuRectangle.bottom).toBeLessThanOrEqual(
+ ownerRectangle.bottom + FRONT_COMPONENT_PORTAL_MARGIN,
+ );
+};
+
+export const portalBoundsTest: TwentyUiGalleryPlayFunction = async ({
+ canvasElement,
+}) => {
+ const canvas = within(canvasElement);
+ const hostDocument = canvasElement.ownerDocument;
+ const page = within(hostDocument.body);
+ await expectFrontComponentMounted(canvas);
+
+ const ownerRoot = canvas.getByRole('group', { name: 'Widget' });
+ const trigger = canvas.getByRole('button', { name: 'Toggle popup' });
+ await userEvent.click(trigger);
+ const portalAction = await page.findByRole('button', {
+ name: 'Portal action',
+ });
+ expect(portalAction).toBeVisible();
+ expect(ownerRoot).toContainElement(trigger);
+ expect(ownerRoot).not.toContainElement(portalAction);
+ await waitFor(() =>
+ expectPortalActionAtOwnerBottom({ portalAction, ownerRoot }),
+ );
+
+ const rootStyle = hostDocument.documentElement.style;
+ const previousZoom = rootStyle.getPropertyValue('zoom');
+ const previousScale = rootStyle.getPropertyValue('--t-zoom');
+
+ try {
+ rootStyle.setProperty('--t-zoom', '0.8');
+ rootStyle.setProperty('zoom', 'var(--t-zoom)');
+ await waitFor(() =>
+ expectPortalActionAtOwnerBottom({ portalAction, ownerRoot }),
+ );
+ } finally {
+ rootStyle.setProperty('zoom', previousZoom);
+ rootStyle.setProperty('--t-zoom', previousScale);
+ }
+
+ await waitFor(() =>
+ expectPortalActionAtOwnerBottom({ portalAction, ownerRoot }),
+ );
+
+ const scrollFrame = canvas.getByRole('region', {
+ name: 'Widget scroll frame',
+ });
+ await waitForGeometryTrackerToIdle();
+ scrollFrame.scrollTop = WIDGET_SCROLL_OFFSET;
+ await waitFor(() =>
+ expectPortalActionAtOwnerBottom({ portalAction, ownerRoot }),
+ );
+ scrollFrame.scrollTop = 0;
+ await waitFor(() =>
+ expectPortalActionAtOwnerBottom({ portalAction, ownerRoot }),
+ );
+
+ await expectPortalActionHiddenWhileScrollFrameStyleIsNone({
+ scrollFrame,
+ propertyName: 'display',
+ portalAction,
+ ownerRoot,
+ });
+ await expectPortalActionHiddenWhileScrollFrameStyleIsNone({
+ scrollFrame,
+ propertyName: 'pointer-events',
+ portalAction,
+ ownerRoot,
+ });
+
+ await userEvent.click(portalAction);
+ await waitFor(() =>
+ expect(
+ canvas.getByRole('status', { name: 'Portal actions' }),
+ ).toHaveTextContent('Portal actions: 1'),
+ );
+ await userEvent.click(trigger);
+ await waitFor(() =>
+ expect(page.queryByRole('button', { name: 'Portal action' })).toBeNull(),
+ );
+
+ const menuTrigger = canvas.getByRole('button', { name: 'Open menu' });
+ await userEvent.click(menuTrigger);
+ const firstMenuItem = await page.findByRole('menuitem', {
+ name: 'Menu item 1',
+ });
+ await waitFor(() => {
+ expectElementToReceivePointer(firstMenuItem);
+ expectMenuAttachedToTriggerWithinPortalArea({
+ menu: page.getByRole('menu'),
+ menuTrigger,
+ ownerRoot,
+ });
+ });
+ await userEvent.click(firstMenuItem);
+ await waitFor(() => expect(page.queryByRole('menu')).toBeNull());
+
+ const hostAction = canvas.getByRole('button', { name: 'Host action' });
+ expectElementToReceivePointer(hostAction);
+ await userEvent.click(
+ canvas.getByRole('button', { name: 'Fill portal area' }),
+ );
+ const oversizedPortal = await page.findByRole('button', {
+ name: 'Oversized portal',
+ });
+ expect(oversizedPortal.getBoundingClientRect().width).toBe(4000);
+ const ownerRectangle = ownerRoot.getBoundingClientRect();
+ expect(
+ oversizedPortal.contains(
+ hostDocument.elementFromPoint(
+ ownerRectangle.left + ownerRectangle.width / 2,
+ ownerRectangle.top + ownerRectangle.height / 2,
+ ),
+ ),
+ ).toBe(true);
+ expectElementToReceivePointer(hostAction);
+ await userEvent.click(hostAction);
+ expect(
+ canvas.getByRole('status', { name: 'Host actions' }),
+ ).toHaveTextContent('Host actions: 1');
+ expect(errorHandler).not.toHaveBeenCalled();
+};
diff --git a/packages/twenty-front-component-renderer/src/constants/FrontComponentPortalMargin.ts b/packages/twenty-front-component-renderer/src/constants/FrontComponentPortalMargin.ts
new file mode 100644
index 00000000000..b2449c6f950
--- /dev/null
+++ b/packages/twenty-front-component-renderer/src/constants/FrontComponentPortalMargin.ts
@@ -0,0 +1 @@
+export const FRONT_COMPONENT_PORTAL_MARGIN = 200;
diff --git a/packages/twenty-front-component-renderer/src/constants/RemoteRenderContainerTag.ts b/packages/twenty-front-component-renderer/src/constants/RemoteRenderContainerTag.ts
new file mode 100644
index 00000000000..2caa2cc7482
--- /dev/null
+++ b/packages/twenty-front-component-renderer/src/constants/RemoteRenderContainerTag.ts
@@ -0,0 +1 @@
+export const REMOTE_RENDER_CONTAINER_TAG = 'remote-fragment';
diff --git a/packages/twenty-front-component-renderer/src/host/components/FrontComponentRemoteRootRenderer.tsx b/packages/twenty-front-component-renderer/src/host/components/FrontComponentRemoteRootRenderer.tsx
new file mode 100644
index 00000000000..92bee3282e6
--- /dev/null
+++ b/packages/twenty-front-component-renderer/src/host/components/FrontComponentRemoteRootRenderer.tsx
@@ -0,0 +1,60 @@
+import { NODE_TYPE_ELEMENT } from '@remote-dom/core';
+import {
+ renderRemoteNode,
+ useRemoteReceived,
+ type RemoteReceiverNode,
+ type RemoteRootRendererProps as FrontComponentRemoteRootRendererProps,
+} from '@remote-dom/react/host';
+import { type CSSProperties, useContext } from 'react';
+import { createPortal } from 'react-dom';
+import { isNonEmptyArray } from 'twenty-shared/utils';
+
+import { FRONT_COMPONENT_PORTAL_MARGIN } from '@/constants/FrontComponentPortalMargin';
+import { REMOTE_RENDER_CONTAINER_TAG } from '@/constants/RemoteRenderContainerTag';
+import { FrontComponentGeometryTrackerContext } from '@/host/geometry/contexts/FrontComponentGeometryTrackerContext';
+
+const PORTAL_LAYER_Z_INDEX = 38;
+
+const PORTAL_LAYER_STYLE: CSSProperties = {
+ position: 'fixed',
+ contain: 'layout',
+ zIndex: PORTAL_LAYER_Z_INDEX,
+ pointerEvents: 'none',
+ clipPath: `inset(calc(-${FRONT_COMPONENT_PORTAL_MARGIN}px / var(--t-zoom, 1)))`,
+};
+
+const PORTAL_CONTENT_STYLE: CSSProperties = {
+ display: 'contents',
+ pointerEvents: 'auto',
+};
+
+const isRemoteRenderContainer = (child: RemoteReceiverNode) =>
+ child.type === NODE_TYPE_ELEMENT &&
+ child.element === REMOTE_RENDER_CONTAINER_TAG;
+
+export const FrontComponentRemoteRootRenderer = (
+ props: FrontComponentRemoteRootRendererProps,
+) => {
+ const geometryTracker = useContext(FrontComponentGeometryTrackerContext);
+ const root = useRemoteReceived(props.receiver.root, props.receiver);
+ const children = root?.children ?? [];
+ const renderContainers = children.filter(isRemoteRenderContainer);
+ const portalChildren = children.filter(
+ (child) => !isRemoteRenderContainer(child),
+ );
+
+ return (
+ <>
+ {renderContainers.map((child) => renderRemoteNode(child, props))}
+ {isNonEmptyArray(portalChildren) &&
+ createPortal(
+ <div ref={geometryTracker?.setPortalLayer} style={PORTAL_LAYER_STYLE}>
+ <div style={PORTAL_CONTENT_STYLE}>
+ {portalChildren.map((child) => renderRemoteNode(child, props))}
+ </div>
+ </div>,
+ document.body,
+ )}
+ </>
+ );
+};
diff --git a/packages/twenty-front-component-renderer/src/host/components/FrontComponentRenderer.tsx b/packages/twenty-front-component-renderer/src/host/components/FrontComponentRenderer.tsx
index 9ea50865e21..8e0d9b80587 100644
--- a/packages/twenty-front-component-renderer/src/host/components/FrontComponentRenderer.tsx
+++ b/packages/twenty-front-component-renderer/src/host/components/FrontComponentRenderer.tsx
@@ -1,4 +1,5 @@
import { ROOT_CONTAINER_STYLE } from '@/host/constants/RootContainerStyle';
+import { FrontComponentRemoteRootRenderer } from '@/host/components/FrontComponentRemoteRootRenderer';
import { FrontComponentGeometryTrackerContext } from '@/host/geometry/contexts/FrontComponentGeometryTrackerContext';
import { createGeometryTracker } from '@/host/geometry/utils/createGeometryTracker';
import { FrontComponentHostFocusControllerContext } from '@/host/focus/contexts/FrontComponentHostFocusControllerContext';
@@ -16,10 +17,7 @@ import { type FrontComponentHostCommunicationApi } from '@/types/FrontComponentH
import { type FrontComponentThread } from '@/types/FrontComponentThread';
import { type SdkClientUrls } from '@/types/SdkClientUrls';
import { type FrontComponentExecutionContext } from 'twenty-sdk/front-component';
-import {
- type RemoteReceiver,
- RemoteRootRenderer,
-} from '@remote-dom/react/host';
+import { type RemoteReceiver } from '@remote-dom/react/host';
import { type ReactNode, useState } from 'react';
import { ErrorBoundary } from 'react-error-boundary';
import { isDefined } from 'twenty-shared/utils';
@@ -160,7 +158,7 @@ export const FrontComponentRenderer = ({
<FrontComponentHostFocusControllerContext.Provider
value={hostFocusController}
>
- <RemoteRootRenderer
+ <FrontComponentRemoteRootRenderer
receiver={receiver}
components={fallbackComponentRegistry}
/>
diff --git a/packages/twenty-front-component-renderer/src/host/geometry/types/GeometryTracker.ts b/packages/twenty-front-component-renderer/src/host/geometry/types/GeometryTracker.ts
index 19c6588272e..de6dd060bdd 100644
--- a/packages/twenty-front-component-renderer/src/host/geometry/types/GeometryTracker.ts
+++ b/packages/twenty-front-component-renderer/src/host/geometry/types/GeometryTracker.ts
@@ -11,6 +11,7 @@ export type GeometryTracker = {
observe: (remoteElementIds: unknown) => void;
unobserve: (remoteElementIds: unknown) => void;
setRoot: ElementRefCallback;
+ setPortalLayer: (element: HTMLElement | null) => void;
setPushGeometryUpdates: (
pushGeometryUpdates: PushGeometryUpdates | null,
) => void;
diff --git a/packages/twenty-front-component-renderer/src/host/geometry/types/GeometryWakeSources.ts b/packages/twenty-front-component-renderer/src/host/geometry/types/GeometryWakeSources.ts
index 835f24519df..46a16c2f101 100644
--- a/packages/twenty-front-component-renderer/src/host/geometry/types/GeometryWakeSources.ts
+++ b/packages/twenty-front-component-renderer/src/host/geometry/types/GeometryWakeSources.ts
@@ -2,6 +2,8 @@ export type GeometryWakeSources = {
attachViewportSources: () => void;
attachElementSources: () => void;
detachElementSources: () => void;
+ attachPortalLayerSources: () => void;
+ detachPortalLayerSources: () => void;
detachAllSources: () => void;
setRoot: (node: Element | null) => void;
startObservingNode: (node: Element) => void;
diff --git a/packages/twenty-front-component-renderer/src/host/geometry/utils/__tests__/createGeometryTracker.test.ts b/packages/twenty-front-component-renderer/src/host/geometry/utils/__tests__/createGeometryTracker.test.ts
index 049b9f48f3c..e1323ad949f 100644
--- a/packages/twenty-front-component-renderer/src/host/geometry/utils/__tests__/createGeometryTracker.test.ts
+++ b/packages/twenty-front-component-renderer/src/host/geometry/utils/__tests__/createGeometryTracker.test.ts
@@ -43,6 +43,94 @@ describe('createGeometryTracker', () => {
expect(geometryGlobals.getScheduledFrameCount()).toBe(0);
});
+ it('should place the portal layer on the root container and follow it on the next frame', () => {
+ const { tracker } = createArmedTracker();
+ const root = geometryGlobals.createStubNode({
+ x: 20,
+ y: 30,
+ width: 320,
+ height: 180,
+ });
+ const portalLayer = document.createElement('div');
+ tracker.setRoot(root.node);
+ tracker.setPortalLayer(portalLayer);
+
+ expect(portalLayer.style.left).toBe('calc(20px / var(--t-zoom, 1))');
+ expect(portalLayer.style.top).toBe('calc(30px / var(--t-zoom, 1))');
+
+ root.setGeometry({ x: 40, y: 50, width: 360, height: 220 });
+ geometryGlobals.flushAnimationFrame();
+
+ expect(portalLayer.style.left).toBe('calc(40px / var(--t-zoom, 1))');
+ expect(portalLayer.style.top).toBe('calc(50px / var(--t-zoom, 1))');
+ expect(portalLayer.style.width).toBe('calc(360px / var(--t-zoom, 1))');
+ expect(portalLayer.style.height).toBe('calc(220px / var(--t-zoom, 1))');
+ });
+
+ it('should hide the portal layer while the root container is not interactive', () => {
+ const { tracker } = createArmedTracker();
+ const root = geometryGlobals.createStubNode({
+ x: 20,
+ y: 30,
+ width: 320,
+ height: 180,
+ });
+ root.node.getClientRects = () =>
+ [root.node.getBoundingClientRect()] as unknown as DOMRectList;
+ const portalLayer = document.createElement('div');
+ tracker.setRoot(root.node);
+ tracker.setPortalLayer(portalLayer);
+
+ expect(portalLayer.style.display).toBe('');
+
+ root.node.style.pointerEvents = 'none';
+ geometryGlobals.flushAnimationFrame();
+
+ expect(portalLayer.style.display).toBe('none');
+
+ root.node.style.pointerEvents = '';
+ geometryGlobals.flushAnimationFrame();
+
+ expect(portalLayer.style.display).toBe('');
+ });
+
+ it('should resume scheduling on scroll only while a portal layer is mounted', () => {
+ const { tracker } = createArmedTracker();
+ tracker.setPortalLayer(document.createElement('div'));
+ flushFrames(GEOMETRY_IDLE_FRAME_THRESHOLD + 2);
+ expect(geometryGlobals.getScheduledFrameCount()).toBe(0);
+
+ document.dispatchEvent(new Event('scroll'));
+ expect(geometryGlobals.getScheduledFrameCount()).toBe(1);
+
+ flushFrames(GEOMETRY_IDLE_FRAME_THRESHOLD + 2);
+ tracker.setPortalLayer(null);
+
+ document.dispatchEvent(new Event('scroll'));
+ expect(geometryGlobals.getScheduledFrameCount()).toBe(0);
+ });
+
+ it('should keep resuming on scroll for a portal layer after the last id is unobserved', () => {
+ const { tracker } = createArmedTracker();
+ const stub = geometryGlobals.createStubNode({
+ x: 0,
+ y: 0,
+ width: 10,
+ height: 10,
+ });
+
+ tracker.registerNode('1', stub.node);
+ tracker.observe(['1']);
+ tracker.setPortalLayer(document.createElement('div'));
+ tracker.unobserve(['1']);
+ flushFrames(GEOMETRY_IDLE_FRAME_THRESHOLD + 2);
+ expect(geometryGlobals.getScheduledFrameCount()).toBe(0);
+
+ document.dispatchEvent(new Event('scroll'));
+
+ expect(geometryGlobals.getScheduledFrameCount()).toBe(1);
+ });
+
it('should find the remote element id of a node through its nearest registered ancestor', () => {
const tracker = createGeometryTracker();
const tabList = document.createElement('div');
diff --git a/packages/twenty-front-component-renderer/src/host/geometry/utils/__tests__/isRootContainerInteractive.test.ts b/packages/twenty-front-component-renderer/src/host/geometry/utils/__tests__/isRootContainerInteractive.test.ts
new file mode 100644
index 00000000000..917e814f7aa
--- /dev/null
+++ b/packages/twenty-front-component-renderer/src/host/geometry/utils/__tests__/isRootContainerInteractive.test.ts
@@ -0,0 +1,42 @@
+import { isRootContainerInteractive } from '../isRootContainerInteractive';
+
+const createRootContainer = ({ isRendered }: { isRendered: boolean }) => {
+ const rootContainer = document.createElement('div');
+ document.body.append(rootContainer);
+
+ rootContainer.getClientRects = () =>
+ (isRendered
+ ? [rootContainer.getBoundingClientRect()]
+ : []) as unknown as DOMRectList;
+
+ return rootContainer;
+};
+
+describe('isRootContainerInteractive', () => {
+ beforeEach(() => {
+ document.body.innerHTML = '';
+ });
+
+ it('should be false without a root container', () => {
+ expect(isRootContainerInteractive(null)).toBe(false);
+ });
+
+ it('should be false when the root container is not rendered', () => {
+ expect(
+ isRootContainerInteractive(createRootContainer({ isRendered: false })),
+ ).toBe(false);
+ });
+
+ it('should be false when the root container ignores pointer events', () => {
+ const rootContainer = createRootContainer({ isRendered: true });
+ rootContainer.style.pointerEvents = 'none';
+
+ expect(isRootContainerInteractive(rootContainer)).toBe(false);
+ });
+
+ it('should be true when the root container is rendered and receives pointer events', () => {
+ expect(
+ isRootContainerInteractive(createRootContainer({ isRendered: true })),
+ ).toBe(true);
+ });
+});
diff --git a/packages/twenty-front-component-renderer/src/host/geometry/utils/createGeometryTracker.ts b/packages/twenty-front-component-renderer/src/host/geometry/utils/createGeometryTracker.ts
index 18c3a322941..69af31d7032 100644
--- a/packages/twenty-front-component-renderer/src/host/geometry/utils/createGeometryTracker.ts
+++ b/packages/twenty-front-component-renderer/src/host/geometry/utils/createGeometryTracker.ts
@@ -10,6 +10,7 @@ import { createGeometryWakeSources } from '@/host/geometry/utils/createGeometryW
import { isGeometrySnapshotEqualWithinEpsilon } from '@/host/geometry/utils/isGeometrySnapshotEqualWithinEpsilon';
import { measureNodeGeometry } from '@/host/geometry/utils/measureNodeGeometry';
import { measureViewportGeometry } from '@/host/geometry/utils/measureViewportGeometry';
+import { updateFrontComponentPortalLayer } from '@/host/geometry/utils/updateFrontComponentPortalLayer';
import { sanitizeRemoteElementIds } from '@/host/geometry/utils/sanitizeRemoteElementIds';
import { type ElementGeometrySnapshot } from '@/types/ElementGeometrySnapshot';
import { type ViewportGeometrySnapshot } from '@/types/ViewportGeometrySnapshot';
@@ -22,6 +23,7 @@ export const createGeometryTracker = (): GeometryTracker => {
const unregisteredObservedFrameCounts = new Map<string, number>();
let rootContainer: Element | null = null;
+ let portalLayer: HTMLElement | null = null;
let pushGeometryUpdates: PushGeometryUpdates | null = null;
let lastViewportSnapshot: ViewportGeometrySnapshot | null = null;
let animationFrameHandle: number | null = null;
@@ -54,6 +56,11 @@ export const createGeometryTracker = (): GeometryTracker => {
}
const viewport = readViewportGeometry();
+
+ if (isDefined(portalLayer)) {
+ updateFrontComponentPortalLayer({ portalLayer, rootContainer, viewport });
+ }
+
const rootContainerOrigin = {
x: viewport.rootContainerX,
y: viewport.rootContainerY,
@@ -234,6 +241,23 @@ export const createGeometryTracker = (): GeometryTracker => {
wakeSources.setRoot(node);
};
+ const setPortalLayer = (element: HTMLElement | null): void => {
+ portalLayer = element;
+
+ if (!isDefined(element)) {
+ wakeSources.detachPortalLayerSources();
+ return;
+ }
+
+ updateFrontComponentPortalLayer({
+ portalLayer: element,
+ rootContainer,
+ viewport: readViewportGeometry(),
+ });
+ wakeSources.attachPortalLayerSources();
+ wake();
+ };
+
const setPushGeometryUpdates = (
nextPushGeometryUpdates: PushGeometryUpdates | null,
): void => {
@@ -245,7 +269,7 @@ export const createGeometryTracker = (): GeometryTracker => {
wakeSources.attachViewportSources();
- if (observedRemoteElementIds.size > 0) {
+ if (observedRemoteElementIds.size > 0 || isDefined(portalLayer)) {
wake();
}
};
@@ -280,6 +304,7 @@ export const createGeometryTracker = (): GeometryTracker => {
observe,
unobserve,
setRoot,
+ setPortalLayer,
setPushGeometryUpdates,
getViewportGeometry: readViewportGeometry,
reset,
diff --git a/packages/twenty-front-component-renderer/src/host/geometry/utils/createGeometryWakeSources.ts b/packages/twenty-front-component-renderer/src/host/geometry/utils/createGeometryWakeSources.ts
index bae71db31a8..115da9e94bd 100644
--- a/packages/twenty-front-component-renderer/src/host/geometry/utils/createGeometryWakeSources.ts
+++ b/packages/twenty-front-component-renderer/src/host/geometry/utils/createGeometryWakeSources.ts
@@ -20,6 +20,11 @@ const MUTATION_OBSERVER_OPTIONS: MutationObserverInit = {
characterData: true,
};
+const ROOT_ANCESTOR_MUTATION_OBSERVER_OPTIONS: MutationObserverInit = {
+ attributes: true,
+ attributeFilter: ['class', 'style', 'hidden'],
+};
+
export const createGeometryWakeSources = (
onWake: () => void,
): GeometryWakeSources => {
@@ -32,9 +37,11 @@ export const createGeometryWakeSources = (
let rootContainer: Element | null = null;
let resizeObserver: ResizeObserver | null = null;
let mutationObserver: MutationObserver | null = null;
+ let rootAncestorMutationObserver: MutationObserver | null = null;
let documentStyleObserver: MutationObserver | null = null;
let areViewportSourcesAttached = false;
let areElementSourcesAttached = false;
+ let arePortalLayerSourcesAttached = false;
const isEventTargetRelevantToRoot = (target: EventTarget | null): boolean => {
if (!isDefined(rootContainer)) {
@@ -67,6 +74,15 @@ export const createGeometryWakeSources = (
onWake();
};
+ const syncScrollListener = (): void => {
+ if (areElementSourcesAttached || arePortalLayerSourcesAttached) {
+ document.addEventListener('scroll', handleScroll, true);
+ return;
+ }
+
+ document.removeEventListener('scroll', handleScroll, true);
+ };
+
const resolveResizeObserver = (): ResizeObserver | null => {
if (isDefined(resizeObserver) || typeof ResizeObserver !== 'function') {
return resizeObserver;
@@ -86,6 +102,30 @@ export const createGeometryWakeSources = (
mutationObserver.observe(node, MUTATION_OBSERVER_OPTIONS);
};
+ const observeRootAncestorMutations = (node: Element): void => {
+ if (typeof MutationObserver !== 'function') {
+ return;
+ }
+
+ rootAncestorMutationObserver = new MutationObserver(onWake);
+
+ for (
+ let ancestor = node.parentElement;
+ isDefined(ancestor);
+ ancestor = ancestor.parentElement
+ ) {
+ rootAncestorMutationObserver.observe(
+ ancestor,
+ ROOT_ANCESTOR_MUTATION_OBSERVER_OPTIONS,
+ );
+ }
+ };
+
+ const disconnectRootAncestorMutations = (): void => {
+ rootAncestorMutationObserver?.disconnect();
+ rootAncestorMutationObserver = null;
+ };
+
const startObservingNode = (node: Element): void => {
if (!areElementSourcesAttached || resizeObservedNodes.has(node)) {
return;
@@ -148,8 +188,7 @@ export const createGeometryWakeSources = (
}
areElementSourcesAttached = true;
-
- document.addEventListener('scroll', handleScroll, true);
+ syncScrollListener();
for (const eventType of ANIMATION_EVENT_TYPES) {
document.addEventListener(eventType, handleAnimationEvent, true);
@@ -166,8 +205,7 @@ export const createGeometryWakeSources = (
}
areElementSourcesAttached = false;
-
- document.removeEventListener('scroll', handleScroll, true);
+ syncScrollListener();
for (const eventType of ANIMATION_EVENT_TYPES) {
document.removeEventListener(eventType, handleAnimationEvent, true);
@@ -182,6 +220,29 @@ export const createGeometryWakeSources = (
resizeObservedNodes.clear();
};
+ const attachPortalLayerSources = (): void => {
+ if (arePortalLayerSourcesAttached) {
+ return;
+ }
+
+ arePortalLayerSourcesAttached = true;
+ syncScrollListener();
+
+ if (isDefined(rootContainer)) {
+ observeRootAncestorMutations(rootContainer);
+ }
+ };
+
+ const detachPortalLayerSources = (): void => {
+ if (!arePortalLayerSourcesAttached) {
+ return;
+ }
+
+ arePortalLayerSourcesAttached = false;
+ syncScrollListener();
+ disconnectRootAncestorMutations();
+ };
+
const detachAllSources = (): void => {
detachElementSources();
@@ -205,6 +266,7 @@ export const createGeometryWakeSources = (
mutationObserver?.disconnect();
mutationObserver = null;
+ disconnectRootAncestorMutations();
rootContainer = node;
@@ -219,12 +281,18 @@ export const createGeometryWakeSources = (
if (areElementSourcesAttached) {
observeRootMutations(node);
}
+
+ if (arePortalLayerSourcesAttached) {
+ observeRootAncestorMutations(node);
+ }
};
return {
attachViewportSources,
attachElementSources,
detachElementSources,
+ attachPortalLayerSources,
+ detachPortalLayerSources,
detachAllSources,
setRoot,
startObservingNode,
diff --git a/packages/twenty-front-component-renderer/src/host/geometry/utils/isRootContainerInteractive.ts b/packages/twenty-front-component-renderer/src/host/geometry/utils/isRootContainerInteractive.ts
new file mode 100644
index 00000000000..352a4ee861f
--- /dev/null
+++ b/packages/twenty-front-component-renderer/src/host/geometry/utils/isRootContainerInteractive.ts
@@ -0,0 +1,8 @@
+import { isDefined } from 'twenty-shared/utils';
+
+export const isRootContainerInteractive = (
+ rootContainer: Element | null,
+): boolean =>
+ isDefined(rootContainer) &&
+ rootContainer.getClientRects().length > 0 &&
+ getComputedStyle(rootContainer).pointerEvents !== 'none';
diff --git a/packages/twenty-front-component-renderer/src/host/geometry/utils/updateFrontComponentPortalLayer.ts b/packages/twenty-front-component-renderer/src/host/geometry/utils/updateFrontComponentPortalLayer.ts
new file mode 100644
index 00000000000..822feb9c145
--- /dev/null
+++ b/packages/twenty-front-component-renderer/src/host/geometry/utils/updateFrontComponentPortalLayer.ts
@@ -0,0 +1,20 @@
+import { isRootContainerInteractive } from '@/host/geometry/utils/isRootContainerInteractive';
+import { type ViewportGeometrySnapshot } from '@/types/ViewportGeometrySnapshot';
+
+export const updateFrontComponentPortalLayer = ({
+ portalLayer,
+ rootContainer,
+ viewport,
+}: {
+ portalLayer: HTMLElement;
+ rootContainer: Element | null;
+ viewport: ViewportGeometrySnapshot;
+}): void => {
+ portalLayer.style.display = isRootContainerInteractive(rootContainer)
+ ? ''
+ : 'none';
+ portalLayer.style.left = `calc(${viewport.rootContainerX}px / var(--t-zoom, 1))`;
+ portalLayer.style.top = `calc(${viewport.rootContainerY}px / var(--t-zoom, 1))`;
+ portalLayer.style.width = `calc(${viewport.rootContainerWidth}px / var(--t-zoom, 1))`;
+ portalLayer.style.height = `calc(${viewport.rootContainerHeight}px / var(--t-zoom, 1))`;
+};
diff --git a/packages/twenty-front-component-renderer/src/polyfills/geometry/types/FrontComponentPortalArea.ts b/packages/twenty-front-component-renderer/src/polyfills/geometry/types/FrontComponentPortalArea.ts
new file mode 100644
index 00000000000..9ac632adb1b
--- /dev/null
+++ b/packages/twenty-front-component-renderer/src/polyfills/geometry/types/FrontComponentPortalArea.ts
@@ -0,0 +1,6 @@
+export type FrontComponentPortalArea = {
+ x: number;
+ y: number;
+ width: number;
+ height: number;
+};
diff --git a/packages/twenty-front-component-renderer/src/polyfills/geometry/utils/__tests__/installVisualViewportPolyfill.test.ts b/packages/twenty-front-component-renderer/src/polyfills/geometry/utils/__tests__/installVisualViewportPolyfill.test.ts
new file mode 100644
index 00000000000..ade0beb96ee
--- /dev/null
+++ b/packages/twenty-front-component-renderer/src/polyfills/geometry/utils/__tests__/installVisualViewportPolyfill.test.ts
@@ -0,0 +1,99 @@
+import { FRONT_COMPONENT_PORTAL_MARGIN } from '@/constants/FrontComponentPortalMargin';
+import { createSubscriptionStub } from '@/testing/createSubscriptionStub';
+import { createViewportGeometrySnapshotFixture } from '@/testing/createViewportGeometrySnapshotFixture';
+import { createWorkerGeometryStoreStub } from '@/testing/createWorkerGeometryStoreStub';
+import { type ViewportGeometrySnapshot } from '@/types/ViewportGeometrySnapshot';
+import { installVisualViewportPolyfill } from '../installVisualViewportPolyfill';
+
+const createViewport = (
+ overrides: Partial<ViewportGeometrySnapshot> = {},
+): ViewportGeometrySnapshot =>
+ createViewportGeometrySnapshotFixture({
+ innerWidth: 1600,
+ innerHeight: 1200,
+ scrollX: 30,
+ scrollY: 40,
+ rootContainerX: 500,
+ rootContainerY: 400,
+ rootContainerWidth: 320,
+ rootContainerHeight: 180,
+ ...overrides,
+ });
+
+const installWithGeometryUpdates = (
+ readViewport: () => ViewportGeometrySnapshot | null,
+) => {
+ const geometryUpdates = createSubscriptionStub();
+ const polyfillWindow: Record<string, unknown> = {};
+ const globalScope: Record<string, unknown> = { window: polyfillWindow };
+
+ installVisualViewportPolyfill({
+ globalScope,
+ geometryStore: createWorkerGeometryStoreStub({
+ getViewportSnapshot: readViewport,
+ subscribeToGeometryUpdates: geometryUpdates.subscribe,
+ }),
+ });
+
+ return {
+ polyfillWindow,
+ visualViewport: globalScope.visualViewport as VisualViewport,
+ notifyGeometryUpdate: geometryUpdates.notify,
+ };
+};
+
+describe('installVisualViewportPolyfill', () => {
+ it('should report the area where body portals are visible on both the global scope and a distinct window', () => {
+ const { polyfillWindow, visualViewport } = installWithGeometryUpdates(() =>
+ createViewport(),
+ );
+
+ expect(polyfillWindow.visualViewport).toBe(visualViewport);
+ expect(visualViewport.offsetLeft).toBe(500 - FRONT_COMPONENT_PORTAL_MARGIN);
+ expect(visualViewport.offsetTop).toBe(400 - FRONT_COMPONENT_PORTAL_MARGIN);
+ expect(visualViewport.width).toBe(320 + 2 * FRONT_COMPONENT_PORTAL_MARGIN);
+ expect(visualViewport.height).toBe(180 + 2 * FRONT_COMPONENT_PORTAL_MARGIN);
+ expect(visualViewport.pageLeft).toBe(
+ 30 + 500 - FRONT_COMPONENT_PORTAL_MARGIN,
+ );
+ expect(visualViewport.pageTop).toBe(
+ 40 + 400 - FRONT_COMPONENT_PORTAL_MARGIN,
+ );
+ expect(visualViewport.scale).toBe(1);
+ });
+
+ it('should notify viewport listeners after every geometry update so positioned popups recompute', () => {
+ let viewport = createViewport();
+ const { visualViewport, notifyGeometryUpdate } = installWithGeometryUpdates(
+ () => viewport,
+ );
+ const scrollListener = jest.fn();
+ const resizeListener = jest.fn();
+ visualViewport.addEventListener('scroll', scrollListener);
+ visualViewport.addEventListener('resize', resizeListener);
+
+ notifyGeometryUpdate();
+ viewport = createViewport({ rootContainerY: 420 });
+ notifyGeometryUpdate();
+
+ expect(scrollListener).toHaveBeenCalledTimes(2);
+ expect(resizeListener).not.toHaveBeenCalled();
+
+ viewport = createViewport({ rootContainerHeight: 240 });
+ notifyGeometryUpdate();
+
+ expect(resizeListener).toHaveBeenCalledTimes(1);
+ expect(scrollListener).toHaveBeenCalledTimes(2);
+ });
+
+ it('should reflect a later viewport push without reinstalling', () => {
+ let viewport: ViewportGeometrySnapshot | null = null;
+ const { visualViewport } = installWithGeometryUpdates(() => viewport);
+
+ expect(visualViewport.width).toBe(0);
+
+ viewport = createViewport();
+
+ expect(visualViewport.width).toBe(320 + 2 * FRONT_COMPONENT_PORTAL_MARGIN);
+ });
+});
diff --git a/packages/twenty-front-component-renderer/src/polyfills/geometry/utils/__tests__/resolveFrontComponentPortalArea.test.ts b/packages/twenty-front-component-renderer/src/polyfills/geometry/utils/__tests__/resolveFrontComponentPortalArea.test.ts
new file mode 100644
index 00000000000..d3757c41327
--- /dev/null
+++ b/packages/twenty-front-component-renderer/src/polyfills/geometry/utils/__tests__/resolveFrontComponentPortalArea.test.ts
@@ -0,0 +1,69 @@
+import { FRONT_COMPONENT_PORTAL_MARGIN } from '@/constants/FrontComponentPortalMargin';
+import { createViewportGeometrySnapshotFixture } from '@/testing/createViewportGeometrySnapshotFixture';
+import { resolveFrontComponentPortalArea } from '../resolveFrontComponentPortalArea';
+
+describe('resolveFrontComponentPortalArea', () => {
+ it('should be empty before the first viewport push', () => {
+ expect(resolveFrontComponentPortalArea(null)).toEqual({
+ x: 0,
+ y: 0,
+ width: 0,
+ height: 0,
+ });
+ });
+
+ it('should extend the component box by the portal margin on every side', () => {
+ const portalArea = resolveFrontComponentPortalArea(
+ createViewportGeometrySnapshotFixture({
+ innerWidth: 1600,
+ innerHeight: 1200,
+ rootContainerX: 500,
+ rootContainerY: 400,
+ rootContainerWidth: 320,
+ rootContainerHeight: 180,
+ }),
+ );
+
+ expect(portalArea).toEqual({
+ x: 500 - FRONT_COMPONENT_PORTAL_MARGIN,
+ y: 400 - FRONT_COMPONENT_PORTAL_MARGIN,
+ width: 320 + 2 * FRONT_COMPONENT_PORTAL_MARGIN,
+ height: 180 + 2 * FRONT_COMPONENT_PORTAL_MARGIN,
+ });
+ });
+
+ it('should stop at the edges of the host viewport', () => {
+ const portalArea = resolveFrontComponentPortalArea(
+ createViewportGeometrySnapshotFixture({
+ innerWidth: 800,
+ innerHeight: 600,
+ rootContainerX: 40,
+ rootContainerY: 500,
+ rootContainerWidth: 700,
+ rootContainerHeight: 300,
+ }),
+ );
+
+ expect(portalArea).toEqual({
+ x: 0,
+ y: 500 - FRONT_COMPONENT_PORTAL_MARGIN,
+ width: 800,
+ height: 600 - (500 - FRONT_COMPONENT_PORTAL_MARGIN),
+ });
+ });
+
+ it('should be empty when the component is entirely outside the host viewport', () => {
+ const portalArea = resolveFrontComponentPortalArea(
+ createViewportGeometrySnapshotFixture({
+ innerWidth: 800,
+ innerHeight: 600,
+ rootContainerX: 100,
+ rootContainerY: 600 + FRONT_COMPONENT_PORTAL_MARGIN + 50,
+ rootContainerWidth: 320,
+ rootContainerHeight: 180,
+ }),
+ );
+
+ expect(portalArea.height).toBe(0);
+ });
+});
diff --git a/packages/twenty-front-component-renderer/src/polyfills/geometry/utils/installVisualViewportPolyfill.ts b/packages/twenty-front-component-renderer/src/polyfills/geometry/utils/installVisualViewportPolyfill.ts
new file mode 100644
index 00000000000..acde0f5d958
--- /dev/null
+++ b/packages/twenty-front-component-renderer/src/polyfills/geometry/utils/installVisualViewportPolyfill.ts
@@ -0,0 +1,60 @@
+import { type WorkerGeometryStore } from '@/polyfills/geometry/types/WorkerGeometryStore';
+import { resolveFrontComponentPortalArea } from '@/polyfills/geometry/utils/resolveFrontComponentPortalArea';
+import { resolveGlobalScopeInstallTargets } from '@/polyfills/utils/resolveGlobalScopeInstallTargets';
+
+type InstallVisualViewportPolyfillInput = {
+ globalScope: Record<string, unknown>;
+ geometryStore: WorkerGeometryStore;
+};
+
+export const installVisualViewportPolyfill = ({
+ globalScope,
+ geometryStore,
+}: InstallVisualViewportPolyfillInput): void => {
+ const visualViewport = new EventTarget();
+ const readPortalArea = () =>
+ resolveFrontComponentPortalArea(geometryStore.getViewportSnapshot());
+
+ Object.defineProperties(visualViewport, {
+ offsetLeft: { get: () => readPortalArea().x },
+ offsetTop: { get: () => readPortalArea().y },
+ pageLeft: {
+ get: () =>
+ readPortalArea().x +
+ (geometryStore.getViewportSnapshot()?.scrollX ?? 0),
+ },
+ pageTop: {
+ get: () =>
+ readPortalArea().y +
+ (geometryStore.getViewportSnapshot()?.scrollY ?? 0),
+ },
+ width: { get: () => readPortalArea().width },
+ height: { get: () => readPortalArea().height },
+ scale: { value: 1 },
+ });
+
+ let previousPortalArea = readPortalArea();
+
+ const dispatchGeometryChangeToViewportListeners = (): void => {
+ const portalArea = readPortalArea();
+ const hasPortalAreaResized =
+ portalArea.width !== previousPortalArea.width ||
+ portalArea.height !== previousPortalArea.height;
+
+ previousPortalArea = portalArea;
+ visualViewport.dispatchEvent(
+ new Event(hasPortalAreaResized ? 'resize' : 'scroll'),
+ );
+ };
+
+ geometryStore.subscribeToGeometryUpdates(
+ dispatchGeometryChangeToViewportListeners,
+ );
+
+ for (const installTarget of resolveGlobalScopeInstallTargets(globalScope)) {
+ Object.defineProperty(installTarget, 'visualViewport', {
+ value: visualViewport,
+ configurable: true,
+ });
+ }
+};
diff --git a/packages/twenty-front-component-renderer/src/polyfills/geometry/utils/resolveFrontComponentPortalArea.ts b/packages/twenty-front-component-renderer/src/polyfills/geometry/utils/resolveFrontComponentPortalArea.ts
new file mode 100644
index 00000000000..fe6580e0290
--- /dev/null
+++ b/packages/twenty-front-component-renderer/src/polyfills/geometry/utils/resolveFrontComponentPortalArea.ts
@@ -0,0 +1,41 @@
+import { isDefined } from 'twenty-shared/utils';
+
+import { FRONT_COMPONENT_PORTAL_MARGIN } from '@/constants/FrontComponentPortalMargin';
+import { type FrontComponentPortalArea } from '@/polyfills/geometry/types/FrontComponentPortalArea';
+import { type ViewportGeometrySnapshot } from '@/types/ViewportGeometrySnapshot';
+
+export const resolveFrontComponentPortalArea = (
+ viewport: ViewportGeometrySnapshot | null,
+): FrontComponentPortalArea => {
+ if (!isDefined(viewport)) {
+ return { x: 0, y: 0, width: 0, height: 0 };
+ }
+
+ const left = Math.max(
+ 0,
+ viewport.rootContainerX - FRONT_COMPONENT_PORTAL_MARGIN,
+ );
+ const top = Math.max(
+ 0,
+ viewport.rootContainerY - FRONT_COMPONENT_PORTAL_MARGIN,
+ );
+ const right = Math.min(
+ viewport.innerWidth,
+ viewport.rootContainerX +
+ viewport.rootContainerWidth +
+ FRONT_COMPONENT_PORTAL_MARGIN,
+ );
+ const bottom = Math.min(
+ viewport.innerHeight,
+ viewport.rootContainerY +
+ viewport.rootContainerHeight +
+ FRONT_COMPONENT_PORTAL_MARGIN,
+ );
+
+ return {
+ x: left,
+ y: top,
+ width: Math.max(0, right - left),
+ height: Math.max(0, bottom - top),
+ };
+};
diff --git a/packages/twenty-front-component-renderer/src/polyfills/style/utils/installStyleBridge.ts b/packages/twenty-front-component-renderer/src/polyfills/style/utils/installStyleBridge.ts
index 40bd261331d..eba3d89b624 100644
--- a/packages/twenty-front-component-renderer/src/polyfills/style/utils/installStyleBridge.ts
+++ b/packages/twenty-front-component-renderer/src/polyfills/style/utils/installStyleBridge.ts
@@ -1,9 +1,7 @@
-import { type RemoteRootElement } from '@remote-dom/core/elements';
-
import { type RemoteStyleProperties } from '@/remote/generated/remote-elements';
import { createMockCssStyleSheet } from '@/polyfills/style/utils/createMockCssStyleSheet';
-export const installStyleBridge = (remoteRoot: RemoteRootElement): void => {
+export const installStyleBridge = (styleContainer: Element): void => {
const styleElementMap = new WeakMap<
Element,
Element & RemoteStyleProperties
@@ -125,7 +123,7 @@ export const installStyleBridge = (remoteRoot: RemoteRootElement): void => {
remoteStyleElement.cssText = existingContent;
}
- remoteRoot.appendChild(remoteStyleElement);
+ styleContainer.appendChild(remoteStyleElement);
};
const untrackStyleElement = (styleElement: Element): void => {
diff --git a/packages/twenty-front-component-renderer/src/remote/worker/remote-worker.ts b/packages/twenty-front-component-renderer/src/remote/worker/remote-worker.ts
index 74c1ba5dcbe..1565c302ab0 100644
--- a/packages/twenty-front-component-renderer/src/remote/worker/remote-worker.ts
+++ b/packages/twenty-front-component-renderer/src/remote/worker/remote-worker.ts
@@ -41,6 +41,7 @@ import { installHostEventRetargetingPolyfill } from '@/polyfills/events/utils/in
import { installSelectorMethodsPolyfill } from '@/polyfills/selectors/utils/installSelectorMethodsPolyfill';
import { workerGeometryStore } from '@/polyfills/geometry/states/workerGeometryStore';
import { installElementGeometryPolyfill } from '@/polyfills/geometry/utils/installElementGeometryPolyfill';
+import { installVisualViewportPolyfill } from '@/polyfills/geometry/utils/installVisualViewportPolyfill';
import { installWindowGeometryPolyfill } from '@/polyfills/geometry/utils/installWindowGeometryPolyfill';
import { mediaQueryEnvironmentSource } from '@/polyfills/media-query/states/mediaQueryEnvironmentSource';
import { workerMediaBridge } from '@/polyfills/media/states/workerMediaBridge';
@@ -146,6 +147,11 @@ installWindowGeometryPolyfill({
geometryStore: workerGeometryStore,
});
+installVisualViewportPolyfill({
+ globalScope: toGlobalScopeRecord(globalThis),
+ geometryStore: workerGeometryStore,
+});
+
installWindowAliasesPolyfill({
globalScope: toGlobalScopeRecord(globalThis),
});
diff --git a/packages/twenty-front-component-renderer/src/remote/worker/rendering/utils/attachRemoteRenderRootToWorkerDocument.ts b/packages/twenty-front-component-renderer/src/remote/worker/rendering/utils/attachRemoteRenderRootToWorkerDocument.ts
index 4d1050e62a7..84387336428 100644
--- a/packages/twenty-front-component-renderer/src/remote/worker/rendering/utils/attachRemoteRenderRootToWorkerDocument.ts
+++ b/packages/twenty-front-component-renderer/src/remote/worker/rendering/utils/attachRemoteRenderRootToWorkerDocument.ts
@@ -1,9 +1,12 @@
+import { MUTATION_TYPE_UPDATE_PROPERTY, ROOT_ID } from '@remote-dom/core';
import {
BatchingRemoteConnection,
+ connectRemoteNode,
+ setRemoteId,
type RemoteConnection,
- type RemoteRootElement,
} from '@remote-dom/core/elements';
+import { REMOTE_RENDER_CONTAINER_TAG } from '@/constants/RemoteRenderContainerTag';
import { workerGeometryStore } from '@/polyfills/geometry/states/workerGeometryStore';
import { workerInputSelectionStore } from '@/polyfills/input-selection/states/workerInputSelectionStore';
import { workerFocusTransport } from '@/polyfills/dom/states/workerFocusTransport';
@@ -12,17 +15,30 @@ import { installStyleBridge } from '@/polyfills/style/utils/installStyleBridge';
export const attachRemoteRenderRootToWorkerDocument = (
connection: RemoteConnection,
): Element => {
- const batchedConnection = new BatchingRemoteConnection(connection);
- const remoteRoot = document.createElement('remote-root') as RemoteRootElement;
- const renderContainer = document.createElement('remote-fragment');
+ const batchedConnection = new BatchingRemoteConnection({
+ call: connection.call,
+ mutate: (records) =>
+ connection.mutate(
+ records.filter(([mutationType, remoteNodeId]) => {
+ const isRootPropertyUpdate =
+ mutationType === MUTATION_TYPE_UPDATE_PROPERTY &&
+ remoteNodeId === ROOT_ID;
- remoteRoot.connect(batchedConnection);
- remoteRoot.append(renderContainer);
- document.body.append(remoteRoot);
+ return !isRootPropertyUpdate;
+ }),
+ ),
+ });
+ const remoteRoot = document.body;
+ const renderContainer = document.createElement(REMOTE_RENDER_CONTAINER_TAG);
+ const styleContainer = document.createElement(REMOTE_RENDER_CONTAINER_TAG);
+
+ setRemoteId(remoteRoot, ROOT_ID);
+ connectRemoteNode(remoteRoot, batchedConnection);
+ remoteRoot.append(renderContainer, styleContainer);
workerGeometryStore.setRootElement(remoteRoot);
workerFocusTransport.setRootElement(remoteRoot);
workerInputSelectionStore.setRootElement(remoteRoot);
- installStyleBridge(remoteRoot);
+ installStyleBridge(styleContainer);
return renderContainer;
};
diff --git a/packages/twenty-front-component-renderer/src/testing/createGeometryTrackerStub.ts b/packages/twenty-front-component-renderer/src/testing/createGeometryTrackerStub.ts
index d4d5096d950..dedb47dc3d0 100644
--- a/packages/twenty-front-component-renderer/src/testing/createGeometryTrackerStub.ts
+++ b/packages/twenty-front-component-renderer/src/testing/createGeometryTrackerStub.ts
@@ -9,6 +9,7 @@ export const createGeometryTrackerStub = (): GeometryTracker => ({
observe: jest.fn(),
unobserve: jest.fn(),
setRoot: jest.fn(),
+ setPortalLayer: jest.fn(),
setPushGeometryUpdates: jest.fn(),
getViewportGeometry: jest.fn<ViewportGeometrySnapshot, []>(),
reset: jest.fn(),