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.

Sign up for GitHub

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

fix(react-popover): removes exposing of internal type FluentTriggerComponent #25411

Merged
merged 1 commit into from
Oct 31, 2022
Merged

fix(react-popover): removes exposing of internal type FluentTriggerComponent #25411

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
7 changes: 7 additions & 0 deletions change/@fluentui-react-popover-4a2a3285-fde0-4d76-ae6d-aaac8c82c420.json
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,7 @@
{
"type": "minor",
"comment": "removes exposing of internal type FluentTriggerComponent",
"packageName": "@fluentui/react-popover",
"email": "[email protected]",
"dependentChangeType": "patch"
}
7 changes: 3 additions & 4 deletions packages/react-components/react-popover/etc/react-popover.api.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,6 @@ import type { ComponentProps } from '@fluentui/react-utilities';
import type { ComponentState } from '@fluentui/react-utilities';
import type { ContextSelector } from '@fluentui/react-context-selector';
import { FC } from 'react';
import type { FluentTriggerComponent } from '@fluentui/react-utilities';
import type { ForwardRefComponent } from '@fluentui/react-utilities';
import { JSXElementConstructor } from 'react';
import type { PortalProps } from '@fluentui/react-portal';
Expand All @@ -20,11 +19,11 @@ import { Provider } from 'react';
import { ProviderProps } from 'react';
import * as React_2 from 'react';
import { ReactElement } from 'react';
import type { SetVirtualMouseTarget } from '@fluentui/react-positioning';
import type { Slot } from '@fluentui/react-utilities';
import type { SlotClassNames } from '@fluentui/react-utilities';
import type { TriggerProps } from '@fluentui/react-utilities';
import type { UseModalAttributesOptions } from '@fluentui/react-tabster';
import type { usePositioningMouseTarget } from '@fluentui/react-positioning';

// @public (undocumented)
export const arrowHeights: Record<PopoverSize, number>;
Expand Down Expand Up @@ -75,7 +74,7 @@ export type PopoverState = Pick<PopoverProps, 'appearance' | 'mountNode' | 'onOp
contextTarget: PositioningVirtualElement | undefined;
popoverSurface: React_2.ReactElement | undefined;
popoverTrigger: React_2.ReactElement | undefined;
setContextTarget: ReturnType<typeof usePositioningMouseTarget>[1];
setContextTarget: SetVirtualMouseTarget;
setOpen: (e: OpenPopoverEvents, open: boolean) => void;
size: NonNullable<PopoverProps['size']>;
toggleOpen: (e: OpenPopoverEvents) => void;
Expand All @@ -102,7 +101,7 @@ export type PopoverSurfaceState = ComponentState<PopoverSurfaceSlots> & Pick<Pop
};

// @public
export const PopoverTrigger: React_2.FC<PopoverTriggerProps> & FluentTriggerComponent;
export const PopoverTrigger: React_2.FC<PopoverTriggerProps>;

// @public
export type PopoverTriggerChildProps<Type extends ARIAButtonType = ARIAButtonType, Props = {}> = ARIAButtonResultProps<Type, Props & {
Expand Down
4 changes: 2 additions & 2 deletions packages/react-components/react-popover/src/components/Popover/Popover.types.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@ import * as React from 'react';
import type {
PositioningVirtualElement,
PositioningShorthand,
usePositioningMouseTarget,
SetVirtualMouseTarget,
} from '@fluentui/react-positioning';
import type { PortalProps } from '@fluentui/react-portal';
import type { UseModalAttributesOptions } from '@fluentui/react-tabster';
Expand Down Expand Up @@ -157,7 +157,7 @@ export type PopoverState = Pick<
/**
* A callback to set the target of the popper to the mouse click for context events
*/
setContextTarget: ReturnType<typeof usePositioningMouseTarget>[1];
setContextTarget: SetVirtualMouseTarget;

/**
* Callback to open/close the Popover
Expand Down
5 changes: 3 additions & 2 deletions packages/react-components/react-popover/src/components/PopoverTrigger/PopoverTrigger.tsx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -7,11 +7,12 @@ import type { PopoverTriggerProps } from './PopoverTrigger.types';
/**
* Wraps a trigger element as an only child and adds the necessary event handling to open a popover.
*/
export const PopoverTrigger: React.FC<PopoverTriggerProps> & FluentTriggerComponent = props => {
export const PopoverTrigger: React.FC<PopoverTriggerProps> = props => {
const state = usePopoverTrigger_unstable(props);

return renderPopoverTrigger_unstable(state);
};

PopoverTrigger.displayName = 'PopoverTrigger';
PopoverTrigger.isFluentTriggerComponent = true;
// type casting here is required to ensure internal type FluentTriggerComponent is not leaked
(PopoverTrigger as FluentTriggerComponent).isFluentTriggerComponent = true;