moon
/
soapbox
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

SidebarNavigationLink: add jsdoc comments

This commit is contained in:
Alex Gleason 2022-05-12 11:55:13 -05:00
parent 2bd468358b
commit d0ecdae9f3
No known key found for this signature in database
GPG Key ID: 7211D1F99744FBB7
1 changed files with 7 additions and 1 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

8
app/soapbox/components/sidebar-navigation-link.tsx
View File

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