Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

docs(Modal): remove scroll and autofocus even on second open of Modal #2670

Merged
merged 1 commit into from
Dec 20, 2024
Merged

docs(Modal): remove scroll and autofocus even on second open of Modal #2670

Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
10 changes: 3 additions & 7 deletions packages/core/src/components/Modal/Modal/__stories__/Modal.stories.helpers.tsx
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,7 +1,6 @@
import React, { forwardRef, useEffect, useRef, useState } from "react";
import Button from "../../../Button/Button";
import { StorybookLink, Tip } from "vibe-storybook-components";
import { useAfterFirstRender } from "../../../../hooks";
import cx from "classnames";
import styles from "./Modal.stories.module.scss";
import { getStyle } from "../../../../helpers/typesciptCssModulesHelper";
Expand All @@ -21,14 +20,12 @@ export const OpenedModalPreview = forwardRef(
},
ref: React.ForwardedRef<HTMLDivElement>
) => {
const isAfterFirstRender = useAfterFirstRender();
return (
<div
className={cx(styles.preview, { [getStyle(styles, size)]: isDocsView })}
ref={ref}
// workaround to prevent modal from autofocusing on page load
// autofocus would work as expected when modal closes and reopens
{...(!isAfterFirstRender.current && isDocsView && { "data-no-autofocus": true })}
{...(isDocsView && { "data-no-autofocus": true })}
>
<Button onClick={onOpenModalClick}>Open Modal</Button>
{modal}
Expand All @@ -51,8 +48,7 @@ export const useRemoveModalScrollLock = (show: boolean, isDocsView?: boolean) =>
);
});
}
// eslint-disable-next-line react-hooks/exhaustive-deps -- this is intended to run once, on mount
}, []);
}, [show, isDocsView]);
};

export function withOpenedModalPreview(
Expand All @@ -65,7 +61,7 @@ export function withOpenedModalPreview(
) {
const [show, setShow] = useState(true);
const container = useRef<HTMLElement>(null);
useRemoveModalScrollLock(show, isDocsView); // internal hook, for documentation purposes, to enable scroll on first load
useRemoveModalScrollLock(show, isDocsView); // internal hook, for documentation purposes, to enable page scroll on docs view

return (
// internal component, for documentation purposes, to open modal inside a container
Expand Down
Loading