@threlte/extras

onReveal

onReveal invokes a callback when the component is revealed (i.e., no longer suspended in the context of a <Suspense> boundary). It mimics Svelte’s lifecycle method onMount. If there is no <Suspense> component, the callback will be executed with Svelte’s onMount as the component will never suspend.

Example

The following component loads a model with the hook useGltf and is potentially wrapped in a <Suspense> boundary.

<script>
  import { T } from '@threlte/core'
  import { onReveal, useGltf } from '@threlte/extras'

  const gltf = useGltf('model.gltf')

  onReveal(() => {
    console.log('The component has been revealed')
  })
</script>

{#await gltf then { scene }}
  <T is={scene}>
{/await}