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-positioning): exposes new typings to avoid exposing internal methods #25407

Merged
merged 1 commit into from
Oct 28, 2022
Merged

fix(react-positioning): exposes new typings to avoid exposing internal methods #25407

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-positioning-12f69b12-6e86-4415-8a0d-b34318f3b71e.json
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,7 @@
{
"type": "minor",
"comment": "exposes new typings to avoid exposing internal methods",
"packageName": "@fluentui/react-positioning",
"email": "[email protected]",
"dependentChangeType": "patch"
}
5 changes: 4 additions & 1 deletion packages/react-components/react-positioning/etc/react-positioning.api.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -101,6 +101,9 @@ export type PositioningVirtualElement = {
// @public (undocumented)
export function resolvePositioningShorthand(shorthand: PositioningShorthand | undefined | null): Readonly<PositioningProps>;

// @public (undocumented)
export type SetVirtualMouseTarget = (event: React_2.MouseEvent | MouseEvent | undefined | null) => void;

// @internal (undocumented)
export function usePositioning(options: UsePositioningOptions): {
targetRef: React_2.MutableRefObject<any>;
Expand All @@ -109,7 +112,7 @@ export function usePositioning(options: UsePositioningOptions): {
};

// @internal
export const usePositioningMouseTarget: (initialState?: PositioningVirtualElement | (() => PositioningVirtualElement) | undefined) => readonly [PositioningVirtualElement | undefined, (event: React_2.MouseEvent | MouseEvent | undefined | null) => void];
export const usePositioningMouseTarget: (initialState?: PositioningVirtualElement | (() => PositioningVirtualElement) | undefined) => readonly [PositioningVirtualElement | undefined, SetVirtualMouseTarget];

// (No @packageDocumentation comment for this package)

Expand Down
1 change: 1 addition & 0 deletions packages/react-components/react-positioning/src/index.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -19,4 +19,5 @@ export type {
PositioningShorthand,
PositioningShorthandValue,
PositioningVirtualElement,
SetVirtualMouseTarget,
} from './types';
2 changes: 2 additions & 0 deletions packages/react-components/react-positioning/src/types.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -57,6 +57,8 @@ export type PositioningVirtualElement = {
contextElement?: Element;
};

export type SetVirtualMouseTarget = (event: React.MouseEvent | MouseEvent | undefined | null) => void;

export interface PositioningOptions {
/** Alignment for the component. Only has an effect if used with the @see position option */
align?: Alignment;
Expand Down
4 changes: 2 additions & 2 deletions packages/react-components/react-positioning/src/usePositioningMouseTarget.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
import * as React from 'react';
import { createVirtualElementFromClick } from './createVirtualElementFromClick';
import { PositioningVirtualElement } from './types';
import { PositioningVirtualElement, SetVirtualMouseTarget } from './types';

/**
* @internal
Expand All @@ -16,7 +16,7 @@ export const usePositioningMouseTarget = (
) => {
const [virtualElement, setVirtualElement] = React.useState<PositioningVirtualElement | undefined>(initialState);

const setVirtualMouseTarget = (event: React.MouseEvent | MouseEvent | undefined | null) => {
const setVirtualMouseTarget: SetVirtualMouseTarget = event => {
if (event === undefined || event === null) {
setVirtualElement(undefined);
return;
Expand Down