Skip to content
New issue

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

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

Already on GitHub? Sign in to your account

[useAnchorPositioning] Ensure keepMounted is a private param #1410

Merged
merged 2 commits into from
Feb 5, 2025
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
5 changes: 5 additions & 0 deletions packages/react/src/menu/positioner/MenuPositioner.spec.tsx
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
import * as React from 'react';
import { Menu } from '@base-ui-components/react';

// @ts-expect-error - `keepMounted` should not be available
<Menu.Positioner keepMounted />;
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
import * as React from 'react';
import { Popover } from '@base-ui-components/react';

// @ts-expect-error - `keepMounted` should not be available
<Popover.Positioner keepMounted />;
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
import * as React from 'react';
import { PreviewCard } from '@base-ui-components/react';

// @ts-expect-error - `keepMounted` should not be available
<PreviewCard.Positioner keepMounted />;
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
import * as React from 'react';
import { Select } from '@base-ui-components/react';

// @ts-expect-error - `keepMounted` should not be available
<Select.Positioner keepMounted />;
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
import * as React from 'react';
import { Tooltip } from '@base-ui-components/react';

// @ts-expect-error - `keepMounted` should not be available
<Tooltip.Positioner keepMounted />;
8 changes: 2 additions & 6 deletions packages/react/src/utils/useAnchorPositioning.ts
Original file line number Diff line number Diff line change
Expand Up @@ -67,8 +67,8 @@ export function useAnchorPositioning(
collisionPadding = 5,
sticky = false,
arrowPadding = 5,
keepMounted = false,
// Private parameters
keepMounted = false,
floatingRootContext,
mounted,
trackAnchor = true,
Expand Down Expand Up @@ -422,14 +422,10 @@ export namespace useAnchorPositioning {
* @default true
*/
trackAnchor?: boolean;
/**
* Whether to keep the popup mounted in the DOM while it's hidden.
* @default false
*/
keepMounted?: boolean;
}

export interface Parameters extends SharedParameters {
keepMounted?: boolean;
trackCursorAxis?: 'none' | 'x' | 'y' | 'both';
floatingRootContext?: FloatingRootContext;
mounted: boolean;
Expand Down