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

[NumberField] Correct virtual cursor rendering #1484

Open
wants to merge 10 commits into
base: master
Choose a base branch
from
Open
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
2 changes: 2 additions & 0 deletions packages/react/src/number-field/root/useNumberFieldRoot.ts
Original file line number Diff line number Diff line change
Expand Up @@ -929,6 +929,8 @@ export namespace useNumberFieldRoot {
inputValue: string;
value: number | null;
isScrubbing: boolean;
isTouchInput: boolean;
isPointerLockDenied: boolean;
inputRef: ((instance: HTMLInputElement | null) => void) | null;
scrubHandleRef: React.RefObject<ScrubHandle | null>;
scrubAreaRef: React.RefObject<HTMLSpanElement | null>;
Expand Down
16 changes: 12 additions & 4 deletions packages/react/src/number-field/root/useScrub.ts
Original file line number Diff line number Diff line change
Expand Up @@ -31,6 +31,8 @@ export function useScrub(params: ScrubParams) {

const [isScrubbing, setIsScrubbing] = React.useState(false);
const [cursorTransform, setCursorTransform] = React.useState('');
const [isTouchInput, setIsTouchInput] = React.useState(false);
const [isPointerLockDenied, setIsPointerLockDenied] = React.useState(false);

React.useEffect(() => {
return () => {
Expand Down Expand Up @@ -126,6 +128,9 @@ export function useScrub(params: ScrubParams) {
return;
}

const isTouch = event.pointerType === 'touch';
setIsTouchInput(isTouch);

if (event.pointerType === 'mouse') {
event.preventDefault();
inputRef.current?.focus();
Expand All @@ -135,7 +140,7 @@ export function useScrub(params: ScrubParams) {
onScrubbingChange(true, event.nativeEvent);

// WebKit causes significant layout shift with the native message, so we can't use it.
if (!isWebKit()) {
if (!isTouch && !isWebKit()) {
// There can be some frames where there's no cursor at all when requesting the pointer lock.
// This is a workaround to avoid flickering.
avoidFlickerTimeoutRef.current = window.setTimeout(async () => {
Expand All @@ -146,8 +151,9 @@ export function useScrub(params: ScrubParams) {
// We need to await it even though it doesn't appear to return a promise in the
// types in order for the `catch` to work.
await ownerDocument(scrubAreaRef.current).body.requestPointerLock();
} catch {
//
setIsPointerLockDenied(false);
} catch (error) {
setIsPointerLockDenied(true);
}
}, 20);
}
Expand Down Expand Up @@ -275,12 +281,14 @@ export function useScrub(params: ScrubParams) {
return React.useMemo(
() => ({
isScrubbing,
isTouchInput,
isPointerLockDenied,
getScrubAreaProps,
getScrubAreaCursorProps,
scrubAreaCursorRef,
scrubAreaRef,
scrubHandleRef,
}),
[isScrubbing, getScrubAreaProps, getScrubAreaCursorProps],
[isScrubbing, isTouchInput, isPointerLockDenied, getScrubAreaProps, getScrubAreaCursorProps],
);
}
Original file line number Diff line number Diff line change
@@ -1,14 +1,17 @@
import * as React from 'react';
import { expect } from 'chai';
import { screen } from '@mui/internal-test-utils';
import { screen, act } from '@mui/internal-test-utils';
import sinon from 'sinon';
import { NumberField } from '@base-ui-components/react/number-field';
import { createRenderer, describeConformance } from '#test-utils';
import { isWebKit } from '../../utils/detectBrowser';
import { NumberFieldRootContext } from '../root/NumberFieldRootContext';

const testContext = {
const defaultTestContext: NumberFieldRootContext = {
getScrubAreaCursorProps: (externalProps) => externalProps,
isScrubbing: true,
isTouchInput: false,
isPointerLockDenied: false,
state: {
value: null,
required: false,
Expand All @@ -30,7 +33,7 @@ describe('<NumberField.ScrubAreaCursor />', () => {
refInstanceof: window.HTMLSpanElement,
render: async (node) => {
return render(
<NumberFieldRootContext.Provider value={testContext}>
<NumberFieldRootContext.Provider value={defaultTestContext}>
{node}
</NumberFieldRootContext.Provider>,
);
Expand All @@ -45,4 +48,88 @@ describe('<NumberField.ScrubAreaCursor />', () => {
);
expect(screen.queryByRole('presentation')).not.to.equal(null);
});

it('renders when using mouse input', async () => {
const originalRequestPointerLock = Element.prototype.requestPointerLock;

try {
Element.prototype.requestPointerLock = sinon.stub().resolves();

const { user } = await render(
<NumberField.Root>
<NumberField.ScrubArea data-testid="scrub-area">
<NumberField.ScrubAreaCursor data-testid="scrub-area-cursor" />
</NumberField.ScrubArea>
</NumberField.Root>,
);

const scrubArea = screen.getByTestId('scrub-area');

await act(async () => {
await user.pointer({ target: scrubArea, keys: '[MouseLeft>]', pointerName: 'mouse' });
await new Promise((resolve) => {
setTimeout(resolve, 25);
});
});

expect(screen.queryByTestId('scrub-area-cursor')).not.to.equal(null);
} finally {
Element.prototype.requestPointerLock = originalRequestPointerLock;
}
});

it('does not render when using touch input', async () => {
const { user } = await render(
<NumberField.Root>
<NumberField.ScrubArea>
<NumberField.ScrubAreaCursor data-testid="scrub-area-cursor" />
</NumberField.ScrubArea>
</NumberField.Root>,
);

const scrubArea = screen.getByRole('presentation');

await act(async () => {
await user.pointer({ target: scrubArea, keys: '[TouchA>]', pointerName: 'touch' });
await new Promise((resolve) => {
setTimeout(resolve, 25);
});
});

expect(screen.queryByTestId('scrub-area-cursor')).to.equal(null);
});

it('handles pointer lock denial through requestPointerLock API', async () => {
const originalRequestPointerLock = Element.prototype.requestPointerLock;

try {
Element.prototype.requestPointerLock = sinon
.stub()
.throws(new Error('User denied pointer lock'));

const { user } = await render(
<NumberField.Root>
<NumberField.ScrubArea>
<NumberField.ScrubAreaCursor data-testid="scrub-area-cursor" />
</NumberField.ScrubArea>
</NumberField.Root>,
);

const scrubArea = screen.getByRole('presentation');

await act(async () => {
await user.pointer({ target: scrubArea, keys: '[MouseLeft>]', pointerName: 'mouse' });
await new Promise((resolve) => {
setTimeout(resolve, 25);
});
});

expect(screen.queryByTestId('scrub-area-cursor')).to.equal(null);

const requestLockStub = Element.prototype.requestPointerLock as sinon.SinonStub;
expect(requestLockStub.called).to.equal(true);
} finally {
Element.prototype.requestPointerLock = originalRequestPointerLock;
}
});
});
Original file line number Diff line number Diff line change
Expand Up @@ -25,8 +25,14 @@ const NumberFieldScrubAreaCursor = React.forwardRef(function NumberFieldScrubAre
) {
const { render, className, ...otherProps } = props;

const { isScrubbing, scrubAreaCursorRef, state, getScrubAreaCursorProps } =
useNumberFieldRootContext();
const {
isScrubbing,
isTouchInput,
isPointerLockDenied,
scrubAreaCursorRef,
state,
getScrubAreaCursorProps,
} = useNumberFieldRootContext();

const [element, setElement] = React.useState<Element | null>(null);

Expand All @@ -41,7 +47,7 @@ const NumberFieldScrubAreaCursor = React.forwardRef(function NumberFieldScrubAre
extraProps: otherProps,
});

if (!isScrubbing || isWebKit()) {
if (!isScrubbing || isWebKit() || isTouchInput || isPointerLockDenied) {
return null;
}

Expand Down