mirror of
https://github.com/Stirling-Tools/Stirling-PDF.git
synced 2025-08-22 12:19:24 +00:00

# Description of Changes - added tooltips to ocr and compress - added the tooltip component which can be used either directly, or through the toolstep component --- ## Checklist ### General - [ ] I have read the [Contribution Guidelines](https://github.com/Stirling-Tools/Stirling-PDF/blob/main/CONTRIBUTING.md) - [ ] I have read the [Stirling-PDF Developer Guide](https://github.com/Stirling-Tools/Stirling-PDF/blob/main/devGuide/DeveloperGuide.md) (if applicable) - [ ] I have read the [How to add new languages to Stirling-PDF](https://github.com/Stirling-Tools/Stirling-PDF/blob/main/devGuide/HowToAddNewLanguage.md) (if applicable) - [ ] I have performed a self-review of my own code - [ ] My changes generate no new warnings ### Documentation - [ ] I have updated relevant docs on [Stirling-PDF's doc repo](https://github.com/Stirling-Tools/Stirling-Tools.github.io/blob/main/docs/) (if functionality has heavily changed) - [ ] I have read the section [Add New Translation Tags](https://github.com/Stirling-Tools/Stirling-PDF/blob/main/devGuide/HowToAddNewLanguage.md#add-new-translation-tags) (for new translation tags only) ### UI Changes (if applicable) - [ ] Screenshots or videos demonstrating the UI changes are attached (e.g., as comments or direct attachments in the PR) ### Testing (if applicable) - [ ] I have tested my changes locally. Refer to the [Testing Guide](https://github.com/Stirling-Tools/Stirling-PDF/blob/main/devGuide/DeveloperGuide.md#6-testing) for more details.
195 lines
4.8 KiB
TypeScript
195 lines
4.8 KiB
TypeScript
import React, { createContext, useContext, useMemo, useRef } from 'react';
|
|
import { Paper, Text, Stack, Box, Flex } from '@mantine/core';
|
|
import ExpandMoreIcon from '@mui/icons-material/ExpandMore';
|
|
import ChevronRightIcon from '@mui/icons-material/ChevronRight';
|
|
import { Tooltip } from '../../shared/Tooltip';
|
|
import { TooltipTip } from '../../shared/tooltip/TooltipContent';
|
|
|
|
interface ToolStepContextType {
|
|
visibleStepCount: number;
|
|
getStepNumber: () => number;
|
|
}
|
|
|
|
const ToolStepContext = createContext<ToolStepContextType | null>(null);
|
|
|
|
export interface ToolStepProps {
|
|
title: string;
|
|
isVisible?: boolean;
|
|
isCollapsed?: boolean;
|
|
isCompleted?: boolean;
|
|
onCollapsedClick?: () => void;
|
|
children?: React.ReactNode;
|
|
completedMessage?: string;
|
|
helpText?: string;
|
|
showNumber?: boolean;
|
|
tooltip?: {
|
|
content?: React.ReactNode;
|
|
tips?: TooltipTip[];
|
|
header?: {
|
|
title: string;
|
|
logo?: React.ReactNode;
|
|
};
|
|
};
|
|
}
|
|
|
|
const renderTooltipTitle = (
|
|
title: string,
|
|
tooltip: ToolStepProps['tooltip'],
|
|
isCollapsed: boolean
|
|
) => {
|
|
if (tooltip && !isCollapsed) {
|
|
return (
|
|
<Tooltip
|
|
content={tooltip.content}
|
|
tips={tooltip.tips}
|
|
header={tooltip.header}
|
|
sidebarTooltip={true}
|
|
>
|
|
<Flex align="center" gap="xs" onClick={(e) => e.stopPropagation()}>
|
|
<Text fw={500} size="lg">
|
|
{title}
|
|
</Text>
|
|
<span className="material-symbols-rounded" style={{ fontSize: '1.2rem', color: 'var(--icon-files-color)' }}>
|
|
gpp_maybe
|
|
</span>
|
|
</Flex>
|
|
</Tooltip>
|
|
);
|
|
}
|
|
|
|
return (
|
|
<Text fw={500} size="lg">
|
|
{title}
|
|
</Text>
|
|
);
|
|
};
|
|
|
|
const ToolStep = ({
|
|
title,
|
|
isVisible = true,
|
|
isCollapsed = false,
|
|
isCompleted = false,
|
|
onCollapsedClick,
|
|
children,
|
|
completedMessage,
|
|
helpText,
|
|
showNumber,
|
|
tooltip
|
|
}: ToolStepProps) => {
|
|
if (!isVisible) return null;
|
|
|
|
const parent = useContext(ToolStepContext);
|
|
|
|
// Auto-detect if we should show numbers based on sibling count
|
|
const shouldShowNumber = useMemo(() => {
|
|
if (showNumber !== undefined) return showNumber;
|
|
return parent ? parent.visibleStepCount >= 3 : false;
|
|
}, [showNumber, parent]);
|
|
|
|
const stepNumber = parent?.getStepNumber?.() || 1;
|
|
|
|
return (
|
|
<Paper
|
|
p="md"
|
|
withBorder
|
|
style={{
|
|
opacity: isCollapsed ? 0.8 : 1,
|
|
transition: 'opacity 0.2s ease'
|
|
}}
|
|
>
|
|
{/* Chevron icon to collapse/expand the step */}
|
|
<Flex
|
|
align="center"
|
|
justify="space-between"
|
|
mb="sm"
|
|
style={{
|
|
cursor: onCollapsedClick ? 'pointer' : 'default'
|
|
}}
|
|
onClick={onCollapsedClick}
|
|
>
|
|
<Flex align="center" gap="sm">
|
|
{shouldShowNumber && (
|
|
<Text fw={500} size="lg" c="dimmed">
|
|
{stepNumber}
|
|
</Text>
|
|
)}
|
|
{renderTooltipTitle(title, tooltip, isCollapsed)}
|
|
</Flex>
|
|
|
|
{isCollapsed ? (
|
|
<ChevronRightIcon style={{
|
|
fontSize: '1.2rem',
|
|
color: 'var(--mantine-color-dimmed)',
|
|
opacity: onCollapsedClick ? 1 : 0.5
|
|
}} />
|
|
) : (
|
|
<ExpandMoreIcon style={{
|
|
fontSize: '1.2rem',
|
|
color: 'var(--mantine-color-dimmed)',
|
|
opacity: onCollapsedClick ? 1 : 0.5
|
|
}} />
|
|
)}
|
|
</Flex>
|
|
|
|
{isCollapsed ? (
|
|
<Box>
|
|
{isCompleted && completedMessage && (
|
|
<Text size="sm" c="green">
|
|
✓ {completedMessage}
|
|
{onCollapsedClick && (
|
|
<Text span c="dimmed" size="xs" ml="sm">
|
|
(click to change)
|
|
</Text>
|
|
)}
|
|
</Text>
|
|
)}
|
|
</Box>
|
|
) : (
|
|
<Stack gap="md">
|
|
{helpText && (
|
|
<Text size="sm" c="dimmed">
|
|
{helpText}
|
|
</Text>
|
|
)}
|
|
{children}
|
|
</Stack>
|
|
)}
|
|
</Paper>
|
|
);
|
|
}
|
|
|
|
export interface ToolStepContainerProps {
|
|
children: React.ReactNode;
|
|
}
|
|
|
|
export const ToolStepContainer = ({ children }: ToolStepContainerProps) => {
|
|
const stepCounterRef = useRef(0);
|
|
|
|
// Count visible ToolStep children
|
|
const visibleStepCount = useMemo(() => {
|
|
let count = 0;
|
|
React.Children.forEach(children, (child) => {
|
|
if (React.isValidElement(child) && child.type === ToolStep) {
|
|
const isVisible = (child.props as ToolStepProps).isVisible !== false;
|
|
if (isVisible) count++;
|
|
}
|
|
});
|
|
return count;
|
|
}, [children]);
|
|
|
|
const contextValue = useMemo(() => ({
|
|
visibleStepCount,
|
|
getStepNumber: () => ++stepCounterRef.current
|
|
}), [visibleStepCount]);
|
|
|
|
stepCounterRef.current = 0;
|
|
|
|
return (
|
|
<ToolStepContext.Provider value={contextValue}>
|
|
{children}
|
|
</ToolStepContext.Provider>
|
|
);
|
|
}
|
|
|
|
export default ToolStep;
|