Решение: создайте ссылку и примените ее к компоненту ImageGallery.
export default function ImageGallery(props: Props) {
const refImg = useRef(null)
const renderCustomControls = () => <span>refImg.current.getCurrentIndex()</span>
return (
<ImageGallery
ref={refImg}
renderCustomControls={renderCustomControls}
items={images}
/>
)
}