Adding JSDoc
This commit is contained in:
1 parent
677cff1737
commit
58fc687de1
2 files changed
+30
-9
No files matched your search
@@ -2,6 +2,19 @@ import "./check.css";
|
||||
import React from "react";
|
||||
import CheckGrey from "../../assets/Images/Check-icon-grey.png";
|
||||
|
||||
/**
|
||||
* `Check` is a functional React component that displays a check icon and a label.
|
||||
*
|
||||
* @component
|
||||
* @param {Object} props - The properties that define the `Check` component.
|
||||
* @param {string} props.text - The text to be displayed as the label next to the check icon.
|
||||
*
|
||||
* @example
|
||||
* // To use this component, import it and use it in your JSX like this:
|
||||
* <Check text="Your Text Here" />
|
||||
*
|
||||
* @returns {React.Element} The `Check` component with a check icon and a label, defined by the `text` prop.
|
||||
*/
|
||||
const Check = ({ text }) => {
|
||||
return (
|
||||
<div className="check">
|
||||
|
||||
Reference in new issue
Block a user