Skip to content

Expose Main ContentBody ref #59

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

Merged
manni497 merged 3 commits into from
Oct 8, 2024
Merged

Expose Main ContentBody ref #59

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
0082ca4
x
Oct 8, 2024
7718a10
Release 4.2.0-rc.0
Oct 8, 2024
69d144e
undo package.json
Oct 8, 2024
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
4 changes: 4 additions & 0 deletions CHANGELOG.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -7,6 +7,10 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0

## [Unreleased]

### Added

- Expose `mainContentBodyRef` in order to control main body behaviour (e.g. scroll to top on page change)

## [4.1.1] - 2024-07-18

### Fixed
Expand Down
12 changes: 10 additions & 2 deletions src/lib/Layout/PanelSideBarLayout/PanelSideBarLayout.tsx
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
import classNames from "classnames";
import { PropsWithChildren, ReactNode } from "react";
import { MutableRefObject, PropsWithChildren, ReactNode } from "react";
import "../../../../styles/Layout/index.scss";
import { PanelSideBar } from "./PanelSideBar/PanelSidebar";
import { PanelSideBarLayoutContent } from "./PanelSideBarLayoutContent";
Expand Down Expand Up @@ -38,6 +38,11 @@ export interface PanelSideBarLayoutProps extends PropsWithChildren {
* If use the responsive layout when the screen is sm in order to remove the sidebar overlay.
*/
useResponsiveLayout?: boolean;

/**
* the main content body ref
*/
mainContentBodyRef?: MutableRefObject<HTMLElement | null>;
}

export const PanelSideBarLayout = <TPanelItemId extends string, TPanelItem>(props: PanelSideBarLayoutProps) => {
Expand All @@ -50,6 +55,7 @@ export const PanelSideBarLayout = <TPanelItemId extends string, TPanelItem>(prop
collapsible = true,
useToggleButton = false,
useResponsiveLayout = false,
mainContentBodyRef,
} = props;

const { isSidebarOpen, toggleSidebar, renderFirstItemsLevelAsTiles } = usePanelSideBarContext<TPanelItemId, TPanelItem>();
Expand All @@ -76,7 +82,9 @@ export const PanelSideBarLayout = <TPanelItemId extends string, TPanelItem>(prop
>
<PanelSideBar<TPanelItemId, TPanelItem> />
{collapsible && !useToggleButton && <PanelSideBarToggle onClick={toggleSidebar} toggled={!isSidebarOpen} />}
<PanelSideBarLayoutContent footer={footer}>{children}</PanelSideBarLayoutContent>
<PanelSideBarLayoutContent footer={footer} mainContentBodyRef={mainContentBodyRef}>
{children}
</PanelSideBarLayoutContent>
</section>
</>
);
Expand Down
7 changes: 4 additions & 3 deletions src/lib/Layout/PanelSideBarLayout/PanelSideBarLayoutContent.tsx
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,14 +1,15 @@
import { PropsWithChildren, ReactNode } from "react";
import { MutableRefObject, PropsWithChildren, ReactNode } from "react";

interface PanelSideBarLayoutContentProps extends PropsWithChildren {
footer?: ReactNode;
mainContentBodyRef?: MutableRefObject<HTMLElement | null>;
}

export const PanelSideBarLayoutContent = (props: PanelSideBarLayoutContentProps) => {
const { children, footer } = props;
const { children, footer, mainContentBodyRef } = props;

return (
<section id="main-content-body" className="content">
<section ref={mainContentBodyRef} id="main-content-body" className="content">
<main className="container-fluid">{children}</main>
<footer hidden={!footer} className="py-4 bg-light mt-auto">
<div className="mx-4">
Expand Down