reykit 1.0.37 → 1.0.39

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
@@ -2,14 +2,8 @@ import { ReactNode, ComponentProps, MouseEvent } from 'react';
2
2
  /**
3
3
  * Button component of cycle display children.
4
4
  *
5
- * Parameters
6
- * ----------
7
- * @param childrens Children array.
8
- * @param handleCycle Handle cycle.
9
- *
10
- * Returns
11
- * -------
12
- * @returns React element.
5
+ * @param childrens - Children array.
6
+ * @param handleCycle - Handle cycle.
13
7
  */
14
8
  export declare function CycleButton({ childrens, handleCycle, onClick, ...props }: {
15
9
  childrens: ReactNode[];
@@ -2,14 +2,8 @@ import { ComponentProps } from 'react';
2
2
  /**
3
3
  * Form component of prevent access link.
4
4
  *
5
- * Parameters
6
- * ----------
7
- * @param handleFormData Handle submited form data.
8
- * @param link Access router link.
9
- *
10
- * Returns
11
- * -------
12
- * @returns React element.
5
+ * @param handleFormData - Handle submited form data.
6
+ * @param link - Access router link.
13
7
  */
14
8
  export default function Form({ handleFormData, link, onSubmit, ...props }: {
15
9
  handleFormData?: (formData: FormData) => void;
package/dist/hook.d.ts CHANGED
@@ -1,49 +1,32 @@
1
1
  /**
2
2
  * Hook of toggle.
3
3
  *
4
- * Parameters
5
- * ----------
6
- * @param array Array.
7
- * @param loop Whether to loop count.
8
- *
9
- * Returns
10
- * -------
4
+ * @param array - Array.
5
+ * @param loop - Whether to loop count.
11
6
  * @returns Returns a stateful open value, and a function to automatic count it.
12
7
  */
13
8
  export declare function useOpen(defaultOpen?: boolean): [boolean, () => void];
14
9
  /**
15
10
  * Hook of count number.
16
11
  *
17
- * Parameters
18
- * ----------
19
- * @param start Start number.
20
- * @param step Count step.
21
- * @param stop Stop number.
22
- * @param loop Whether to loop count.
23
- *
24
- * Returns
25
- * -------
12
+ * @param start - Start number.
13
+ * @param step - Count step.
14
+ * @param stop - Stop number.
15
+ * @param loop - Whether to loop count.
26
16
  * @returns Returns a stateful count value, and a function to automatic count it.
27
17
  */
28
18
  export declare function useCount(start?: number, step?: number, stop?: number, loop?: boolean): [number, () => void];
29
19
  /**
30
20
  * Hook of count array index.
31
21
  *
32
- * Parameters
33
- * ----------
34
- * @param array Array.
35
- * @param loop Whether to loop count.
36
- *
37
- * Returns
38
- * -------
22
+ * @param array - Array.
23
+ * @param loop - Whether to loop count.
39
24
  * @returns Returns a stateful index value, and a function to automatic count it.
40
25
  */
41
26
  export declare function useIndex(array: any[], loop?: boolean): [number, () => void];
42
27
  /**
43
28
  * Whether is mobile.
44
29
  *
45
- * Returns
46
- * -------
47
30
  * @returns Judgement.
48
31
  */
49
32
  export declare function useIsMobile(): boolean;
package/dist/index.d.ts CHANGED
@@ -4,7 +4,9 @@ import { useOpen, useCount, useIndex, useIsMobile } from './hook';
4
4
  import { renderReact } from './react';
5
5
  import { default as Storager } from './storage';
6
6
  import { cn } from './tailwindcss';
7
+ import * as types from './type';
7
8
  declare const _default: {
9
+ types: typeof types;
8
10
  CycleButton: typeof CycleButton;
9
11
  Form: typeof Form;
10
12
  useOpen: typeof useOpen;