useFullscreen
Reactive 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.
Demo
Usage
js
import { useFullscreen } from '@vueuse/core'
import { useTemplateRef } from 'vue'
const { isFullscreen, enter, exit, toggle } = useFullscreen()Fullscreen specified element. Some platforms (like iOS's Safari) only allow fullscreen on video elements.
ts
const el = useTemplateRef<HTMLElement>('el')
const { isFullscreen, enter, exit, toggle } = useFullscreen(el)js
const el = useTemplateRef('el')
const { isFullscreen, enter, exit, toggle } = useFullscreen(el)html
<video ref="el"></video>Component Usage
This function also provides a renderless component version via the
@vueuse/componentspackage. Learn more about the usage.
vue
<template>
<UseFullscreen v-slot="{ toggle }">
<video />
<button @click="toggle">
Go Fullscreen
</button>
</UseFullscreen>
</template>Type Declarations
typescript
export interface UseFullscreenOptions extends ConfigurableDocument {
/**
* Automatically exit fullscreen when component is unmounted
*
* @default false
*/
autoExit?: boolean
}
/**
* Reactive Fullscreen API.
*
* @see https://vueuse.org/useFullscreen
* @param target
* @param options
*/
export declare function useFullscreen(
target?: MaybeElementRef,
options?: UseFullscreenOptions,
): {
isSupported: ComputedRef<boolean>
isFullscreen: ShallowRef<boolean, boolean>
enter: () => Promise<void>
exit: () => Promise<void>
toggle: () => Promise<void>
}
export type UseFullscreenReturn = ReturnType<typeof useFullscreen>Source
Contributors
Anthony Fu
Fernando Fernández
wheat
Antério Vieira
IlyaL
Anthony Fu
tawen
zaqvil
Yvan Zhu
vaakian X
Jelf
webfansplz
Shinigami
Alex Kozack