Files
Verso/services/web/frontend/js/features/pdf-preview/components/pdf-synctex-controls.tsx
T
Malik GlossopandCopybot a293474c0c Merge pull request #31035 from overleaf/mg-context-menu-analytics
Add analytics event for context menu, comment, track changes, and jump to location

GitOrigin-RevId: 8412cc3c8039cd1582ccee20b162b4bef4467dea
2026-03-06 09:14:26 +00:00

193 lines
4.9 KiB
TypeScript

import classNames from 'classnames'
import { memo, useCallback, useMemo } from 'react'
import { useDetachCompileContext as useCompileContext } from '../../../shared/context/detach-compile-context'
import { useLayoutContext } from '../../../shared/context/layout-context'
import { useTranslation } from 'react-i18next'
import OLTooltip from '@/shared/components/ol/ol-tooltip'
import OLButton from '@/shared/components/ol/ol-button'
import MaterialIcon from '@/shared/components/material-icon'
import { Placement } from 'react-bootstrap/types'
import useSynctex from '../hooks/use-synctex'
import { useFeatureFlag } from '@/shared/context/split-test-context'
import OLSpinner from '@/shared/components/ol/ol-spinner'
import { sendMB } from '@/infrastructure/event-tracking'
const GoToCodeButton = memo(function GoToCodeButton({
syncToCode,
syncToCodeInFlight,
isDetachLayout,
}: {
syncToCode: ({ visualOffset }: { visualOffset: number }) => void
syncToCodeInFlight: boolean
isDetachLayout?: boolean
}) {
const { t } = useTranslation()
const buttonClasses = classNames('synctex-control', {
'detach-synctex-control': !!isDetachLayout,
})
let buttonIcon = null
if (syncToCodeInFlight) {
buttonIcon = <OLSpinner size="sm" />
} else if (!isDetachLayout) {
buttonIcon = (
<MaterialIcon type="arrow_left_alt" className="synctex-control-icon" />
)
}
const syncToCodeWithButton = useCallback(() => {
sendMB('jump-to-location', {
method: 'arrow',
direction: 'pdf-location-in-code',
})
syncToCode({ visualOffset: 72 })
}, [syncToCode])
const overlayProps = useMemo(
() => ({
placement: (isDetachLayout ? 'bottom' : 'right') as Placement,
}),
[isDetachLayout]
)
return (
<OLTooltip
id="sync-to-code"
description={t('go_to_pdf_location_in_code')}
overlayProps={overlayProps}
>
<span>
<OLButton
variant="secondary"
size="sm"
onClick={syncToCodeWithButton}
disabled={syncToCodeInFlight}
className={buttonClasses}
aria-label={t('go_to_pdf_location_in_code')}
>
{buttonIcon}
{isDetachLayout ? <span>&nbsp;{t('show_in_code')}</span> : ''}
</OLButton>
</span>
</OLTooltip>
)
})
const GoToPdfButton = memo(function GoToPdfButton({
syncToPdf,
syncToPdfInFlight,
isDetachLayout,
canSyncToPdf,
}: {
syncToPdf: () => void
syncToPdfInFlight: boolean
canSyncToPdf: boolean
isDetachLayout?: boolean
}) {
const { t } = useTranslation()
const tooltipPlacement = isDetachLayout ? 'bottom' : 'right'
const buttonClasses = classNames('synctex-control', {
'detach-synctex-control': !!isDetachLayout,
})
const handleSyncToPdf = useCallback(() => {
sendMB('jump-to-location', {
method: 'arrow',
direction: 'code-location-in-pdf',
})
syncToPdf()
}, [syncToPdf])
let buttonIcon = null
if (syncToPdfInFlight) {
buttonIcon = <OLSpinner size="sm" />
} else if (!isDetachLayout) {
buttonIcon = (
<MaterialIcon type="arrow_right_alt" className="synctex-control-icon" />
)
}
return (
<OLTooltip
id="sync-to-pdf"
description={t('go_to_code_location_in_pdf')}
overlayProps={{ placement: tooltipPlacement }}
>
<span>
<OLButton
variant="secondary"
size="sm"
onClick={handleSyncToPdf}
disabled={syncToPdfInFlight || !canSyncToPdf}
className={buttonClasses}
aria-label={t('go_to_code_location_in_pdf')}
>
{buttonIcon}
{isDetachLayout ? <span>&nbsp;{t('show_in_pdf')}</span> : ''}
</OLButton>
</span>
</OLTooltip>
)
})
function PdfSynctexControls() {
const { detachRole } = useLayoutContext()
const { pdfUrl, pdfViewer, position } = useCompileContext()
const {
syncToCode,
syncToPdf,
syncToCodeInFlight,
syncToPdfInFlight,
canSyncToPdf,
} = useSynctex()
const visualPreviewEnabled = useFeatureFlag('visual-preview')
if (visualPreviewEnabled) {
return null
}
if (!position) {
return null
}
if (!pdfUrl || pdfViewer === 'native') {
return null
}
if (detachRole === 'detacher') {
return (
<GoToPdfButton
syncToPdf={syncToPdf}
syncToPdfInFlight={syncToPdfInFlight}
isDetachLayout
canSyncToPdf={canSyncToPdf}
/>
)
} else if (detachRole === 'detached') {
return (
<GoToCodeButton
syncToCode={syncToCode}
syncToCodeInFlight={syncToCodeInFlight}
isDetachLayout
/>
)
} else {
return (
<>
<GoToPdfButton
syncToPdf={syncToPdf}
syncToPdfInFlight={syncToPdfInFlight}
canSyncToPdf={canSyncToPdf}
/>
<GoToCodeButton
syncToCode={syncToCode}
syncToCodeInFlight={syncToCodeInFlight}
/>
</>
)
}
}
export default memo(PdfSynctexControls)