Added docs

This commit is contained in:
Daniel Cojocea committed 2024-08-30 13:22:12 -04:00
1 parent de0e3514ad
commit 7591de9d3d
1 file changed
+19 -2
+19 -2
View File
@@ -1,9 +1,22 @@
import PropTypes from "prop-types";
import { useTheme } from "@emotion/react";
import { Box, Typography } from "@mui/material";
import React from "react";
import { useSelector } from "react-redux";
const Greeting = ({ type }) => {
/**
* Greeting component that displays a personalized greeting message
* based on the time of day and the user's first name.
*
* @component
* @example
* return <Greeting type={"pagespeed"} />;
*
* @param {Object} props
* @param {string} props.type - The type of monitor to be displayed in the message
* @returns {JSX.Element} The rendered Greeting component
*/
const Greeting = ({ type = "" }) => {
const theme = useTheme();
const { firstName } = useSelector((state) => state.auth.user);
@@ -55,4 +68,8 @@ const Greeting = ({ type }) => {
);
};
Greeting.propTypes = {
type: PropTypes.string,
};
export default Greeting;