> For the complete documentation index, see [llms.txt](/llms.txt).

# useWeb3Auth

Composable to access the Embedded Wallets/Web3Auth context in Vue.

### Import[​](#import "Direct link to Import")

```
import { useWeb3Auth } from '@web3auth/modal/vue'

```

### Usage[​](#usage "Direct link to Usage")

```
<script setup lang="ts">
  import { useWeb3Auth } from '@web3auth/modal/vue'

  const { web3Auth, isConnected, isInitializing, provider, status, initError } = useWeb3Auth()

  watchEffect(() => {
    if (isConnected.value) {
      // User is connected
      console.log('Connected with provider:', provider.value)
    }
    if (isInitializing.value) {
      // Web3Auth is initializing
      console.log('Web3Auth is initializing')
    }
    if (provider.value) {
      // Web3Auth provider is connected
      console.log('Web3Auth provider is connected')
    }
    if (status.value) {
      // Web3Auth status
      console.log('Web3Auth status:', status.value)
    }
    if (initError.value) {
      // Web3Auth initialization error
      console.log('Web3Auth initialization error:', initError.value)
    }
  })
</script>

```

### Return type[​](#return-type "Direct link to Return type")

```
import type { IUseWeb3Auth } from '@web3auth/modal/vue'

```

#### `initError`[​](#initerror "Direct link to initerror")

`Ref<Error | null>`

Error that occurred during Web3Auth initialization.

#### `isConnected`[​](#isconnected "Direct link to isconnected")

`Ref<boolean>`

Whether the user is connected to Web3Auth.

#### `isInitialized`[​](#isinitialized "Direct link to isinitialized")

`Ref<boolean>`

Whether Web3Auth has completed initialization.

#### `isInitializing`[​](#isinitializing "Direct link to isinitializing")

`Ref<boolean>`

Whether Web3Auth is currently initializing.

#### `provider`[​](#provider "Direct link to provider")

`Ref<IProvider | null>`

Connected provider from Web3Auth.

#### `status`[​](#status "Direct link to status")

`Ref<string>`

Current status of the Web3Auth connection.

#### `web3Auth`[​](#web3auth "Direct link to web3auth")

`Ref<Web3Auth>`

The Web3Auth instance.

#### `getPlugin`[​](#getplugin "Direct link to getplugin")

`(pluginName: PLUGIN_NAME) => IPlugin | null`

Helper function to get a plugin by name.
