fix: refactor readme

gravity-ui · Oct 4, 2023 · 8efe691 · 8efe691
1 parent 9b8c861
commit 8efe691
Show file tree

Hide file tree

Showing 8 changed files with 12 additions and 14 deletions.
diff --git a/src/components/Modal/Modal.tsx b/src/components/Modal/Modal.tsx
@@ -2,7 +2,7 @@ import React from 'react';
 
 import {CSSTransition} from 'react-transition-group';
 
-import {useBodyScrollLock} from '../../hooks/useBodyScrollLock';
+import {useBodyScrollLock} from '../../hooks';
 import {Portal} from '../Portal';
 import type {DOMProps, QAProps} from '../types';
 import {FocusTrap} from '../utils/FocusTrap';

diff --git a/src/components/Popup/__stories__/Popup.stories.tsx b/src/components/Popup/__stories__/Popup.stories.tsx
@@ -2,7 +2,7 @@ import React from 'react';
 
 import type {Meta, StoryFn} from '@storybook/react';
 
-import {useVirtualElementRef} from '../../../hooks/useVirtualElementRef';
+import {useVirtualElementRef} from '../../../hooks';
 import {Button} from '../../Button';
 import {TextInput} from '../../controls';
 import {Popup} from '../Popup';

diff --git a/src/components/Portal/Portal.tsx b/src/components/Portal/Portal.tsx
@@ -2,7 +2,7 @@ import React from 'react';
 
 import ReactDOM from 'react-dom';
 
-import {usePortalContainer} from '../../hooks/usePortalContainer/usePortalContainer';
+import {usePortalContainer} from '../../hooks';
 
 export interface PortalProps {
     container?: HTMLElement;

diff --git a/src/components/layout/demo/LayoutPresenter/LayoutPresenter.tsx b/src/components/layout/demo/LayoutPresenter/LayoutPresenter.tsx
@@ -3,7 +3,7 @@ import React from 'react';
 import {Text} from '../../../Text';
 import {Flex} from '../../Flex/Flex';
 import {LayoutProvider} from '../../LayoutProvider/LayoutProvider';
-import {useLayoutContext} from '../../hooks/useLayoutContext';
+import {useLayoutContext} from '../../hooks';
 import {sp} from '../../spacing/spacing';
 
 interface LayoutPresenterProps {

diff --git a/src/hooks/useBodyScrollLock/index.ts b/src/hooks/useBodyScrollLock/index.ts
@@ -1,2 +1,2 @@
 export {useBodyScrollLock} from './useBodyScrollLock';
-export type {BodyScrollLockProps} from './useBodyScrollLock';
+export type {BodyScrollLockProps, UseBodyScrollLockProps} from './useBodyScrollLock';
diff --git a/src/hooks/useBodyScrollLock/useBodyScrollLock.ts b/src/hooks/useBodyScrollLock/useBodyScrollLock.ts
@@ -1,13 +1,15 @@
 import React from 'react';
 
-export interface BodyScrollLockProps {
+export interface UseBodyScrollLockProps {
     enabled: boolean;
 }
 
+export type BodyScrollLockProps = UseBodyScrollLockProps;
+
 let locks = 0;
 let storedBodyStyle: string | undefined;
 
-export function useBodyScrollLock({enabled}: BodyScrollLockProps) {
+export function useBodyScrollLock({enabled}: UseBodyScrollLockProps) {
     React.useLayoutEffect(() => {
         if (enabled) {
             locks++;

diff --git a/src/hooks/usePortalContainer/README.md b/src/hooks/usePortalContainer/README.md
@@ -12,6 +12,4 @@ The `usePortalContainer` hook returns portal container element in the current sc
 
 ## Result
 
-| Name      | Description                  |         Type         |
-| :-------- | :--------------------------- | :------------------: |
-| container | Container element for portal | `HTMLElement - null` |
+Container element for portal. `HTMLElement | null`
diff --git a/src/hooks/useVirtualElementRef/README.md b/src/hooks/useVirtualElementRef/README.md
@@ -17,8 +17,6 @@ The `useVirtualElementRef` hook helps to create virtual element for popup
 | rect           | Position of virtual element relative to viewport | `{top, bottom, left, right}: {[x]:number}` |         |
 | contextElement | DOM-context of virtual element                   |                 `Element`                  |         |
 
-## Return
+## Result
 
-| Name | Description              |       Type        |
-| :--- | :----------------------- | :---------------: |
-| ref  | Virtual element ref link | `React.RefObject` |
+Virtual element ref link. `React.RefObject`