From c23899cbc44b4c3c1d49b5515b4db39637b6bd51 Mon Sep 17 00:00:00 2001 From: Daniel Cojocea Date: Thu, 22 Aug 2024 12:24:56 -0400 Subject: [PATCH] Added docs and proptypes --- Client/src/Components/Animated/PulseDot.jsx | 18 ++++++++++++++++++ 1 file changed, 18 insertions(+) diff --git a/Client/src/Components/Animated/PulseDot.jsx b/Client/src/Components/Animated/PulseDot.jsx index 46ba960f3..4ec04c226 100644 --- a/Client/src/Components/Animated/PulseDot.jsx +++ b/Client/src/Components/Animated/PulseDot.jsx @@ -1,5 +1,19 @@ +import PropTypes from "prop-types"; import { Box, Stack } from "@mui/material"; +/** + * A component that renders a pulsating dot with a specified color. + * + * @component + * @example + * // Example usage: + * + * + * @param {Object} props + * @param {string} props.color - The color of the dot. + * @returns {JSX.Element} The PulseDot component. + */ + const PulseDot = ({ color }) => { return ( { ); }; +PulseDot.propTypes = { + color: PropTypes.string.isRequired, +}; + export default PulseDot;