gil-wiki/reference/4.api/1.components/6.nuxt-error-boundary.md

title, description, links

title	description	links
<NuxtErrorBoundary>	The <NuxtErrorBoundary> component handles client-side errors happening in its default slot.	label icon to size Source i-simple-icons-github https://github.com/nuxt/nuxt/blob/main/packages/nuxt/src/app/components/nuxt-error-boundary.vue xs

::tip The <NuxtErrorBoundary> uses Vue's onErrorCaptured hook under the hood. ::

Events

• @error: Event emitted when the default slot of the component throws an error.

  <template>
    <NuxtErrorBoundary @error="logSomeError">
      <!-- ... -->
    </NuxtErrorBoundary>
  </template>
  

Slots

• #error: Specify a fallback content to display in case of error.

  <template>
    <NuxtErrorBoundary>
      <!-- ... -->
      <template #error="{ error, clearError }">
        <p>An error occurred: {{ error }}</p>
  
        <button @click="clearError">
          Clear error
        </button>
      </template>
    </NuxtErrorBoundary>
  </template>
  

:read-more{to="/docs/4.x/getting-started/error-handling"}

Examples

Accessing error and clearError in script

You can access error and clearError properties within the component's script as below:

<template>
  <NuxtErrorBoundary ref="errorBoundary">
    <!-- ... -->
  </NuxtErrorBoundary>
</template>

<script setup lang="ts">
const errorBoundary = useTemplateRef('errorBoundary')

// errorBoundary.value?.error
// errorBoundary.value?.clearError()
</script>