mirror of
https://ghproxy.net/https://github.com/elementor/one-click-accessibility.git
synced 2026-07-21 12:16:59 +08:00
* add: preview images for bulk-alt-text * add: bulk alt text banner * fix: padding * add: bulk alt text banner component * add: icons * add: support for aborting the fetch request * add: bulk alt text manager * update: husky * fix: optimized images * update: memoize images * fix: imports * add: focustrap * add: mixpanel events * update: add logic to save alt text when editing manually * fix: abort controller reference and cleanup * fix: improve key stability in image grid rendering * refactor: add PropTypes validation and memoization to ImageCard component * feat: add error handling for ImageCard component using ErrorBoundary * fix: auto selection logic for card with bulk generation * add: loading and generation states * refactor: restructure bulk alt text components and enhance progress handling and decentralized logic * refactor: extract logic from progress bar to hook * add: quota exceeded alert * add: promotional banner for generate button * update: Generate button for selection mode * fix: button alignment * update: hide banner for 2 or less images * fix: box shadow * add: mixpanel events * update: rename variable * add: bulk upgrade url * update: link handling for upgrade * fix: box shadow * add: border radius to dialog * update: improved accessibility notifications * fix: height and padding for banner * update: add more context to image card * add: ARIA labels * add: focus on card * add: decode URI component * fix: accessibility issues * add: encoding for file names * fix: styled components * update: made progress bar sticky * update: add logic to disable button on bulk generation * fix: style * fix: closing the dialog while generating * add: error handling * fix: mark prop as not required * Fix: Prevent MUI from adding aria-hidden to dialog parent elements [APP-2261] * add: error handling for quota api error * fix: prop requirement * add: close handler to dialog * fix: ui * fix: icons * fix: width of dialog * fix: width of bulk dialog --------- Co-authored-by: Kniazevych <pavlok@elementor.red>
248 lines
6.2 KiB
JavaScript
248 lines
6.2 KiB
JavaScript
import { mixpanelEvents } from '@ea11y-apps/global/services/mixpanel/mixpanel-events';
|
|
import { mixpanelService } from '@ea11y-apps/global/services/mixpanel/mixpanel-service';
|
|
import { useBulkGeneration } from '@ea11y-apps/scanner/context/bulk-generation-context';
|
|
import { useScannerWizardContext } from '@ea11y-apps/scanner/context/scanner-wizard-context';
|
|
import { speak } from '@wordpress/a11y';
|
|
import { useEffect, useMemo } from '@wordpress/element';
|
|
import { __, sprintf } from '@wordpress/i18n';
|
|
|
|
export const useProgressBarLogic = (onGeneratingChange) => {
|
|
const { sortedViolations, altTextData, setAltTextData, isManage } =
|
|
useScannerWizardContext();
|
|
const {
|
|
isGenerating,
|
|
progress,
|
|
startBulkGeneration,
|
|
stopBulkGeneration,
|
|
resetProgress,
|
|
} = useBulkGeneration();
|
|
|
|
const altTextViolations = sortedViolations.altText;
|
|
const type = isManage ? 'manage' : 'main';
|
|
const totalImages = altTextViolations.length;
|
|
|
|
const handleStopGenerating = () => {
|
|
mixpanelService.sendEvent(mixpanelEvents.stopButtonClicked);
|
|
stopBulkGeneration();
|
|
speak(__('Generation stopped', 'pojo-accessibility'), 'assertive');
|
|
};
|
|
|
|
useEffect(() => {
|
|
if (onGeneratingChange) {
|
|
onGeneratingChange(isGenerating, handleStopGenerating);
|
|
}
|
|
}, [isGenerating, onGeneratingChange]);
|
|
|
|
useEffect(() => {
|
|
return () => {
|
|
resetProgress();
|
|
};
|
|
}, [resetProgress]);
|
|
|
|
const {
|
|
manuallySelectedCount,
|
|
completedSelectedCount,
|
|
areAllMarkedAsDecorative,
|
|
} = useMemo(() => {
|
|
let manuallySelected = 0;
|
|
let completedSelected = 0;
|
|
let allDecorative = true;
|
|
|
|
altTextViolations.forEach((item, index) => {
|
|
const itemData = altTextData?.[type]?.[index];
|
|
const isSelected = itemData?.selected === true;
|
|
const isDecorative = itemData?.makeDecorative === true;
|
|
const hasValidAlt = itemData?.hasValidAltText === true;
|
|
|
|
if (isSelected && !hasValidAlt) {
|
|
manuallySelected++;
|
|
}
|
|
|
|
if (isSelected && hasValidAlt) {
|
|
completedSelected++;
|
|
}
|
|
|
|
if (!isDecorative) {
|
|
allDecorative = false;
|
|
}
|
|
});
|
|
|
|
return {
|
|
manuallySelectedCount: manuallySelected,
|
|
completedSelectedCount: completedSelected,
|
|
areAllMarkedAsDecorative: allDecorative,
|
|
};
|
|
}, [altTextViolations, altTextData, type]);
|
|
|
|
const showManualSelectionMode = manuallySelectedCount > 0;
|
|
|
|
const handleClearSelection = () => {
|
|
const updatedData = [...(altTextData?.[type] || [])];
|
|
|
|
altTextViolations.forEach((item, index) => {
|
|
if (
|
|
altTextData?.[type]?.[index]?.selected &&
|
|
!altTextData?.[type]?.[index]?.hasValidAltText
|
|
) {
|
|
updatedData[index] = {
|
|
...(updatedData[index] || {}),
|
|
selected: false,
|
|
};
|
|
}
|
|
});
|
|
|
|
setAltTextData({
|
|
...altTextData,
|
|
[type]: updatedData,
|
|
});
|
|
speak(__('Selection cleared', 'pojo-accessibility'), 'polite');
|
|
};
|
|
|
|
const handleMarkSelectedAsDecorative = () => {
|
|
const updatedData = [...(altTextData?.[type] || [])];
|
|
let count = 0;
|
|
|
|
altTextViolations.forEach((item, index) => {
|
|
if (
|
|
altTextData?.[type]?.[index]?.selected &&
|
|
!altTextData?.[type]?.[index]?.hasValidAltText
|
|
) {
|
|
updatedData[index] = {
|
|
...(updatedData[index] || {}),
|
|
makeDecorative: true,
|
|
hasValidAltText: true,
|
|
isDraft: false,
|
|
altText: '',
|
|
apiId: null,
|
|
resolved: false,
|
|
};
|
|
count++;
|
|
}
|
|
});
|
|
|
|
setAltTextData({
|
|
...altTextData,
|
|
[type]: updatedData,
|
|
});
|
|
|
|
const message = sprintf(
|
|
// Translators: %d number of images marked as decorative
|
|
__('%d images marked as decorative', 'pojo-accessibility'),
|
|
count,
|
|
);
|
|
speak(message, 'polite');
|
|
};
|
|
|
|
const handleToggleAllDecorative = () => {
|
|
const updatedData = [...(altTextData?.[type] || [])];
|
|
const isMarking = !areAllMarkedAsDecorative;
|
|
|
|
altTextViolations.forEach((item, index) => {
|
|
if (isMarking) {
|
|
updatedData[index] = {
|
|
...(updatedData[index] || {}),
|
|
makeDecorative: true,
|
|
selected: true,
|
|
hasValidAltText: true,
|
|
apiId: null,
|
|
resolved: false,
|
|
};
|
|
} else {
|
|
const currentAltText = updatedData[index]?.altText?.trim();
|
|
const hasAltText = !!currentAltText;
|
|
|
|
updatedData[index] = {
|
|
...(updatedData[index] || {}),
|
|
makeDecorative: false,
|
|
selected: hasAltText,
|
|
hasValidAltText: hasAltText,
|
|
apiId: null,
|
|
resolved: false,
|
|
};
|
|
}
|
|
});
|
|
|
|
setAltTextData({
|
|
...altTextData,
|
|
[type]: updatedData,
|
|
});
|
|
|
|
const message = isMarking
|
|
? sprintf(
|
|
// Translators: %d number of images
|
|
__('All %d images marked as decorative', 'pojo-accessibility'),
|
|
totalImages,
|
|
)
|
|
: __('All images unmarked as decorative', 'pojo-accessibility');
|
|
speak(message, 'polite');
|
|
};
|
|
|
|
const handleGenerateAll = () => {
|
|
const hasManuallySelectedItems = altTextViolations.some(
|
|
(item, index) =>
|
|
altTextData?.[type]?.[index]?.selected === true &&
|
|
!altTextData?.[type]?.[index]?.hasValidAltText,
|
|
);
|
|
|
|
const cardIndicesToProcess = [];
|
|
altTextViolations.forEach((item, index) => {
|
|
const itemData = altTextData?.[type]?.[index];
|
|
const isMarkedDecorative = itemData?.makeDecorative;
|
|
const hasValidAlt = itemData?.hasValidAltText;
|
|
|
|
if (isMarkedDecorative || hasValidAlt) {
|
|
return;
|
|
}
|
|
|
|
const shouldInclude = hasManuallySelectedItems
|
|
? itemData?.selected === true
|
|
: true;
|
|
if (shouldInclude) {
|
|
cardIndicesToProcess.push(index);
|
|
}
|
|
});
|
|
|
|
const message = sprintf(
|
|
// Translators: %d number of images to generate
|
|
__('Generating alt text for %d images', 'pojo-accessibility'),
|
|
cardIndicesToProcess.length,
|
|
);
|
|
speak(message, 'polite');
|
|
startBulkGeneration(cardIndicesToProcess);
|
|
};
|
|
|
|
const getGenerateButtonText = () => {
|
|
if (isGenerating) {
|
|
return __('Generating…', 'pojo-accessibility');
|
|
}
|
|
if (manuallySelectedCount > 0) {
|
|
return sprintf(
|
|
// Translators: %d number of images to generate
|
|
__('Generate (%d)', 'pojo-accessibility'),
|
|
manuallySelectedCount,
|
|
);
|
|
}
|
|
return __('Generate all', 'pojo-accessibility');
|
|
};
|
|
|
|
return {
|
|
// State
|
|
isGenerating,
|
|
progress,
|
|
showManualSelectionMode,
|
|
manuallySelectedCount,
|
|
completedSelectedCount,
|
|
totalImages,
|
|
areAllMarkedAsDecorative,
|
|
|
|
// Handlers
|
|
handleStopGenerating,
|
|
handleClearSelection,
|
|
handleMarkSelectedAsDecorative,
|
|
handleToggleAllDecorative,
|
|
handleGenerateAll,
|
|
|
|
// Computed values
|
|
generateButtonText: getGenerateButtonText(),
|
|
};
|
|
};
|