Skip to content

Commit 4aee099

Browse files
committed
📝 docs: useScrollLock nextra 문서 작성
1 parent 209d8af commit 4aee099

File tree

2 files changed

+45
-1
lines changed

2 files changed

+45
-1
lines changed

docs/pages/docs/hooks/_meta.json

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,6 @@
11
{
22
"useTranslation": "useTranslation",
33
"useMousePosition": "useMousePosition",
4-
"useTimer": "useTimer"
4+
"useTimer": "useTimer",
5+
"useScrollLock": "useScrollLock"
56
}
Lines changed: 43 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,43 @@
1+
# useScrollLock
2+
3+
## Introduce
4+
5+
페이지의 스크롤을 잠궈 사용자가 스크롤할 수 없도록 합니다.
6+
7+
(스크롤 바가 비활성화된 상태로, UI형태가 유지된 형태)
8+
9+
```ts
10+
const useScrollLock = (props: boolean): void
11+
```
12+
13+
### Props
14+
boolean값으로 스크롤의 잠금 여부를 관리합니다.
15+
16+
## Examples
17+
18+
```tsx copy filename="TestComponent.tsx"
19+
20+
const TestComponent = () => {
21+
const [isModalOpen, setIsModalOpen] = useState<boolean>(false);
22+
23+
useScrollLock(isModalOpen);
24+
25+
const openModal = () => {
26+
setIsModalOpen(true);
27+
};
28+
29+
const closeModal = () => {
30+
setIsModalOpen(false);
31+
};
32+
33+
return (
34+
<div style={styles.container}>
35+
{isModalOpen && (
36+
<div style={styles.modal}>
37+
<div style={styles.modalContent}>
38+
...
39+
</div>
40+
);
41+
};
42+
43+
```

0 commit comments

Comments
 (0)