monday-ui-react-core/src/hooks/useDisableScroll/__stories__/useDisableScroll.mdx

Official monday.com UI resources for application development in React.js

import { Canvas, Meta } from "@storybook/blocks";
import { FunctionArgument, FunctionArguments, UsageGuidelines } from "vibe-storybook-components";
import * as UseDisableScrollStories from "./useDisableScroll.stories";

<Meta of={UseDisableScrollStories} />

# useDisableScroll

- [Overview](#overview)
- [Returns](#returns)
- [Usage](#usage)
- [Feedback](#feedback)

## Overview

Use this hook to disable scroll for element.

<Canvas of={UseDisableScrollStories.Overview} />

## Returns

<FunctionArguments>
  <FunctionArgument name="disableScroll" type="function" description="Call this function to disable scroll." />
  <FunctionArgument name="enableScroll" type="function" description="Call this function to enable scroll." />
</FunctionArguments>

## Usage

<UsageGuidelines guidelines={["Use this hook when you want block users scroll."]} />