82 lines
2.0 KiB
TypeScript
82 lines
2.0 KiB
TypeScript
import { TIME_MS, timeoutAt } from '@speckle/shared'
|
|
import { until, useScroll } from '@vueuse/core'
|
|
import DOMPurify from 'dompurify'
|
|
import type { ShallowRef } from 'vue'
|
|
|
|
const purify = async (source: string) => {
|
|
let purify: typeof DOMPurify
|
|
|
|
if (import.meta.server) {
|
|
const jsdom = await import('jsdom')
|
|
const window = new jsdom.JSDOM('').window
|
|
purify = DOMPurify(window)
|
|
} else {
|
|
purify = DOMPurify
|
|
}
|
|
|
|
return purify.sanitize(source)
|
|
}
|
|
|
|
export function usePurifiedHtml(
|
|
html: MaybeRef<string>,
|
|
options?: Partial<{
|
|
key: string
|
|
debugKey?: string
|
|
/**
|
|
* If set, composable will wait for this to be true before returning. Useful in SSR
|
|
* when the markdown source is dependant on a query result
|
|
*/
|
|
waitFor?: Ref<boolean>
|
|
}>
|
|
) {
|
|
const htmlRef = computed(() => unref(html) || '')
|
|
const { key: keySuffix, waitFor } = options || {}
|
|
const key = computed(() => `usePurifiedHtml-${htmlRef.value}-${keySuffix}`)
|
|
|
|
const asyncData = useAsyncData(
|
|
key.value,
|
|
async () => {
|
|
if (!htmlRef.value?.length) return
|
|
return purify(htmlRef.value)
|
|
},
|
|
{ watch: [key] }
|
|
)
|
|
|
|
onServerPrefetch(async () => {
|
|
if (!waitFor) return
|
|
|
|
await Promise.race([
|
|
until(waitFor).toBe(true),
|
|
timeoutAt(10 * TIME_MS.second, 'Waiting for HTML purification trigger timed out')
|
|
])
|
|
await asyncData.refresh()
|
|
})
|
|
|
|
return {
|
|
purifiedHtml: computed(() => asyncData.data.value || '')
|
|
}
|
|
}
|
|
|
|
/**
|
|
* KeepAlive loses scroll position - use this to cache and restore the position
|
|
* upon reactivation
|
|
*/
|
|
export const useKeepAliveScrollState = (el: ShallowRef<HTMLElement | null>) => {
|
|
const scrollTracker = useScroll(el, {
|
|
throttle: 100
|
|
})
|
|
|
|
const retainedX = ref(scrollTracker.x.value)
|
|
const retainedY = ref(scrollTracker.y.value)
|
|
|
|
onDeactivated(() => {
|
|
retainedX.value = scrollTracker.x.value
|
|
retainedY.value = scrollTracker.y.value
|
|
})
|
|
|
|
onActivated(() => {
|
|
scrollTracker.x.value = retainedX.value
|
|
scrollTracker.y.value = retainedY.value
|
|
})
|
|
}
|