Project home
API overview
npm
Theme
System
Light
Dark
vue-screenfull
Preparing search index...
UseScreenfullReturn
Interface UseScreenfullReturn
interface
UseScreenfullReturn
{
error
:
Readonly
<
ShallowRef
<
ScreenfullError
|
null
>
>
;
fullscreenElement
:
Readonly
<
ShallowRef
<
Element
|
null
>
>
;
isEnabled
:
Readonly
<
Ref
<
boolean
>
>
;
isFallback
:
Readonly
<
Ref
<
boolean
>
>
;
isFullscreen
:
Readonly
<
Ref
<
boolean
>
>
;
status
:
Readonly
<
Ref
<
ScreenfullStatus
>
>
;
targetElement
:
Readonly
<
ShallowRef
<
Element
|
null
>
>
;
clearError
()
:
void
;
exit
()
:
Promise
<
ScreenfullResult
>
;
request
(
target
?:
ScreenfullTarget
,
options
?:
ScreenfullRequestOptions
,
)
:
Promise
<
ScreenfullResult
>
;
toggle
(
target
?:
ScreenfullTarget
,
options
?:
ScreenfullRequestOptions
,
)
:
Promise
<
ScreenfullResult
>
;
}
Index
Properties
error
fullscreen
Element
is
Enabled
is
Fallback
is
Fullscreen
status
target
Element
Methods
clear
Error
exit
request
toggle
Properties
error
error
:
Readonly
<
ShallowRef
<
ScreenfullError
|
null
>
>
fullscreen
Element
fullscreenElement
:
Readonly
<
ShallowRef
<
Element
|
null
>
>
is
Enabled
isEnabled
:
Readonly
<
Ref
<
boolean
>
>
is
Fallback
isFallback
:
Readonly
<
Ref
<
boolean
>
>
is
Fullscreen
isFullscreen
:
Readonly
<
Ref
<
boolean
>
>
status
status
:
Readonly
<
Ref
<
ScreenfullStatus
>
>
target
Element
targetElement
:
Readonly
<
ShallowRef
<
Element
|
null
>
>
Methods
clear
Error
clearError
()
:
void
Returns
void
exit
exit
()
:
Promise
<
ScreenfullResult
>
Returns
Promise
<
ScreenfullResult
>
request
request
(
target
?:
ScreenfullTarget
,
options
?:
ScreenfullRequestOptions
,
)
:
Promise
<
ScreenfullResult
>
Parameters
Optional
target
:
ScreenfullTarget
Optional
options
:
ScreenfullRequestOptions
Returns
Promise
<
ScreenfullResult
>
toggle
toggle
(
target
?:
ScreenfullTarget
,
options
?:
ScreenfullRequestOptions
,
)
:
Promise
<
ScreenfullResult
>
Parameters
Optional
target
:
ScreenfullTarget
Optional
options
:
ScreenfullRequestOptions
Returns
Promise
<
ScreenfullResult
>
Settings
Member Visibility
Inherited
External
Theme
System
Light
Dark
On This Page
Properties
error
fullscreen
Element
is
Enabled
is
Fallback
is
Fullscreen
status
target
Element
Methods
clear
Error
exit
request
toggle
vue-screenfull
Loading...