aboutsummaryrefslogtreecommitdiffstats
path: root/src/components/atoms/overlay/overlay.tsx
diff options
context:
space:
mode:
Diffstat (limited to 'src/components/atoms/overlay/overlay.tsx')
-rw-r--r--src/components/atoms/overlay/overlay.tsx47
1 files changed, 47 insertions, 0 deletions
diff --git a/src/components/atoms/overlay/overlay.tsx b/src/components/atoms/overlay/overlay.tsx
new file mode 100644
index 0000000..7dd7446
--- /dev/null
+++ b/src/components/atoms/overlay/overlay.tsx
@@ -0,0 +1,47 @@
+import {
+ forwardRef,
+ type ForwardRefRenderFunction,
+ type HTMLAttributes,
+ type ReactNode,
+} from 'react';
+import { useScrollLock } from '../../../utils/hooks';
+import styles from './overlay.module.scss';
+
+export type OverlayProps = HTMLAttributes<HTMLDivElement> & {
+ /**
+ * The elements to display in front of the overlay.
+ */
+ children: ReactNode;
+ /**
+ * Should the overlay be visible?
+ *
+ * Use it if you want an animated overlay instead of mounting/demounting it.
+ *
+ * @default true
+ */
+ isVisible?: boolean;
+};
+
+const OverlayWithRef: ForwardRefRenderFunction<HTMLDivElement, OverlayProps> = (
+ { children, className = '', isVisible = true, ...props },
+ ref
+) => {
+ const overlayClass = [
+ styles.overlay,
+ styles[isVisible ? 'overlay--visible' : 'overlay--hidden'],
+ className,
+ ].join(' ');
+
+ useScrollLock(isVisible);
+
+ return (
+ <div {...props} className={overlayClass} ref={ref}>
+ {children}
+ </div>
+ );
+};
+
+/**
+ * Overlay component.
+ */
+export const Overlay = forwardRef(OverlayWithRef);