From 11a9a81a0c08f5bdabd82d30118a903ece83b840 Mon Sep 17 00:00:00 2001
From: "github-actions[bot]"
 <41898282+github-actions[bot]@users.noreply.github.com>
Date: Thu, 24 Apr 2025 07:08:56 +0000
Subject: [PATCH] Generate docs for useDoubleClick

---
 src/docs/en/why-react-simplikit-matters.md    |  2 +-
 src/docs/ko/why-react-simplikit-matters.md    |  8 +--
 src/hooks/useDoubleClick/ko/useDoubleClick.md | 71 +++++++++++++++++++
 src/hooks/useDoubleClick/useDoubleClick.md    | 71 +++++++++++++++++++
 4 files changed, 147 insertions(+), 5 deletions(-)
 create mode 100644 src/hooks/useDoubleClick/ko/useDoubleClick.md
 create mode 100644 src/hooks/useDoubleClick/useDoubleClick.md

diff --git a/src/docs/en/why-react-simplikit-matters.md b/src/docs/en/why-react-simplikit-matters.md
index 972fbec3..1efc52fe 100644
--- a/src/docs/en/why-react-simplikit-matters.md
+++ b/src/docs/en/why-react-simplikit-matters.md
@@ -202,4 +202,4 @@ Compared to `react-use`, `react-simplikit` has up to about 89% smaller size:
 | Unpacked Size                                 | [237 kB](https://www.npmjs.com/package/react-simplikit)           | [454 kB](https://www.npmjs.com/package/react-use)            | -47.8%     |
 | Minified Size                                 | [8.7 kB](https://bundlephobia.com/package/react-simplikit@0.0.29) | [78.2 kB](https://bundlephobia.com/package/react-use@17.6.0) | -88.9%     |
 | Gzipped Size                                  | [2.9 kB](https://bundlephobia.com/package/react-simplikit@0.0.29) | [22 kB](https://bundlephobia.com/package/react-use@17.6.0)   | -86.9%     |
-| Average Size per Function<br/>(Minified Size) | 318.2 byte                                                          | 696.3 byte                                                     | -54.3%     |
+| Average Size per Function<br/>(Minified Size) | 318.2 byte                                                        | 696.3 byte                                                   | -54.3%     |
diff --git a/src/docs/ko/why-react-simplikit-matters.md b/src/docs/ko/why-react-simplikit-matters.md
index 3819f397..235a2e84 100644
--- a/src/docs/ko/why-react-simplikit-matters.md
+++ b/src/docs/ko/why-react-simplikit-matters.md
@@ -197,9 +197,9 @@ function AutoCompleteInput() {
 
 `react-simplikit`은 `react-use`에 대비하여, 아래와 같이 최대 약 89% 작은 크기를 가져요.
 
-|                                            | react-simplikit                                                  | react-use                                                    | 차이   |
-| ------------------------------------------ | ---------------------------------------------------------------- | ------------------------------------------------------------ | ------ |
-| Unpacked Size                              | [237 kB](https://www.npmjs.com/package/react-simplikit)          | [454 kB](https://www.npmjs.com/package/react-use)            | -47.8% |
+|                                            | react-simplikit                                                   | react-use                                                    | 차이   |
+| ------------------------------------------ | ----------------------------------------------------------------- | ------------------------------------------------------------ | ------ |
+| Unpacked Size                              | [237 kB](https://www.npmjs.com/package/react-simplikit)           | [454 kB](https://www.npmjs.com/package/react-use)            | -47.8% |
 | Minified Size                              | [8.7 kB](https://bundlephobia.com/package/react-simplikit@0.0.29) | [78.2 kB](https://bundlephobia.com/package/react-use@17.6.0) | -88.9% |
 | Gzipped Size                               | [2.9 kB](https://bundlephobia.com/package/react-simplikit@0.0.29) | [22 kB](https://bundlephobia.com/package/react-use@17.6.0)   | -86.9% |
-| 평균 함수 당 크기<br/>(Minified Size 기준) | 318.2 byte                                                         | 696.3 byte                                                     | -54.3% |
+| 평균 함수 당 크기<br/>(Minified Size 기준) | 318.2 byte                                                        | 696.3 byte                                                   | -54.3% |
diff --git a/src/hooks/useDoubleClick/ko/useDoubleClick.md b/src/hooks/useDoubleClick/ko/useDoubleClick.md
new file mode 100644
index 00000000..1b286dac
--- /dev/null
+++ b/src/hooks/useDoubleClick/ko/useDoubleClick.md
@@ -0,0 +1,71 @@
+# useDoubleClick
+
+`useDoubleClick`는 단일 클릭과 더블 클릭 이벤트를 구분하는 리액트 훅이에요. 지정된 시간 동안 단일 클릭 콜백 실행을 지연시키고, 그 시간 안에 두 번째 클릭(즉, 더블 클릭)이 발생하면 이를 취소해요.
+
+## 인터페이스
+
+```ts
+function useDoubleClick<E extends HTMLElement>(
+  params: Object
+): (event: MouseEvent<E>) => void;
+```
+
+### 파라미터
+
+<Interface
+  required
+  name="params"
+  type="Object"
+  description="클릭 처리를 위한 설정 옵션이에요."
+  :nested="[
+    {
+      name: 'params.delay',
+      type: 'number',
+      required: false,
+      defaultValue: '250',
+      description:
+        '단일 클릭 콜백을 실행하기 전에 기다릴 밀리초 수예요. 기본값은 250ms예요.',
+    },
+    {
+      name: 'params.click',
+      type: '(event: MouseEvent<E>) => void',
+      required: false,
+      description: '단일 클릭 시 실행될 콜백 함수예요.',
+    },
+    {
+      name: 'params.doubleClick',
+      type: '(event: MouseEvent<E>) => void',
+      required: true,
+      description:
+        '더블 클릭 시 실행될 콜백 함수예요. 필수예요.',
+    },
+  ]"
+/>
+
+### 반환 값
+
+<Interface
+  name=""
+  type="(event: MouseEvent<E>) => void"
+  description="요소의 <code>onClick</code> 이벤트에 첨부할 클릭 핸들러 함수예요."
+/>
+
+## 예시
+
+```tsx
+function GalleryCard() {
+  const [selected, setSelected] = useState(false);
+
+  const handleClick = () => setSelected(prev => !prev);
+  const handleDoubleClick = () => alert('확대해요!');
+
+  const handleEvent = useDoubleClick({
+    click: handleClick,
+    doubleClick: handleDoubleClick,
+  });
+
+  return (
+    <div onClick={handleEvent}>{selected ? '선택됨' : '선택되지 않음'}</div>
+  );
+}
+```
diff --git a/src/hooks/useDoubleClick/useDoubleClick.md b/src/hooks/useDoubleClick/useDoubleClick.md
new file mode 100644
index 00000000..da2333e2
--- /dev/null
+++ b/src/hooks/useDoubleClick/useDoubleClick.md
@@ -0,0 +1,71 @@
+# useDoubleClick
+
+`useDoubleClick` is a React hook that differentiates between single and double click events. It delays the single click callback execution for a specified time, and cancels it if a second click (i.e. a double click) occurs within that time.
+
+## Interface
+
+```ts
+function useDoubleClick<E extends HTMLElement>(
+  params: Object
+): (event: MouseEvent<E>) => void;
+```
+
+### Parameters
+
+<Interface
+  required
+  name="params"
+  type="Object"
+  description="Configuration options for click handling."
+  :nested="[
+    {
+      name: 'params.delay',
+      type: 'number',
+      required: false,
+      defaultValue: '250',
+      description:
+        'The number of milliseconds to wait before triggering the single click callback. Defaults to 250ms.',
+    },
+    {
+      name: 'params.click',
+      type: '(event: MouseEvent<E>) => void',
+      required: false,
+      description: 'The callback function to be executed on a single click.',
+    },
+    {
+      name: 'params.doubleClick',
+      type: '(event: MouseEvent<E>) => void',
+      required: true,
+      description:
+        'The callback function to be executed on a double click. Required.',
+    },
+  ]"
+/>
+
+### Return Value
+
+<Interface
+  name=""
+  type="(event: MouseEvent<E>) => void"
+  description="click handler function to attach to an element's <code>onClick</code> event."
+/>
+
+## Example
+
+```tsx
+function GalleryCard() {
+  const [selected, setSelected] = useState(false);
+
+  const handleClick = () => setSelected(prev => !prev);
+  const handleDoubleClick = () => alert('Zoom in!');
+
+  const handleEvent = useDoubleClick({
+    click: handleClick,
+    doubleClick: handleDoubleClick,
+  });
+
+  return (
+    <div onClick={handleEvent}>{selected ? 'Selected' : 'Not selected'}</div>
+  );
+}
+```