📔 Document Badge

nest_frontend/components/base/Badge.js

@@ -5,6 +5,18 @@ import { FontAwesomeIcon } from "@fortawesome/react-fontawesome"
 import ButtonSmallX from "./ButtonSmallX"
 
 
+/**
+ * A small colored badge.
+ *
+ * @param icon - The icon that the badge should have on the left.
+ * @param color - The color that the badge should have.
+ * @param onClickDelete - The action to perform when the X button is clicked. If undefined, the X button won't be shown.
+ * @param children - The text of the badge.
+ * @param className - Additional class(es) to append to the badge.
+ * @param props - Additional props to pass to the badge.
+ * @returns {JSX.Element}
+ * @constructor
+ */
 export default function Badge({ icon, color, onClickDelete, children, className, ...props }) {
     return (
         <div className={classNames(Style.Badge, Style[`Badge${color}`], className)} {...props}>

nest_frontend/components/interactive/BadgeCondition.js

@@ -23,7 +23,7 @@ const CONDITION_ICONS = {
 
 
 /**
- * A small colored badge representing a Condition for a filter.
+ * A {@link Badge} representing a Condition for a filter.
  *
  * @param condition - The Condition that this badge represents.
  * @returns {JSX.Element}