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

Combobox: Set combobox story to scroll to selected option on open #33789

Merged
merged 2 commits into from
Feb 12, 2025
Merged

Combobox: Set combobox story to scroll to selected option on open #33789

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
1479ccc
Set combobox story to scroll to selected option on open
Mitch-At-Work Feb 5, 2025
344754f
Update radix
Mitch-At-Work Feb 5, 2025
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
30 changes: 26 additions & 4 deletions ...ages/react-components/react-combobox/stories/src/Combobox/ComboboxVirtualizer.stories.tsx
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
import * as React from 'react';
import { Combobox, Option, makeStyles, useId } from '@fluentui/react-components';
import { Combobox, Option, makeStyles, useId, useMergedRefs, useTimeout } from '@fluentui/react-components';
import type { ComboboxProps } from '@fluentui/react-components';

import { Virtualizer, useStaticVirtualizerMeasure } from '@fluentui/react-components/unstable';
Expand All @@ -18,7 +18,8 @@ export const ComboboxVirtualizer = (props: Partial<ComboboxProps>) => {
const comboId = useId('combobox');

//This should include the item height (32px) and account for rowGap (2px)
const itemHeight = 34;
const itemHeight = 32;
const rowGap = 2;
const numberOfItems = 10000;

const { virtualizerLength, bufferItems, bufferSize, scrollRef, containerSizeRef } = useStaticVirtualizerMeasure({
Expand All @@ -29,8 +30,12 @@ export const ComboboxVirtualizer = (props: Partial<ComboboxProps>) => {
// We need to recalculate index when at least 10 items (+1px) from the bottom or top for page up/down
bufferSize: itemHeight * 10 + 1,
});
const selectedIndex = React.useRef(0);

const styles = useStyles();
const mergedRefs = useMergedRefs(scrollRef);
// Scroll timer required to post scrollTo on stack post-open state change
const [setScrollTimer, clearScrollTimer] = useTimeout();

return (
<div>
Expand All @@ -40,7 +45,20 @@ export const ComboboxVirtualizer = (props: Partial<ComboboxProps>) => {
id={`${comboId}`}
placeholder="Select a number"
positioning={{ autoSize: 'width' }}
listbox={{ ref: scrollRef, className: styles.listbox }}
listbox={{ ref: mergedRefs, className: styles.listbox }}
onOpenChange={(e, data) => {
clearScrollTimer();
if (data.open) {
setScrollTimer(() => {
mergedRefs.current?.scrollTo({ top: (itemHeight + rowGap) * selectedIndex.current });
}, 0);
}
}}
onOptionSelect={(e, data) => {
if (data.optionValue) {
selectedIndex.current = parseInt(data.optionValue, 10);
}
}}
>
<Virtualizer
numItems={numberOfItems}
Expand All @@ -49,6 +67,7 @@ export const ComboboxVirtualizer = (props: Partial<ComboboxProps>) => {
bufferSize={bufferSize}
itemSize={itemHeight}
containerSizeRef={containerSizeRef}
gap={rowGap}
>
{index => {
return (
Expand All @@ -57,7 +76,10 @@ export const ComboboxVirtualizer = (props: Partial<ComboboxProps>) => {
aria-posinset={index}
aria-setsize={numberOfItems}
key={`item-${index}`}
>{`Item ${index + 1}`}</Option>
value={index.toString()}
>
{`Item ${index + 1}`}
</Option>
);
}}
</Virtualizer>
Expand Down