Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
1 change: 1 addition & 0 deletions docs/pages/docs/hooks/_meta.json
Original file line number Diff line number Diff line change
Expand Up @@ -3,6 +3,7 @@
"useKeyCombination": "useKeyCombination",
"useLongPress": "useLongPress",
"useMousePosition": "useMousePosition",
"useScrollLock": "useScrollLock",
"useSound": "useSound",
"useTimer": "useTimer",
"useToggle": "useToggle",
Expand Down
44 changes: 44 additions & 0 deletions docs/pages/docs/hooks/useScrollLock.mdx
Original file line number Diff line number Diff line change
@@ -0,0 +1,44 @@
# useScrollLock

## Introduce

페이지의 스크롤을 잠궈 사용자가 스크롤할 수 없도록 합니다.

(스크롤 바가 비활성화된 상태로, UI형태가 유지된 형태)

```ts
const useScrollLock = (props: boolean): void
```

### Props

boolean 값으로 스크롤의 잠금 여부를 관리합니다.

## Examples

```tsx copy filename="TestComponent.tsx"

const TestComponent = () => {
const [isModalOpen, setIsModalOpen] = useState<boolean>(false);

useScrollLock(isModalOpen);

const openModal = () => {
setIsModalOpen(true);
};

const closeModal = () => {
setIsModalOpen(false);
};

return (
<div style={styles.container}>
{isModalOpen && (
<div style={styles.modal}>
<div style={styles.modalContent}>
...
</div>
);
};

```