From d0ecdae9f3093f78d47f74125e9d89cefdd75d6f Mon Sep 17 00:00:00 2001
From: Alex Gleason <alex@alexgleason.me>
Date: Thu, 12 May 2022 11:55:13 -0500
Subject: [PATCH] SidebarNavigationLink: add jsdoc comments

---
 app/soapbox/components/sidebar-navigation-link.tsx | 8 +++++++-
 1 file changed, 7 insertions(+), 1 deletion(-)

diff --git a/app/soapbox/components/sidebar-navigation-link.tsx b/app/soapbox/components/sidebar-navigation-link.tsx
index 9dbedd46a..9442a4cc4 100644
--- a/app/soapbox/components/sidebar-navigation-link.tsx
+++ b/app/soapbox/components/sidebar-navigation-link.tsx
@@ -5,13 +5,19 @@ import { NavLink } from 'react-router-dom';
 import { Icon, Text, Counter } from './ui';
 
 interface ISidebarNavigationLink {
+  /** Notification count, if any. */
   count?: number,
+  /** URL to an SVG icon. */
   icon: string,
-  text: string | React.ReactElement,
+  /** Link label. */
+  text: React.ReactElement,
+  /** Route to an internal page. */
   to?: string,
+  /** Callback when the link is clicked. */
   onClick?: React.EventHandler<React.MouseEvent>,
 }
 
+/** Desktop sidebar navigation link. */
 const SidebarNavigationLink = React.forwardRef((props: ISidebarNavigationLink, ref: React.ForwardedRef<HTMLAnchorElement>): JSX.Element => {
   const { icon, text, to = '', count, onClick } = props;
   const isActive = location.pathname === to;