---
id: app/write-tests/component-testing/vue/api
title: Vue API
description: API for mounting Vue components in Cypress tests.
section: app
source_path: docs/app/write-tests/component-testing/vue/api.mdx
version: 9a02aad952dd3b4513e6557c9d3098e1d0d39d5a
updated_at: '2026-09-21T14:21:15.415Z'
---
# Vue API

The `cypress/vue` module provides the following methods and interfaces for mounting and testing Vue components.

## mount

```
import { mount } from 'cypress/vue'
```

<table><tbody><tr><td>Description</td><td><p>Used for mounting Vue components in isolation. It is responsible for rendering the component within Cypress's sandboxed iframe and handling any framework-specific cleanup.</p></td></tr><tr><td>Signature</td><td><p>mount(originalComponent: { new (...args: any[]): ; __vccOpts: any; }, options?: MountOptions): Cypress.Chainable&lt;MountReturn&gt;</p></td></tr></tbody></table>

<table><caption>mount Parameters</caption><thead></thead><tbody><tr><td>Name</td><td>Type</td><td>Description</td></tr><tr><td>originalComponent</td><td>new (...args: any[])</td><td>The component to mount in test</td></tr><tr><td>options</td><td>MountOptions (optional)</td><td>The options for mounting the component</td></tr></tbody></table>

## Interfaces

### MountOptions

([Vue 3 MountingOptions](https://test-utils.vuejs.org/api/#mount) or [Vue Test Utils](https://test-utils.vuejs.org/))

### MountReturn

Type that the `mount` function yields

<table><caption>members</caption><thead></thead><tbody><tr><td>Name</td><td>Type</td><td>Description</td></tr><tr><td>wrapper</td><td>VueWrapper</td><td>The Vue Test Utils <code>wrapper</code></td></tr><tr><td>component</td><td>VueComponent</td><td>The component instance</td></tr></tbody></table>