@kiwicom/orbit-components/lib/hooks/useLockScrolling/README.md

Orbit-components is a React component library which provides developers with the easiest possible way of building Kiwi.com’s products.

# useLockScrolling

The `useLockScrolling` hook is useful when you want to lock scrolling to a given element, for example when a modal is open you want only its content to be scrollable, not the entire page.

To implement the `useLockScrolling` hook in your component, add the import:

```jsx
import useLockScrolling from "@kiwicom/orbit-components/lib/hooks/useLockScrolling";
```

Then you can use it:

```jsx
const Component = (props: Props) => {
  const scrollableElementRef = (useRef < HTMLElement) | (null > null);

  // locks the scrolling only to ScrollableContainer
  useLockScrolling(scollableElementRef);

  return <ScrollableContainer ref={scrollableElementRef}>Hello world!</ScrollableContainer>;
};
```

## Props

The table below contains all parameters available to the `useLockScrolling` hook.

| Name         | Type                               | Default | Description                                                                                                     |
| :----------- | :--------------------------------- | ------- | :-------------------------------------------------------------------------------------------------------------- |
| ref          | `{ current: HTMLElement \| null }` |         | Reference object of the scrollable container.                                                                   |
| lock         | `boolean`                          | `true`  | Whether to lock scrolling or not. This is useful for example if locking scrolling depends on a breakpoint.      |
| dependencies | `any[]`                            | `[]`    | Dependencies that affect the value of `ref.current`, in case it's not always assigned to the same HTML element. |