1
0
Fork 0

Migrate Traefik Proxy dashboard UI to React

This commit is contained in:
Gina A. 2025-05-28 11:26:04 +02:00 committed by GitHub
parent 4790e4910f
commit f16fff577a
No known key found for this signature in database
GPG key ID: B5690EEEBB952194
324 changed files with 28303 additions and 19567 deletions

View file

@ -0,0 +1,13 @@
import { Flex, styled } from '@traefiklabs/faency'
import breakpoints from 'utils/breakpoints'
export default styled(Flex, {
flexGrow: 1,
margin: '0 24px',
[`@media (min-width: ${breakpoints.laptopL})`]: {
maxWidth: `calc(${breakpoints.laptopL} - 96px)`,
margin: '0 auto',
},
})

View file

@ -0,0 +1,9 @@
import { Flex, Text } from '@traefiklabs/faency'
import { FiAlertTriangle } from 'react-icons/fi'
export const EmptyPlaceholder = ({ message = 'No data available' }: { message?: string }) => (
<Flex align="center" justify="center" css={{ py: '$5', color: '$primary' }}>
<FiAlertTriangle size={16} />
<Text css={{ pl: '$2' }}>{message}</Text>
</Flex>
)

View file

@ -0,0 +1,20 @@
import { Box, Button, Text } from '@traefiklabs/faency'
import { FallbackProps } from 'react-error-boundary'
const ErrorFallback = ({ error, resetErrorBoundary }: FallbackProps) => {
return (
<Box role="alert">
<Box css={{ mb: '$2' }}>
<Text as="p">Something went wrong:</Text>
</Box>
<Box css={{ mb: '$2' }}>
<Text variant="red">{error.message}</Text>
</Box>
<Button type="button" onClick={resetErrorBoundary}>
Try again
</Button>
</Box>
)
}
export default ErrorFallback

View file

@ -0,0 +1,26 @@
import { ComponentType, ReactNode, Suspense } from 'react'
import { ErrorBoundary, FallbackProps } from 'react-error-boundary'
import ErrorFallback from './ErrorFallback'
type SuspenseWrapperProps = {
suspenseFallback?: ReactNode
errorFallback?: ComponentType<FallbackProps>
silentFail?: boolean
children?: ReactNode
}
const ErrorSuspenseWrapper = ({
errorFallback = ErrorFallback,
suspenseFallback = null,
silentFail = false,
children,
}: SuspenseWrapperProps) => {
return (
<ErrorBoundary FallbackComponent={silentFail ? () => null : errorFallback}>
<Suspense fallback={suspenseFallback}>{children}</Suspense>
</ErrorBoundary>
)
}
export default ErrorSuspenseWrapper

View file

@ -0,0 +1,21 @@
import { SideNav, TopNav } from './Navigation'
import { renderWithProviders } from 'utils/test'
describe('Navigation', () => {
it('should render the side navigation bar', async () => {
const { container } = renderWithProviders(<SideNav isExpanded={false} onSidePanelToggle={() => {}} />)
expect(container.innerHTML).toContain('HTTP')
expect(container.innerHTML).toContain('TCP')
expect(container.innerHTML).toContain('UDP')
expect(container.innerHTML).toContain('Plugins')
})
it('should render the top navigation bar', async () => {
const { container } = renderWithProviders(<TopNav />)
expect(container.innerHTML).toContain('theme-switcher')
expect(container.innerHTML).toContain('help-menu')
})
})

View file

@ -0,0 +1,357 @@
import {
Badge,
Box,
Button,
DialogTitle,
DropdownMenu,
DropdownMenuContent,
DropdownMenuGroup,
DropdownMenuItem,
DropdownMenuPortal,
DropdownMenuTrigger,
elevationVariants,
Flex,
Link,
NavigationLink,
SidePanel,
styled,
Text,
Tooltip,
VisuallyHidden,
} from '@traefiklabs/faency'
import { useEffect, useMemo, useState } from 'react'
import { BsChevronDoubleRight, BsChevronDoubleLeft } from 'react-icons/bs'
import { FiBookOpen, FiGithub, FiHelpCircle } from 'react-icons/fi'
import { matchPath, useHref } from 'react-router'
import { useLocation } from 'react-router-dom'
import { useWindowSize } from 'usehooks-ts'
import Container from './Container'
import { DARK_PRIMARY_COLOR, LIGHT_PRIMARY_COLOR } from './Page'
import IconButton from 'components/buttons/IconButton'
import Logo from 'components/icons/Logo'
import { PluginsIcon } from 'components/icons/PluginsIcon'
import ThemeSwitcher from 'components/ThemeSwitcher'
import TooltipText from 'components/TooltipText'
import useTotals from 'hooks/use-overview-totals'
import { useIsDarkMode } from 'hooks/use-theme'
import useVersion from 'hooks/use-version'
import { Route, ROUTES } from 'routes'
export const LAPTOP_BP = 1025
const NavigationDrawer = styled(Flex, {
width: '100%',
maxWidth: '100%',
height: 64,
p: 0,
variants: {
elevation: elevationVariants,
},
defaultVariants: {
elevation: 1,
},
})
const BasicNavigationItem = ({
route,
count,
isSmallScreen,
isExpanded,
}: {
route: Route
count?: number
isSmallScreen: boolean
isExpanded: boolean
}) => {
const { pathname } = useLocation()
const href = useHref(route.path)
const isActiveRoute = useMemo(() => {
const mainPath = matchPath(route.path, pathname)
if (mainPath) return true
if (route.activeMatches) {
return route.activeMatches.some((path) => matchPath(path, pathname))
}
}, [pathname, route.activeMatches, route.path])
if (isSmallScreen && !isExpanded) {
return (
<Tooltip content={<Text css={{ color: '$tooltipText' }}>{route.label}</Text>} side="right">
<Box>
<NavigationLink active={isActiveRoute} startAdornment={route?.icon} href={href} />
</Box>
</Tooltip>
)
}
return (
<NavigationLink active={isActiveRoute} startAdornment={route?.icon} css={{ whiteSpace: 'nowrap' }} href={href}>
{route.label}
{!!count && (
<Badge variant={isActiveRoute ? 'green' : undefined} css={{ ml: '$2' }}>
{count}
</Badge>
)}
</NavigationLink>
)
}
export const SideBarPanel = ({
isOpen,
onOpenChange,
}: {
isOpen: boolean
onOpenChange: (isOpen: boolean) => void
}) => {
const windowSize = useWindowSize()
return (
<SidePanel
open={isOpen && windowSize.width < LAPTOP_BP}
onOpenChange={onOpenChange}
side="left"
css={{ width: 264, p: 0 }}
description="Expanded side navigation"
noCloseIcon
>
<VisuallyHidden>
<DialogTitle>side navigation</DialogTitle>
</VisuallyHidden>
<SideNav isExpanded={isOpen} onSidePanelToggle={() => onOpenChange(false)} />
</SidePanel>
)
}
export const SideNav = ({
isExpanded,
onSidePanelToggle,
isResponsive = false,
}: {
isExpanded: boolean
onSidePanelToggle: () => void
isResponsive?: boolean
}) => {
const windowSize = useWindowSize()
const { version } = useVersion()
const { http, tcp, udp } = useTotals()
const [isSmallScreen, setIsSmallScreen] = useState(false)
useEffect(() => {
setIsSmallScreen(isResponsive && windowSize.width < LAPTOP_BP)
}, [isExpanded, isResponsive, windowSize.width])
const totalValueByPath = useMemo<{ [key: string]: number }>(
() => ({
'/http/routers': http?.routers,
'/http/services': http?.services,
'/http/middlewares': http?.middlewares as number,
'/tcp/routers': tcp?.routers,
'/tcp/services': tcp?.services,
'/tcp/middlewares': tcp?.middlewares as number,
'/udp/routers': udp?.routers,
'/udp/services': udp?.services,
}),
[http, tcp, udp],
)
return (
<NavigationDrawer
data-collapsed={isExpanded && isResponsive && isSmallScreen}
css={{
width: 264,
height: '100vh',
position: 'fixed',
[`@media (max-width:${LAPTOP_BP}px)`]: isResponsive
? {
width: 64,
'a > div:nth-child(1)': {
marginLeft: 0,
paddingRight: 0,
},
}
: undefined,
transition: '150ms cubic-bezier(0.22, 1, 0.36, 1)',
'&[data-collapsed="true"]': {
marginLeft: -32,
},
}}
>
<IconButton
ghost
icon={isExpanded ? <BsChevronDoubleLeft size={16} /> : <BsChevronDoubleRight size={16} />}
onClick={onSidePanelToggle}
css={{
display: 'none',
position: 'absolute',
top: 3,
right: isExpanded ? 12 : 4,
color: '$hiContrast',
[`@media (max-width:${LAPTOP_BP}px)`]: { display: 'inherit' },
p: '$1',
'&:before, &:after': { borderRadius: '10px' },
height: 16,
}}
/>
<Container
css={{
overflow: 'auto',
p: '$3',
m: 0,
flexDirection: 'column',
[`@media (max-width:${LAPTOP_BP}px)`]: isResponsive ? { p: '$2' } : undefined,
}}
data-testid="nav-container"
>
<Flex
as="a"
gap={2}
css={{
color: '$primary',
mt: '$3',
mb: '$6',
textDecoration: 'none',
height: 'fit-content',
pl: '$3',
[`@media (max-width:${LAPTOP_BP}px)`]: isResponsive
? { mt: '$4', px: 0, justifyContent: 'center' }
: undefined,
}}
href="https://github.com/traefik/traefik/"
target="_blank"
data-testid="proxy-main-nav"
>
<Logo height={isSmallScreen ? 36 : 56} isSmallScreen={isSmallScreen} />
{!!version && !isSmallScreen && (
<TooltipText text={version.Version} css={{ maxWidth: 50, fontWeight: '$semiBold' }} isTruncated />
)}
</Flex>
{ROUTES.map((section, index) => (
<Flex
key={`nav-section-${index}`}
direction="column"
gap="1"
css={{
'&:not(:last-child)': {
borderTop: section.sectionLabel ? '1px solid $colors$tableRowBorder' : undefined,
mb: '$3',
pt: section.sectionLabel ? '$3' : undefined,
},
}}
>
{section.sectionLabel && (
<Text
css={{
fontWeight: 600,
color: '$grayBlue9',
mb: '$2',
textTransform: 'uppercase',
letterSpacing: 0.2,
ml: 15,
[`@media (max-width:${LAPTOP_BP}px)`]: isResponsive ? { display: 'none' } : undefined,
}}
>
{section.sectionLabel}
</Text>
)}
{section.items.map((item, idx) => (
<BasicNavigationItem
key={`nav-section-${index}-${idx}`}
route={item}
count={totalValueByPath[item.path]}
isSmallScreen={isSmallScreen}
isExpanded={isExpanded}
/>
))}
</Flex>
))}
<Flex direction="column" css={{ borderTop: '1px solid $colors$tableRowBorder', borderRadius: 0, pt: '$3' }}>
<NavigationLink
startAdornment={<PluginsIcon />}
css={{
mt: '$3',
whiteSpace: 'nowrap',
}}
href="https://plugins.traefik.io/"
target="_blank"
>
{!isSmallScreen || isExpanded ? 'Plugins' : ''}
</NavigationLink>
</Flex>
</Container>
</NavigationDrawer>
)
}
export const TopNav = () => {
const { showHubButton, version } = useVersion()
const isDarkMode = useIsDarkMode()
const parsedVersion = useMemo(() => {
if (!version?.Version) {
return 'master'
}
if (version.Version === 'dev') {
return 'master'
}
const matches = version.Version.match(/^(v?\d+\.\d+)/)
return matches ? 'v' + matches[1] : 'master'
}, [version])
return (
<Flex as="nav" role="navigation" justify="end" align="center" css={{ gap: '$2', mb: '$6' }}>
{showHubButton && (
<Box css={{ fontFamily: '$rubik', fontWeight: '500 !important' }}>
<hub-button-app
key={`dark-mode-${isDarkMode}`}
style={{ backgroundColor: isDarkMode ? DARK_PRIMARY_COLOR : LIGHT_PRIMARY_COLOR, fontWeight: 'inherit' }}
/>
</Box>
)}
<ThemeSwitcher />
<DropdownMenu>
<DropdownMenuTrigger asChild>
<Button ghost variant="secondary" css={{ px: '$2', boxShadow: 'none' }} data-testid="help-menu">
<FiHelpCircle size={20} />
</Button>
</DropdownMenuTrigger>
<DropdownMenuPortal>
<DropdownMenuContent align="end" css={{ zIndex: 9999 }}>
<DropdownMenuGroup>
<DropdownMenuItem css={{ height: '$6', cursor: 'pointer' }}>
<Link
href={`https://doc.traefik.io/traefik/${parsedVersion}`}
target="_blank"
css={{ textDecoration: 'none', '&:hover': { textDecoration: 'none' } }}
>
<Flex align="center" gap={2}>
<FiBookOpen size={20} />
<Text>Documentation</Text>
</Flex>
</Link>
</DropdownMenuItem>
<DropdownMenuItem css={{ height: '$6', cursor: 'pointer' }}>
<Link
href="https://github.com/traefik/traefik/"
target="_blank"
css={{ textDecoration: 'none', '&:hover': { textDecoration: 'none' } }}
>
<Flex align="center" gap={2}>
<FiGithub size={20} />
<Text>Github Repository</Text>
</Flex>
</Link>
</DropdownMenuItem>
</DropdownMenuGroup>
</DropdownMenuContent>
</DropdownMenuPortal>
</DropdownMenu>
</Flex>
)
}

View file

@ -0,0 +1,10 @@
import Page from './Page'
import { renderWithProviders } from 'utils/test'
describe('<Page />', () => {
it('should render an empty page', () => {
const { getByTestId } = renderWithProviders(<Page title="Test" />)
expect(getByTestId('Test page')).toBeInTheDocument()
})
})

70
webui/src/layout/Page.tsx Normal file
View file

@ -0,0 +1,70 @@
import { Flex, globalCss, styled } from '@traefiklabs/faency'
import { ReactNode, useState } from 'react'
import { Helmet } from 'react-helmet-async'
import Container from './Container'
import { LAPTOP_BP, SideBarPanel, SideNav, TopNav } from './Navigation'
import { ToastPool } from 'components/ToastPool'
import { ToastProvider } from 'contexts/toasts'
export const LIGHT_PRIMARY_COLOR = '#217F97'
export const DARK_PRIMARY_COLOR = '#2AA2C1'
export const globalStyles = globalCss({
'.light': {
'--colors-primary': LIGHT_PRIMARY_COLOR,
},
'.dark': {
'--colors-primary': DARK_PRIMARY_COLOR,
},
body: {
backgroundColor: '$contentBg',
m: 0,
},
})
const PageContainer = styled(Container, {
py: '$5',
px: '$5',
m: 0,
'@media (max-width:1440px)': {
maxWidth: '100%',
},
})
export interface Props {
title?: string
children?: ReactNode
}
const Page = ({ children, title }: Props) => {
const [isSideBarPanelOpen, setIsSideBarPanelOpen] = useState(false)
return (
<ToastProvider>
{globalStyles()}
<Helmet>
<title>{title ? `${title} - ` : ''}Traefik Proxy</title>
</Helmet>
<Flex>
<SideBarPanel isOpen={isSideBarPanelOpen} onOpenChange={setIsSideBarPanelOpen} />
<SideNav isExpanded={isSideBarPanelOpen} onSidePanelToggle={() => setIsSideBarPanelOpen(true)} isResponsive />
<Flex
justify="center"
css={{ flex: 1, margin: 'auto', ml: 264, [`@media (max-width:${LAPTOP_BP}px)`]: { ml: 60 } }}
>
<PageContainer data-testid={`${title} page`} direction="column">
<TopNav />
{children}
</PageContainer>
</Flex>
</Flex>
<ToastPool />
</ToastProvider>
)
}
export default Page