feat(useVirutalList): expose scrollTo in component (#2397)

Co-authored-by: Eric Skaliks <eric.skaliks@t-online.de>
vueuse · Jan 3, 2023 · 9f495d6 · 9f495d6
1 parent c9a9a92
commit 9f495d6
Show file tree

Hide file tree

Showing 2 changed files with 6 additions and 3 deletions.
diff --git a/packages/core/useVirtualList/component.ts b/packages/core/useVirtualList/component.ts
@@ -30,11 +30,12 @@ export const UseVirtualList = defineComponent<UseVirtualListProps>({
     'options',
     'height',
   ] as unknown as undefined,
-  setup(props, { slots }) {
+  setup(props, { slots, expose }) {
     const { list: listRef } = toRefs(props)
 
-    const { list, containerProps, wrapperProps } = useVirtualList(listRef, props.options)
-
+    const { list, containerProps, wrapperProps, scrollTo } = useVirtualList(listRef, props.options)
+    expose({ scrollTo })
+
     typeof containerProps.style === 'object' && !Array.isArray(containerProps.style) && (containerProps.style.height = props.height || '300px')
 
     return () => h('div',

diff --git a/packages/core/useVirtualList/index.md b/packages/core/useVirtualList/index.md
@@ -101,3 +101,5 @@ const { list, containerProps, wrapperProps } = useVirtualList(
   </template>
 </UseVirtualList>
 ```
+
+To scroll to a specific element, the component exposes `scrollTo(index: number) => void`.