Skip to content

Feat(frontend): add overlay scrollbar to main element #66

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.

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

Merged
merged 2 commits into from
Jan 31, 2025
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
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
2 changes: 2 additions & 0 deletions frontend/package.json
Original file line number Diff line number Diff line change
Expand Up @@ -16,6 +16,8 @@
"graphql": "^16.9.0",
"graphql-request": "^7.1.0",
"next": "^15.1.4",
"overlayscrollbars": "^2.10.1",
"overlayscrollbars-react": "^0.5.6",
"react": "^19.0.0",
"react-dom": "^19.0.0",
"react-use": "^17.6.0"
Expand Down
8 changes: 5 additions & 3 deletions frontend/src/app/layout.tsx
Original file line number Diff line number Diff line change
Expand Up @@ -4,8 +4,10 @@ import { Urbanist } from "next/font/google";

import Footer from "@/components/Footer";
import Navbar from "@/components/Navbar";
import OverlayScrollbarBody from "@/components/OverlayScrollbarMain";
import { navbarQuery, NavbarQueryType } from "@/queries/navbar";
import "@/styles/globals.css";
import "overlayscrollbars/overlayscrollbars.css";
import { request } from "@/utils/graphQLClient";

const urbanist = Urbanist({
Expand All @@ -21,14 +23,14 @@ export default async function RootLayout({
const navbarData = await request<NavbarQueryType>(navbarQuery);

return (
<html lang="en">
<body className="antialiased">
<html lang="en" data-overlayscrollbars-initialize>
<OverlayScrollbarBody className="bg-background-1 antialiased">
<main className={urbanist.className}>
<Navbar {...{ navbarData }} />
{children}
<Footer />
</main>
</body>
</OverlayScrollbarBody>
</html>
);
}
27 changes: 27 additions & 0 deletions frontend/src/components/OverlayScrollbarMain.tsx
Original file line number Diff line number Diff line change
@@ -0,0 +1,27 @@
"use client";

import React from "react";

import { OverlayScrollbarsComponent } from "overlayscrollbars-react";
import "overlayscrollbars/overlayscrollbars.css";

interface IOverlayScrollbarBody extends React.ComponentProps<"body"> {
children: React.ReactNode;
}

const OverlayScrollbarBody: React.FC<IOverlayScrollbarBody> = ({
children,
className,
}) => (
<OverlayScrollbarsComponent
element="body"
{...{ className }}
defer
data-overlayscrollbars-initialize
options={{ scrollbars: { autoHide: "move" } }}
>
{children}
</OverlayScrollbarsComponent>
);

export default OverlayScrollbarBody;
4 changes: 4 additions & 0 deletions frontend/src/styles/globals.css
Original file line number Diff line number Diff line change
Expand Up @@ -7,6 +7,10 @@
--foreground: #171717;
}

.os-scrollbar {
--os-handle-bg: #42498f;
}

@media (prefers-color-scheme: dark) {
:root {
--background: #0a0a0a;
Expand Down
19 changes: 19 additions & 0 deletions frontend/yarn.lock
Original file line number Diff line number Diff line change
Expand Up @@ -2120,6 +2120,8 @@ __metadata:
husky: "npm:^9.1.7"
lint-staged: "npm:^15.3.0"
next: "npm:^15.1.4"
overlayscrollbars: "npm:^2.10.1"
overlayscrollbars-react: "npm:^0.5.6"
postcss: "npm:^8"
prettier: "npm:^3.4.2"
prettier-plugin-tailwindcss: "npm:^0.6.9"
Expand Down Expand Up @@ -3577,6 +3579,23 @@ __metadata:
languageName: node
linkType: hard

"overlayscrollbars-react@npm:^0.5.6":
version: 0.5.6
resolution: "overlayscrollbars-react@npm:0.5.6"
peerDependencies:
overlayscrollbars: ^2.0.0
react: ">=16.8.0"
checksum: 10/473f5af860feab4b5418f9adc8e356fb201e9de61286443ff64002b9c997bc19bf17cf60e314c502c14ca41fa213c12f18111e6fe913be86ad68a15c32e66789
languageName: node
linkType: hard

"overlayscrollbars@npm:^2.10.1":
version: 2.10.1
resolution: "overlayscrollbars@npm:2.10.1"
checksum: 10/dfea9d3cf439a50b671119a806c42a7b49ad8db686a607ac8874706da092aa3cf69542605fb600dc96ee94df54b785a81c1cbdca16e8bd3fd69ba3d16ab192a1
languageName: node
linkType: hard

"own-keys@npm:^1.0.1":
version: 1.0.1
resolution: "own-keys@npm:1.0.1"
Expand Down