Added className prop to Page component and override styles in the TechDocsReaderPage.tsx

Signed-off-by: Alex Lorenzi <alorenzi@spotify.com>
This commit is contained in:
Alex Lorenzi
2025-01-22 12:13:55 -05:00
parent d381f3ec6a
commit bbaa722f80
2 changed files with 23 additions and 19 deletions
@@ -16,6 +16,7 @@
import React from 'react';
import { makeStyles, Theme, ThemeProvider } from '@material-ui/core/styles';
import classNames from 'classnames';
export type PageClassKey = 'root';
@@ -44,12 +45,13 @@ const useStyles = makeStyles(
type Props = {
themeId: string;
className?: string;
children?: React.ReactNode;
};
export function Page(props: Props) {
const { themeId, children } = props;
const classes = useStyles();
const { themeId, className, children } = props;
const styles = useStyles();
return (
<ThemeProvider
theme={(baseTheme: Theme) => ({
@@ -57,7 +59,7 @@ export function Page(props: Props) {
page: baseTheme.getPageTheme({ themeId }),
})}
>
<main className={classes.root}>{children}</main>
<main className={classNames(styles.root, className)}>{children}</main>
</ThemeProvider>
);
}
@@ -14,14 +14,14 @@
* limitations under the License.
*/
import React, { ReactNode, Children, ReactElement } from 'react';
import React, { Children, ReactElement, ReactNode } from 'react';
import { useOutlet } from 'react-router-dom';
import { Page } from '@backstage/core-components';
import { CompoundEntityRef } from '@backstage/catalog-model';
import {
TECHDOCS_ADDONS_WRAPPER_KEY,
TECHDOCS_ADDONS_KEY,
TECHDOCS_ADDONS_WRAPPER_KEY,
TechDocsReaderPageProvider,
} from '@backstage/plugin-techdocs-react';
@@ -37,8 +37,13 @@ import {
} from '@backstage/core-plugin-api';
import { CookieAuthRefreshProvider } from '@backstage/plugin-auth-react';
import { ThemeOptions } from '@material-ui/core/styles';
import { createTheme, ThemeProvider, useTheme } from '@material-ui/core/styles';
import {
createTheme,
makeStyles,
ThemeOptions,
ThemeProvider,
useTheme,
} from '@material-ui/core/styles';
/* An explanation for the multiple ways of customizing the TechDocs reader page
@@ -117,6 +122,13 @@ are retrieved using the useOutlet hook from React Router.
NOTE: Render functions are no longer supported in this approach.
*/
const useStyles = makeStyles({
readerPage: {
height: 'inherit',
overflowY: 'visible',
},
});
/**
* Props for {@link TechDocsReaderLayout}
* @public
@@ -163,19 +175,10 @@ export type TechDocsReaderPageProps = {
*/
export const TechDocsReaderPage = (props: TechDocsReaderPageProps) => {
const currentTheme = useTheme();
const classes = useStyles();
const readerPageTheme = createTheme({
...currentTheme,
overrides: {
// This fixes issues with double scrolls in the TechDocs reader page on EntityPage
// @ts-ignore BackstagePage is not in the theme type
BackstagePage: {
root: {
height: 'inherit',
overflowY: 'visible',
},
},
},
...(props.overrideThemeOptions || {}),
});
const { kind, name, namespace } = useRouteRefParams(rootDocsRouteRef);
@@ -207,7 +210,6 @@ export const TechDocsReaderPage = (props: TechDocsReaderPageProps) => {
</ThemeProvider>
);
}
// As explained above, a render function is configuration 3 and React element is 2
return (
<ThemeProvider theme={readerPageTheme}>
@@ -215,7 +217,7 @@ export const TechDocsReaderPage = (props: TechDocsReaderPageProps) => {
<TechDocsReaderPageProvider entityRef={entityRef}>
{({ metadata, entityMetadata, onReady }) => (
<div className="techdocs-reader-page">
<Page themeId="documentation">
<Page themeId="documentation" className={classes.readerPage}>
{children instanceof Function
? children({
entityRef,