Files
Homarr/src/components/Dashboard/Tiles/Apps/AppPing.tsx
Manuel f8bd7fb2b9 🚸 Improve accessibility (#980)
* 🚸 Improve accessibility

* 🌐 Add missing translations
2023-06-20 22:02:00 +02:00

122 lines
3.3 KiB
TypeScript

import { Box, Indicator, Tooltip } from '@mantine/core';
import { IconCheck, IconCheckbox, IconDownload, IconLoader, IconX } from '@tabler/icons-react';
import Consola from 'consola';
import { TargetAndTransition, Transition, motion } from 'framer-motion';
import { useTranslation } from 'next-i18next';
import { api } from '~/utils/api';
import { useConfigContext } from '../../../../config/provider';
import { AppType } from '../../../../types/app';
interface AppPingProps {
app: AppType;
}
export const AppPing = ({ app }: AppPingProps) => {
const { t } = useTranslation('modules/ping');
const { config } = useConfigContext();
const active =
(config?.settings.customization.layout.enabledPing && app.network.enabledStatusChecker) ??
false;
const { data, isLoading, isFetching, isSuccess } = api.app.ping.useQuery(app.id, {
retry: false,
enabled: active,
select: (data) => {
const isOk = getIsOk(app, data.status);
Consola.info(`Ping ${app.name} (${app.url}) ${data.status} ${isOk}`);
return {
status: data.status,
state: isOk ? ('online' as const) : ('down' as const),
statusText: data.statusText,
};
},
});
if (!active) return null;
const isOnline = data?.state === 'online';
const disablePulse = config?.settings.customization.accessibility?.disablePingPulse ?? false;
const replaceDotWithIcon =
config?.settings.customization.accessibility?.replacePingDotsWithIcons ?? false;
const scaleAnimation = isOnline ? [1, 0.7, 1] : 1;
const animate: TargetAndTransition | undefined = disablePulse
? undefined
: {
scale: scaleAnimation,
};
const transition: Transition | undefined = disablePulse
? undefined
: {
repeat: Infinity,
duration: 2.5,
ease: 'easeInOut',
};
return (
<motion.div
style={{
position: 'absolute',
bottom: replaceDotWithIcon ? 5 : 20,
right: replaceDotWithIcon ? 8 : 20,
zIndex: 2,
}}
animate={animate}
transition={transition}
>
<Tooltip
withinPortal
radius="lg"
label={
isLoading
? t('states.loading')
: data?.state === 'online'
? t('states.online', { response: data?.status ?? 'N/A' })
: `${data?.statusText} ${data?.status}`
}
>
{config?.settings.customization.accessibility?.replacePingDotsWithIcons ? (
<Box>
<AccessibleIndicatorPing isLoading={isLoading} isOnline={isOnline} />
</Box>
) : (
<Indicator
size={15}
color={isLoading ? 'yellow' : isOnline ? 'green' : 'red'}
children={null}
/>
)}
</Tooltip>
</motion.div>
);
};
const AccessibleIndicatorPing = ({
isLoading,
isOnline,
}: {
isOnline: boolean;
isLoading: boolean;
}) => {
if (isOnline) {
return <IconCheck color="green" />;
}
if (isLoading) {
return <IconLoader />;
}
return <IconX color="red" />;
};
export const getIsOk = (app: AppType, status: number) => {
if (app.network.okStatus === undefined || app.network.statusCodes.length >= 1) {
Consola.log('Using new status codes');
return app.network.statusCodes.includes(status.toString());
}
Consola.warn('Using deprecated okStatus');
return app.network.okStatus.includes(status);
};