Checkmate/client/src/Components/v1/Subheader/index.jsx

import PropTypes from "prop-types";
import { useTheme } from "@emotion/react";
import { Stack, Typography } from "@mui/material";

/**

 *
 * @component
 * @example
 *
 * @param {boolean} props.shouldRender - Whether to render the subheader
 * @param {string} props.direction - Direction of the subheader
 * @param {string} props.headerText - Header text
 * @param {number} props.headerLevel - Font characteristic of the header
 * @param {string} props.subHeaderText - Subheader text
 * @param {number} props.subHeaderLevel - Font characteristic of the subheader
 * @param {string} props.alignItems - Align items
 * @param {node} props.children - Children
 * @returns {JSX.Element} The rendered component
 */

const SubHeader = ({
	shouldRender = true,
	direction = "row",
	headerText,
	headerLevel = 1,
	subHeaderText,
	subHeaderLevel = 1,
	alignItems = "center",
	children,
	...props
}) => {
	const theme = useTheme();

	if (!shouldRender) {
		return null;
	}

	return (
		<Stack
			direction={direction}
			alignItems={alignItems}
			justifyContent="space-between"
			{...props}
		>
			<Stack direction={"column"}>
				<Typography
					component={`h${headerLevel}`}
					variant={`h${headerLevel}`}
					mb={theme.spacing(1)}
				>
					<Typography
						component="span"
						fontSize="inherit"
						color={theme.palette.primary.contrastTextTertiary}
					>
						{headerText}
					</Typography>
				</Typography>
				<Typography
					variant={`body${subHeaderLevel}`}
					color={theme.palette.primary.contrastTextTertiary}
				>
					{subHeaderText}
				</Typography>
			</Stack>
			{children}
		</Stack>
	);
};

SubHeader.propTypes = {
	shouldRender: PropTypes.bool,
	direction: PropTypes.oneOfType([PropTypes.string, PropTypes.object]),
	headerText: PropTypes.string,
	headerLevel: PropTypes.number,
	subHeaderText: PropTypes.string,
	subHeaderLevel: PropTypes.number,
	alignItems: PropTypes.oneOfType([PropTypes.string, PropTypes.object]),
	children: PropTypes.node,
};

export default SubHeader;