feat(useCycleList): add go function (#3615)

Co-authored-by: Anthony Fu <[email protected]>

Author: lanxizhu

packages/core/useCycleList/index.md

@@ -13,7 +13,7 @@ Cycle through a list of items.
 ```ts
 import { useCycleList } from '@vueuse/core'
 
-const { state, next, prev } = useCycleList([
+const { state, next, prev, go } = useCycleList([
   'Dog',
   'Cat',
   'Lizard',
@@ -29,4 +29,8 @@ console.log(state.value) // 'Dog'
 prev()
 
 console.log(state.value) // 'Seal'
+
+go(3)
+
+console.log(state.value) // 'Shark'
 ```

packages/core/useCycleList/index.test.ts

@@ -33,7 +33,7 @@ describe('useCycleList', () => {
   it('should work with ref', () => {
     const list = ref(['foo', 'bar', 'fooBar'])
 
-    const { state, next, prev, index } = useCycleList(list)
+    const { state, next, prev, index, go } = useCycleList(list)
 
     expect(state.value).toBe('foo')
     expect(index.value).toBe(0)
@@ -57,6 +57,16 @@ describe('useCycleList', () => {
 
     expect(state.value).toBe('foo')
     expect(index.value).toBe(0)
+
+    go(1)
+
+    expect(state.value).toBe('bar')
+    expect(index.value).toBe(1)
+
+    go(-1)
+
+    expect(state.value).toBe('fooBar')
+    expect(index.value).toBe(2)
   })
 
   describe('when list empty', () => {

packages/core/useCycleList/index.ts

@@ -80,6 +80,7 @@ export function useCycleList<T>(list: MaybeRefOrGetter<T[]>, options?: UseCycleL
     index,
     next,
     prev,
+    go: set,
   }
 }
 
@@ -88,4 +89,8 @@ export interface UseCycleListReturn<T> {
   index: Ref<number>
   next: (n?: number) => T
   prev: (n?: number) => T
+  /**
+   * Go to a specific index
+   */
+  go: (i: number) => T
 }