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

Jump to bottom

[Select] Select scroll speed addition #3090

Open
wants to merge 4 commits into
base: main
Choose a base branch
from
Open

[Select] Select scroll speed addition #3090

Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
550530c
Adding props to be able to controll the scroll factor(speed) for Sele…
Saikedo Aug 28, 2024
7d663f7
cleanup
Saikedo Aug 28, 2024
89f2124
Fix for hover factor
Saikedo Aug 28, 2024
0ccfa9b
Fixing a console warning that was a result of some of the new paramet…
Saikedo Sep 11, 2024
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
158 changes: 90 additions & 68 deletions packages/react/select/src/Select.tsx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -1382,43 +1382,54 @@ SelectItemIndicator.displayName = ITEM_INDICATOR_NAME;
const SCROLL_UP_BUTTON_NAME = 'SelectScrollUpButton';

type SelectScrollUpButtonElement = SelectScrollButtonImplElement;
interface SelectScrollUpButtonProps extends Omit<SelectScrollButtonImplProps, 'onAutoScroll'> {}
interface SelectScrollUpButtonProps extends Omit<SelectScrollButtonImplProps, 'onAutoScroll'> {
hoverScrollFactor?: number;
touchScrollFactor?: number;
}

const SelectScrollUpButton = React.forwardRef<
SelectScrollUpButtonElement,
SelectScrollUpButtonProps
>((props: ScopedProps<SelectScrollUpButtonProps>, forwardedRef) => {
const contentContext = useSelectContentContext(SCROLL_UP_BUTTON_NAME, props.__scopeSelect);
const viewportContext = useSelectViewportContext(SCROLL_UP_BUTTON_NAME, props.__scopeSelect);
const [canScrollUp, setCanScrollUp] = React.useState(false);
const composedRefs = useComposedRefs(forwardedRef, viewportContext.onScrollButtonChange);
>(
(
{ hoverScrollFactor, touchScrollFactor, ...props }: ScopedProps<SelectScrollUpButtonProps>,
forwardedRef
) => {
const contentContext = useSelectContentContext(SCROLL_UP_BUTTON_NAME, props.__scopeSelect);
const viewportContext = useSelectViewportContext(SCROLL_UP_BUTTON_NAME, props.__scopeSelect);
const [canScrollUp, setCanScrollUp] = React.useState(false);
const composedRefs = useComposedRefs(forwardedRef, viewportContext.onScrollButtonChange);

useLayoutEffect(() => {
if (contentContext.viewport && contentContext.isPositioned) {
const viewport = contentContext.viewport;
function handleScroll() {
const canScrollUp = viewport.scrollTop > 0;
setCanScrollUp(canScrollUp);
}
handleScroll();
viewport.addEventListener('scroll', handleScroll);
return () => viewport.removeEventListener('scroll', handleScroll);
}
}, [contentContext.viewport, contentContext.isPositioned]);

return canScrollUp ? (
<SelectScrollButtonImpl
{...props}
ref={composedRefs}
onAutoScroll={() => {
const { viewport, selectedItem } = contentContext;
if (viewport && selectedItem) {
viewport.scrollTop = viewport.scrollTop - selectedItem.offsetHeight;
useLayoutEffect(() => {
if (contentContext.viewport && contentContext.isPositioned) {
const viewport = contentContext.viewport;
function handleScroll() {
const canScrollUp = viewport.scrollTop > 0;
setCanScrollUp(canScrollUp);
}
}}
/>
) : null;
});
handleScroll();
viewport.addEventListener('scroll', handleScroll);
return () => viewport.removeEventListener('scroll', handleScroll);
}
}, [contentContext.viewport, contentContext.isPositioned]);

return canScrollUp ? (
<SelectScrollButtonImpl
{...props}
ref={composedRefs}
onAutoScroll={(pointerAction?: 'move' | 'down') => {
const { viewport, selectedItem } = contentContext;
if (viewport && selectedItem) {
const factor =
pointerAction && (pointerAction === 'move' ? hoverScrollFactor : touchScrollFactor);
viewport.scrollTop =
viewport.scrollTop - selectedItem.offsetHeight * Math.abs(factor ?? 1);
}
}}
/>
) : null;
}
);

SelectScrollUpButton.displayName = SCROLL_UP_BUTTON_NAME;

Expand All @@ -1429,52 +1440,63 @@ SelectScrollUpButton.displayName = SCROLL_UP_BUTTON_NAME;
const SCROLL_DOWN_BUTTON_NAME = 'SelectScrollDownButton';

type SelectScrollDownButtonElement = SelectScrollButtonImplElement;
interface SelectScrollDownButtonProps extends Omit<SelectScrollButtonImplProps, 'onAutoScroll'> {}
interface SelectScrollDownButtonProps extends Omit<SelectScrollButtonImplProps, 'onAutoScroll'> {
hoverScrollFactor?: number;
touchScrollFactor?: number;
}

const SelectScrollDownButton = React.forwardRef<
SelectScrollDownButtonElement,
SelectScrollDownButtonProps
>((props: ScopedProps<SelectScrollDownButtonProps>, forwardedRef) => {
const contentContext = useSelectContentContext(SCROLL_DOWN_BUTTON_NAME, props.__scopeSelect);
const viewportContext = useSelectViewportContext(SCROLL_DOWN_BUTTON_NAME, props.__scopeSelect);
const [canScrollDown, setCanScrollDown] = React.useState(false);
const composedRefs = useComposedRefs(forwardedRef, viewportContext.onScrollButtonChange);
>(
(
{ hoverScrollFactor, touchScrollFactor, ...props }: ScopedProps<SelectScrollDownButtonProps>,
forwardedRef
) => {
const contentContext = useSelectContentContext(SCROLL_DOWN_BUTTON_NAME, props.__scopeSelect);
const viewportContext = useSelectViewportContext(SCROLL_DOWN_BUTTON_NAME, props.__scopeSelect);
const [canScrollDown, setCanScrollDown] = React.useState(false);
const composedRefs = useComposedRefs(forwardedRef, viewportContext.onScrollButtonChange);

useLayoutEffect(() => {
if (contentContext.viewport && contentContext.isPositioned) {
const viewport = contentContext.viewport;
function handleScroll() {
const maxScroll = viewport.scrollHeight - viewport.clientHeight;
// we use Math.ceil here because if the UI is zoomed-in
// `scrollTop` is not always reported as an integer
const canScrollDown = Math.ceil(viewport.scrollTop) < maxScroll;
setCanScrollDown(canScrollDown);
}
handleScroll();
viewport.addEventListener('scroll', handleScroll);
return () => viewport.removeEventListener('scroll', handleScroll);
}
}, [contentContext.viewport, contentContext.isPositioned]);

return canScrollDown ? (
<SelectScrollButtonImpl
{...props}
ref={composedRefs}
onAutoScroll={() => {
const { viewport, selectedItem } = contentContext;
if (viewport && selectedItem) {
viewport.scrollTop = viewport.scrollTop + selectedItem.offsetHeight;
useLayoutEffect(() => {
if (contentContext.viewport && contentContext.isPositioned) {
const viewport = contentContext.viewport;
function handleScroll() {
const maxScroll = viewport.scrollHeight - viewport.clientHeight;
// we use Math.ceil here because if the UI is zoomed-in
// `scrollTop` is not always reported as an integer
const canScrollDown = Math.ceil(viewport.scrollTop) < maxScroll;
setCanScrollDown(canScrollDown);
}
}}
/>
) : null;
});
handleScroll();
viewport.addEventListener('scroll', handleScroll);
return () => viewport.removeEventListener('scroll', handleScroll);
}
}, [contentContext.viewport, contentContext.isPositioned]);

return canScrollDown ? (
<SelectScrollButtonImpl
{...props}
ref={composedRefs}
onAutoScroll={(pointerAction?: 'move' | 'down') => {
const { viewport, selectedItem } = contentContext;
if (viewport && selectedItem) {
const factor =
pointerAction && (pointerAction === 'move' ? hoverScrollFactor : touchScrollFactor);
viewport.scrollTop =
viewport.scrollTop + selectedItem.offsetHeight * Math.abs(factor ?? 1);
}
}}
/>
) : null;
}
);

SelectScrollDownButton.displayName = SCROLL_DOWN_BUTTON_NAME;

type SelectScrollButtonImplElement = React.ElementRef<typeof Primitive.div>;
interface SelectScrollButtonImplProps extends PrimitiveDivProps {
onAutoScroll(): void;
onAutoScroll(pointerAction?: 'move' | 'down'): void;
}

const SelectScrollButtonImpl = React.forwardRef<
Expand Down Expand Up @@ -1514,13 +1536,13 @@ const SelectScrollButtonImpl = React.forwardRef<
style={{ flexShrink: 0, ...scrollIndicatorProps.style }}
onPointerDown={composeEventHandlers(scrollIndicatorProps.onPointerDown, () => {
if (autoScrollTimerRef.current === null) {
autoScrollTimerRef.current = window.setInterval(onAutoScroll, 50);
autoScrollTimerRef.current = window.setInterval(onAutoScroll, 50, 'down');
}
})}
onPointerMove={composeEventHandlers(scrollIndicatorProps.onPointerMove, () => {
contentContext.onItemLeave?.();
if (autoScrollTimerRef.current === null) {
autoScrollTimerRef.current = window.setInterval(onAutoScroll, 50);
autoScrollTimerRef.current = window.setInterval(onAutoScroll, 50, 'move');
}
})}
onPointerLeave={composeEventHandlers(scrollIndicatorProps.onPointerLeave, () => {
Expand Down