Updated JSdocs

This commit is contained in:
Alex Holliday committed 2024-05-07 14:30:00 -07:00
1 parent 6359fd52b6
commit bc463802d9
4 files changed
+16 -6

No files matched your search

+1 -1
View File
@@ -14,7 +14,7 @@ import { useTheme } from "@mui/material";
* @param {Object} props
* @param {string} props.label - The label of the label
* @param {Styles} props.styles - CSS Styles passed from parent component
* @param {React.ReactNode} children - CSS Styles passed from parent component
* @param {React.ReactNode} children - Children passed from parent component
* @returns {JSX.Element}
*/
+4 -1
View File
@@ -26,8 +26,11 @@ const lightenColor = (color, percent) => {
* @component
* @param {Object} props
* @param {string} props.label - The label of the label
* @param {string} props.color - The color of the label
* @param {string} props.color - The color of the label, specified in #RRGGBB format
* @returns {JSX.Element}
* @example
* // Render a red label
* <ColoredLabel label="Label" color="#FF0000" />
*/
const ColoredLabel = ({ label, color }) => {
@@ -8,6 +8,9 @@ import { useTheme } from "@mui/material";
* @param {Object} props
* @param {'Seen' | 'Waiting' | 'New' | 'Active'} props.status - The status for the label
* @returns {JSX.Element}
* @example
* // Render an active label
* <StatusLabel status="Active" />
*/
const StatusLabel = ({ status }) => {