1---
2category: Browser
3---
4 
5# useFullscreen
6 
7Reactive [Fullscreen API](https://developer.mozilla.org/en-US/docs/Web/API/Fullscreen_API). It adds methods to present a specific Element (and its descendants) in full-screen mode, and to exit full-screen mode once it is no longer needed. This makes it possible to present desired content—such as an online game—using the user's entire screen, removing all browser user interface elements and other applications from the screen until full-screen mode is shut off.
8 
9## Usage
10 
11```ts
12import { useFullscreen } from '@vueuse/core'
13 
14const { isFullscreen, enter, exit, toggle } = useFullscreen()
15```
16 
17Fullscreen specified element. Some platforms (like iOS's Safari) only allow fullscreen on video elements.
18 
19```vue
20<script setup lang="ts">
21import { useFullscreen } from '@vueuse/core'
22import { useTemplateRef } from 'vue'
23 
24const el = useTemplateRef('el')
25const { isFullscreen, enter, exit, toggle } = useFullscreen(el)
26</script>
27 
28<template>
29  <video ref="el" />
30</template>
31```
32 
33## Component Usage
34 
35```vue
36<template>
37  <UseFullscreen v-slot="{ toggle }">
38    <video />
39    <button @click="toggle">
40      Go Fullscreen
41    </button>
42  </UseFullscreen>
43</template>
44```
45 
46## Type Declarations
47 
48```ts
49export interface UseFullscreenOptions extends ConfigurableDocument {
50  /**
51   * Automatically exit fullscreen when component is unmounted
52   *
53   * @default false
54   */
55  autoExit?: boolean
56}
57export interface UseFullscreenReturn extends Supportable {
58  isFullscreen: ShallowRef<boolean>
59  enter: () => Promise<void>
60  exit: () => Promise<void>
61  toggle: () => Promise<void>
62}
63/**
64 * Reactive Fullscreen API.
65 *
66 * @see https://vueuse.org/useFullscreen
67 * @param target
68 * @param options
69 */
70export declare function useFullscreen(
71  target?: MaybeElementRef,
72  options?: UseFullscreenOptions,
73): UseFullscreenReturn
74```
75