Skip to content

feat: trigger support nativeElement #435

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

Merged
merged 1 commit into from
Oct 26, 2023
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
15 changes: 11 additions & 4 deletions src/index.tsx
Original file line number Diff line number Diff line change
Expand Up @@ -10,6 +10,8 @@ import useLayoutEffect from 'rc-util/lib/hooks/useLayoutEffect';
import isMobile from 'rc-util/lib/isMobile';
import * as React from 'react';
import { flushSync } from 'react-dom';
import Popup from './Popup';
import TriggerWrapper from './TriggerWrapper';
import type { TriggerContextProps } from './context';
import TriggerContext from './context';
import useAction from './hooks/useAction';
Expand All @@ -25,18 +27,17 @@ import type {
BuildInPlacements,
TransitionNameType,
} from './interface';
import Popup from './Popup';
import TriggerWrapper from './TriggerWrapper';
import { getAlignPopupClassName, getMotion } from './util';

export type {
BuildInPlacements,
AlignType,
ActionType,
AlignType,
ArrowTypeOuter as ArrowType,
BuildInPlacements,
};

export interface TriggerRef {
nativeElement: HTMLElement;
forceAlign: VoidFunction;
}

Expand Down Expand Up @@ -251,9 +252,13 @@ export function generateTrigger(
// Use state to control here since `useRef` update not trigger render
const [targetEle, setTargetEle] = React.useState<HTMLElement>(null);

// Used for forwardRef target. Not use internal
const externalForwardRef = React.useRef<HTMLElement>(null);

const setTargetRef = useEvent((node: HTMLElement) => {
if (isDOM(node) && targetEle !== node) {
setTargetEle(node);
externalForwardRef.current = node;
}
});

Expand Down Expand Up @@ -448,7 +453,9 @@ export function generateTrigger(
alignPoint,
]);

// ============================ Refs ============================
React.useImperativeHandle(ref, () => ({
nativeElement: externalForwardRef.current,
forceAlign: triggerAlign,
}));

Expand Down
39 changes: 39 additions & 0 deletions tests/ref.test.tsx
Original file line number Diff line number Diff line change
@@ -0,0 +1,39 @@
/* eslint-disable max-classes-per-file */

import { cleanup, render } from '@testing-library/react';
import { spyElementPrototypes } from 'rc-util/lib/test/domHook';
import React from 'react';
import Trigger, { type TriggerRef } from '../src';

describe('Trigger.Ref', () => {
beforeAll(() => {
spyElementPrototypes(HTMLElement, {
offsetParent: {
get: () => document.body,
},
});
});

beforeEach(() => {
jest.useFakeTimers();
});

afterEach(() => {
cleanup();
jest.useRealTimers();
});

it('support nativeElement', () => {
const triggerRef = React.createRef<TriggerRef>();

const { container } = render(
<Trigger ref={triggerRef} popup={<div />}>
<button />
</Trigger>,
);

expect(triggerRef.current.nativeElement).toBe(
container.querySelector('button'),
);
});
});