Files
netbird-docs/src/components/NavigationAPI.jsx

344 lines
10 KiB
JavaScript

import Link from 'next/link'
import { useRouter } from 'next/router'
import clsx from 'clsx'
import { AnimatePresence, motion } from 'framer-motion'
import { Button } from '@/components/Button'
import { Tag } from '@/components/Tag'
import { remToPx } from '@/lib/remToPx'
import { useEffect, useState } from 'react'
import {
NavigationStateProvider,
useNavigationState,
} from '@/components/NavigationState'
export const apiNavigation = [
{
title: 'Guides',
links: [
{ title: 'Quickstart', href: '/api/guides/quickstart' },
{ title: 'Authentication', href: '/api/guides/authentication' },
{ title: 'Errors', href: '/api/guides/errors' },
{ title: 'MSP API access', href: '/api/guides/msp-api-access' },
],
},
{
title: 'Resources',
links: [
{ title: 'Accounts', href: '/api/resources/accounts' },
{ title: 'Users', href: '/api/resources/users' },
{ title: 'Tokens', href: '/api/resources/tokens' },
{ title: 'Peers', href: '/api/resources/peers' },
{ title: 'Setup Keys', href: '/api/resources/setup-keys' },
{ title: 'Groups', href: '/api/resources/groups' },
{ title: 'Policies', href: '/api/resources/policies' },
{ title: 'Posture Checks', href: '/api/resources/posture-checks' },
{ title: 'Geo Locations', href: '/api/resources/geo-locations' },
{ title: 'Routes (deprecated)', href: '/api/resources/routes' },
{ title: 'Networks', href: '/api/resources/networks' },
{ title: 'DNS', href: '/api/resources/dns' },
{ title: 'DNS Zones', href: '/api/resources/dns-zones' },
{ title: 'Services', href: '/api/resources/services' },
{ title: 'Agent Network', href: '/api/resources/agent-network' },
{ title: 'Events', href: '/api/resources/events' },
{
title: 'Event Streaming',
href: '/api/resources/event-streaming-integrations',
},
{ title: 'Jobs', href: '/api/resources/jobs' },
{
title: 'Identity Providers',
href: '/api/resources/identity-providers',
},
{ title: 'Instance', href: '/api/resources/instance' },
],
},
{
title: 'Cloud Resources',
links: [
{ title: 'Ingress Ports', href: '/api/resources/ingress-ports' },
{
title: 'IDP (Azure API)',
href: '/api/resources/idp-azure-integrations',
},
{
title: 'IDP (Google API)',
href: '/api/resources/idp-google-integrations',
},
{
title: 'IDP (Okta SCIM)',
href: '/api/resources/idp-okta-scim-integrations',
},
{
title: 'IDP (SCIM Generic)',
href: '/api/resources/idp-scim-integrations',
},
{
title: 'Event Streaming',
href: '/api/resources/event-streaming-integrations',
},
{ title: 'EDR Peers', href: '/api/resources/edr-peers' },
{ title: 'EDR Falcon', href: '/api/resources/edr-falcon-integrations' },
{ title: 'EDR FleetDM', href: '/api/resources/edr-fleetdm-integrations' },
{
title: 'EDR Huntress',
href: '/api/resources/edr-huntress-integrations',
},
{ title: 'EDR Intune', href: '/api/resources/edr-intune-integrations' },
{
title: 'EDR SentinelOne',
href: '/api/resources/edr-sentinelone-integrations',
},
{ title: 'Notifications', href: '/api/resources/notifications' },
{ title: 'MSP', href: '/api/resources/msp' },
{ title: 'Invoice', href: '/api/resources/invoice' },
{ title: 'Usage', href: '/api/resources/usage' },
],
},
]
export function NavigationAPI({ tableOfContents, className }) {
return (
<nav className={className}>
<ul role="list">
<TopLevelNavItem href="https://netbird.io/">Home</TopLevelNavItem>
<TopLevelNavItem href="/">Docs</TopLevelNavItem>
<TopLevelNavItem href="/api">API</TopLevelNavItem>
<TopLevelNavItem href="https://netbird.io/knowledge-hub/">
Learn
</TopLevelNavItem>
<TopLevelNavItem href="https://github.com/netbirdio/netbird">
Github
</TopLevelNavItem>
<TopLevelNavItem href="/slack-url">Support</TopLevelNavItem>
{apiNavigation.map((group, groupIndex) => (
<NavigationStateProvider key={group.title} index={groupIndex}>
<NavigationGroup
group={group}
tableOfContents={tableOfContents}
className={groupIndex === 0 && 'md:mt-0'}
/>
</NavigationStateProvider>
))}
<li className="sticky bottom-0 z-10 mt-6 min-[416px]:hidden">
<Button
href="https://app.netbird.io/"
variant="filled"
className="w-full"
>
Sign in
</Button>
</li>
</ul>
</nav>
)
}
export function TopLevelNavItem({ href, children }) {
return (
<li className="md:hidden">
<Link
href={href}
className="block py-1 text-sm text-zinc-600 transition hover:text-zinc-900 dark:text-zinc-400 dark:hover:text-white"
>
{children}
</Link>
</li>
)
}
export function NavLink({
href,
tag,
active,
isAnchorLink = false,
children,
links,
isChildren = false,
}) {
let router = useRouter()
return (
<div className={'relative'}>
<Link
href={href ? href : '#'}
data-nb-link={active ? 1 : 0}
aria-current={active ? 'page' : undefined}
title={children}
className={clsx(
'flex justify-between gap-2 py-1 pr-3 text-sm transition',
isAnchorLink ? 'pl-7' : 'pl-4',
active
? 'text-zinc-900 dark:text-white'
: 'text-zinc-600 hover:text-zinc-900 dark:text-zinc-400 dark:hover:text-white',
isChildren ? 'pl-7' : 'pl-4'
)}
>
<span className="truncate">{children}</span>
{tag && (
<Tag variant="small" color="zinc">
{tag}
</Tag>
)}
</Link>
{links && (
<ul role="list">
{links.map((link, index) => (
<motion.li key={index} className="relative">
<NavLink
href={link.href}
active={link.href === router.pathname}
isChildren={true}
>
{link.title}
</NavLink>
</motion.li>
))}
</ul>
)}
</div>
)
}
export function flattenNavItems(links, onlyLinks = false) {
let output = []
for (let link of links) {
output.push(link)
if (link.links) output.push(...flattenNavItems(link.links, onlyLinks))
}
if (onlyLinks) output = output.filter((link) => link.href)
return output
}
export function VisibleSectionHighlight() {
const router = useRouter()
let height = remToPx(2)
let offset = remToPx(0)
const [activeIndex] = useNavigationState()
const [top, setTop] = useState(0)
useEffect(() => {
setTop(offset + activeIndex * height)
}, [activeIndex, router.pathname])
return (
activeIndex >= 0 && (
<motion.div
// layout
initial={{ opacity: 0 }}
animate={{ opacity: 1, transition: { delay: 0.2 } }}
exit={{ opacity: 0 }}
className="absolute inset-x-0 top-0 bg-zinc-800/2.5 will-change-transform dark:bg-white/2.5"
style={{ borderRadius: 8, height, top }}
/>
)
)
}
export function ActivePageMarker() {
const router = useRouter()
let itemHeight = remToPx(2)
let offset = remToPx(0.25)
const [activeIndex] = useNavigationState()
const [top, setTop] = useState(0)
useEffect(() => {
setTop(offset + activeIndex * itemHeight)
}, [activeIndex, router.pathname])
return (
activeIndex >= 0 && (
<motion.div
// layout
className="absolute left-2 h-6 w-px bg-orange-500"
initial={{ opacity: 0 }}
animate={{ opacity: 1, transition: { delay: 0.2 } }}
exit={{ opacity: 0 }}
style={{ top }}
/>
)
)
}
function NavigationGroup({ group, className, tableOfContents }) {
let router = useRouter()
let isActiveGroup =
group.links.findIndex(
(link) => link.href === router.pathname.replace('ipa', 'api')
) !== -1
return (
<li className={clsx('relative mt-6', className)}>
<motion.h2
// layout="position"
data-nb-link={group.title}
className="text-xs font-semibold text-zinc-900 dark:text-white"
>
{group.title}
</motion.h2>
<div className="relative mt-3 pl-2">
<AnimatePresence>
{isActiveGroup && (
<VisibleSectionHighlight
group={group}
pathname={router.pathname.replace('ipa', 'api')}
/>
)}
</AnimatePresence>
<motion.div
// layout
className="absolute inset-y-0 left-2 w-px bg-zinc-900/10 dark:bg-white/5"
/>
<AnimatePresence initial={false}>
{isActiveGroup && (
<ActivePageMarker
group={group}
pathname={router.pathname.replace('ipa', 'api')}
/>
)}
</AnimatePresence>
<ul role="list" className="border-l border-transparent">
{group.links.map((link) => (
<motion.li key={link.href} className="relative">
<NavLink
href={link.href}
active={link.href === router.pathname.replace('ipa', 'api')}
>
{link.title}
</NavLink>
<AnimatePresence mode="popLayout" initial={false}>
{link.href === router.pathname.replace('ipa', 'api') && (
<motion.ul
role="list"
initial={{ opacity: 0 }}
animate={{
opacity: 1,
transition: { delay: 0.1 },
}}
exit={{
opacity: 0,
transition: { duration: 0.15 },
}}
>
{router.route.startsWith('/ipa/resources') &&
tableOfContents?.map((section) => (
<li key={section.id}>
<NavLink
href={`${link.href}#${section.id}`}
tag={section.tag}
isAnchorLink
>
{section.title}
</NavLink>
</li>
))}
</motion.ul>
)}
</AnimatePresence>
</motion.li>
))}
</ul>
</div>
</li>
)
}