Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

feat: add tooltips to lifecycle boxes #8739

Merged
merged 8 commits into from
Nov 13, 2024
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Original file line number Diff line number Diff line change
Expand Up @@ -5,12 +5,12 @@ export const lifecycleMessages: Record<
string
> = {
initial:
'Feature flags in the initial phase indicate you have created flags that is not detected in any environments which mean either integration issues or unused flags',
'Feature flags in the initial phase are flags that have not yet received metrics from any environments. This might mean that the flags have not been used yet, or it could indicate integration issues.',
preLive:
'In the pre-live phase the feature is being developed and tested in controlled environments. Once the feature is ready the flag can be enabled in production.',
live: 'The feature is being rolled out in production according to the decided strategy targeting user segments and/or using percentage rollout. ',
'In the pre-live phase, the feature is being developed and tested in controlled environments. Once the feature is ready, the flag can be enabled in production.',
live: 'The feature is being rolled out in production according to its assigned strategies (targeting user segments and/or using percentage rollout).',
completed:
'Flags that are in cleanup are potentially stale flags. View the flags to evaluate whether you should archive them in Unleash and clean up your codebase to reduce technical debt',
'Flags that are in the completed phase still receive metrics in production. Consider archiving them to clean up your codebase to reduce technical debt.',
archived:
'Flags that have been archived and are no longer in use, but kept for future reference.',
};
Original file line number Diff line number Diff line change
@@ -1,13 +1,15 @@
import { CardActionArea, styled } from '@mui/material';
import { styled } from '@mui/material';
import { FeatureLifecycleStageIcon } from 'component/feature/FeatureView/FeatureOverview/FeatureLifecycle/FeatureLifecycleStageIcon';
import { useProjectStatus } from 'hooks/api/getters/useProjectStatus/useProjectStatus';
import useLoading from 'hooks/useLoading';
import { useRequiredPathParam } from 'hooks/useRequiredPathParam';
import { useState, type FC } from 'react';
import type { FC } from 'react';
import { PrettifyLargeNumber } from 'component/common/PrettifyLargeNumber/PrettifyLargeNumber';
import type { ProjectStatusSchemaLifecycleSummary } from 'openapi';
import useUiConfig from 'hooks/api/getters/useUiConfig/useUiConfig';
import { HelpIcon } from 'component/common/HelpIcon/HelpIcon';
import { HtmlTooltip } from 'component/common/HtmlTooltip/HtmlTooltip';
import { lifecycleMessages } from './LifecycleMessages';
import InfoIcon from '@mui/icons-material/Info';

const LifecycleRow = styled('div')(({ theme }) => ({
display: 'flex',
Expand All @@ -33,32 +35,46 @@ const LifecycleBoxContent = styled('div')(({ theme }) => ({
transition: 'border-color 200ms',
borderRadius: theme.shape.borderRadiusExtraLarge,
border: `2px solid ${theme.palette.divider}`,
}));

const StyledCardActionArea = styled(CardActionArea)(({ theme }) => ({
borderRadius: theme.shape.borderRadiusExtraLarge,
'&[aria-pressed="true"] > *': {
'&:focus-visible': {
outline: 'none',
borderColor: theme.palette.primary.main,
},
}));

const LifecycleBoxTooltip: FC<{ text: string }> = ({ text }) => {
const Container = styled('span')(({ theme }) => ({
display: 'flex',
alignItems: 'flex-start',
gap: theme.spacing(1),
fontSize: theme.typography.body1.fontSize,
padding: theme.spacing(1),
}));
return (
<Container>
<InfoIcon fontSize='small' color='primary' />
<p>{text}</p>
</Container>
);
};

const LifecycleBox = ({
children,
isActive,
onClick,
tooltipText,
}: {
children: React.ReactNode;
isActive?: boolean;
onClick?: () => void;
tooltipText: string;
}) => {
return (
<li>
<StyledCardActionArea
onClick={onClick}
aria-pressed={isActive ? 'true' : 'false'}
<HtmlTooltip
arrow
maxWidth='850px'
title={<LifecycleBoxTooltip text={tooltipText} />}
>
<LifecycleBoxContent>{children}</LifecycleBoxContent>
</StyledCardActionArea>
<LifecycleBoxContent tabIndex={0}>
{children}
</LifecycleBoxContent>
</HtmlTooltip>
</li>
);
};
Expand Down Expand Up @@ -171,11 +187,7 @@ const LifecycleTooltip: FC = () => {
export const ProjectLifecycleSummary = () => {
const projectId = useRequiredPathParam('projectId');
const { data, loading } = useProjectStatus(projectId);
const { isEnterprise } = useUiConfig();

const [activeLifecycleStage, setActiveLifecycleStage] = useState<
keyof ProjectStatusSchemaLifecycleSummary | null
>(null);
const loadingRef = useLoading<HTMLUListElement>(
loading,
'[data-loading-project-lifecycle-summary=true]',
Expand All @@ -193,11 +205,9 @@ export const ProjectLifecycleSummary = () => {
<h4>Flag lifecycle</h4>
<LifecycleTooltip />
</HeaderRow>

<LifecycleList ref={loadingRef}>
<LifecycleBox
onClick={() => setActiveLifecycleStage('initial')}
isActive={activeLifecycleStage === 'initial'}
>
<LifecycleBox tooltipText={lifecycleMessages.initial}>
<p>
<Counter>
<BigNumber
Expand All @@ -217,10 +227,7 @@ export const ProjectLifecycleSummary = () => {
averageDays={data?.lifecycleSummary.initial.averageDays}
/>
</LifecycleBox>
<LifecycleBox
onClick={() => setActiveLifecycleStage('preLive')}
isActive={activeLifecycleStage === 'preLive'}
>
<LifecycleBox tooltipText={lifecycleMessages.preLive}>
<p>
<Counter>
<BigNumber
Expand All @@ -240,10 +247,7 @@ export const ProjectLifecycleSummary = () => {
averageDays={data?.lifecycleSummary.preLive.averageDays}
/>
</LifecycleBox>
<LifecycleBox
onClick={() => setActiveLifecycleStage('live')}
isActive={activeLifecycleStage === 'live'}
>
<LifecycleBox tooltipText={lifecycleMessages.live}>
<p>
<Counter>
<BigNumber
Expand All @@ -261,10 +265,7 @@ export const ProjectLifecycleSummary = () => {
averageDays={data?.lifecycleSummary.live.averageDays}
/>
</LifecycleBox>
<LifecycleBox
onClick={() => setActiveLifecycleStage('completed')}
isActive={activeLifecycleStage === 'completed'}
>
<LifecycleBox tooltipText={lifecycleMessages.completed}>
<p>
<Counter>
<BigNumber
Expand All @@ -287,10 +288,7 @@ export const ProjectLifecycleSummary = () => {
}
/>
</LifecycleBox>
<LifecycleBox
onClick={() => setActiveLifecycleStage('archived')}
isActive={activeLifecycleStage === 'archived'}
>
<LifecycleBox tooltipText={lifecycleMessages.archived}>
<p>
<Counter>
<BigNumber
Expand Down
Loading