chore: fix review with hooks

gravity-ui · Oct 12, 2023 · e0cb6a0 · e0cb6a0
1 parent 7ec85b7
commit e0cb6a0
Show file tree

Hide file tree

Showing 4 changed files with 30 additions and 22 deletions.
diff --git a/src/hooks/useListNavigation/README.md b/src/hooks/useListNavigation/README.md
@@ -24,28 +24,6 @@ The hook returns the following:
 - `activeItemIndex` - active item index
 - `reset` - function, which should be called when you want to reset navigation
 
-## Properties
-
-| Name            |                                              Description                                              |                                 Type                                 | Default |
-| :-------------- | :---------------------------------------------------------------------------------------------------: | :------------------------------------------------------------------: | :-----: |
-| items           | List items. Item can be any object. Also, it can contain `items` property, which represents sub-items |                             `ItemType[]`                             |         |
-| skip            |         Returns true if the item should not participate in navigation (Called for each item)          |                    `(item: ItemType) => boolean`                     |         |
-| pageSize        |               Items page size, if passed, then navigates by pageSize on PageDown/PageUp               |                               `number`                               |         |
-| processHomeKey  |                             Navigate to the start of the list on Home key                             |                              `boolean`                               | `false` |
-| processEndKey   |                              Navigate to the end of the list on End key                               |                              `boolean`                               | `false` |
-| disabled        |                                          Disable navigation                                           |                              `boolean`                               | `false` |
-| initialValue    |                                       Initial active item index                                       |                               `number`                               |  `-1`   |
-| anchorRef       |               HTMLElement reference, the hook will listen keydown event on that element               |                       `RefObject<AnchorType>`                        |         |
-| onAnchorKeyDown |             Custom keydown handler, if returns false, then the hook won't process keydown             | `(activeItemIndex: number, event: KeyboardEvent) => boolean or void` |         |
-
-## Result
-
-| Name               | Description              |           Type            |
-| :----------------- | :----------------------- | :-----------------------: |
-| activeItemIndex    | Index of the active item |         `number`          |
-| setActiveItemIndex | Active item index setter | `(index: number) => void` |
-| reset              | Resets navigation        |       `() => void`        |
-
 ## Examples
 
 ```tsx
@@ -83,3 +61,25 @@ useListNavigation({
   },
 });
 ```
+
+## Properties
+
+| Name            |                                              Description                                              |                                 Type                                 | Default |
+| :-------------- | :---------------------------------------------------------------------------------------------------: | :------------------------------------------------------------------: | :-----: |
+| items           | List items. Item can be any object. Also, it can contain `items` property, which represents sub-items |                             `ItemType[]`                             |         |
+| skip            |         Returns true if the item should not participate in navigation (Called for each item)          |                    `(item: ItemType) => boolean`                     |         |
+| pageSize        |               Items page size, if passed, then navigates by pageSize on PageDown/PageUp               |                               `number`                               |         |
+| processHomeKey  |                             Navigate to the start of the list on Home key                             |                              `boolean`                               | `false` |
+| processEndKey   |                              Navigate to the end of the list on End key                               |                              `boolean`                               | `false` |
+| disabled        |                                          Disable navigation                                           |                              `boolean`                               | `false` |
+| initialValue    |                                       Initial active item index                                       |                               `number`                               |  `-1`   |
+| anchorRef       |               HTMLElement reference, the hook will listen keydown event on that element               |                       `RefObject<AnchorType>`                        |         |
+| onAnchorKeyDown |             Custom keydown handler, if returns false, then the hook won't process keydown             | `(activeItemIndex: number, event: KeyboardEvent) => boolean or void` |         |
+
+## Result
+
+| Name               | Description              |           Type            |
+| :----------------- | :----------------------- | :-----------------------: |
+| activeItemIndex    | Index of the active item |         `number`          |
+| setActiveItemIndex | Active item index setter | `(index: number) => void` |
+| reset              | Resets navigation        |       `() => void`        |
diff --git a/src/hooks/useSelect/types.ts b/src/hooks/useSelect/types.ts
@@ -20,6 +20,9 @@ export type UseSelectResult<T> = {
     activeIndex: number | undefined;
     handleSelection: (option: UseSelectOption<T>) => void;
     handleClearValue: () => void;
+    /**
+     * @deprecated use toggleOpen
+     */
     setOpen: (val?: boolean | undefined) => void;
     toggleOpen: (val?: boolean | undefined) => void;
     setActiveIndex: React.Dispatch<React.SetStateAction<number | undefined>>;

diff --git a/src/hooks/useTimeout/index.ts b/src/hooks/useTimeout/index.ts
@@ -1 +1,2 @@
 export {useTimeout} from './useTimeout';
+export type {UseTimeoutProps} from './useTimeout';
diff --git a/src/hooks/useTimeout/useTimeout.ts b/src/hooks/useTimeout/useTimeout.ts
@@ -1,5 +1,9 @@
 import React from 'react';
 
+export type UseTimeoutProps = Parameters<
+    (callback: VoidFunction, ms: number | null | undefined) => void
+>;
+
 export function useTimeout(callback: VoidFunction, ms: number | null | undefined): void {
     React.useEffect(() => {
         if (typeof ms !== 'number') {
Original file line number	Diff line number	Diff line change
		@@ -1 +1,2 @@
		export {useTimeout} from './useTimeout';
		export type {UseTimeoutProps} from './useTimeout';