Project home
API overview
npm
Theme
System
Light
Dark
vue-screenfull
Preparing search index...
ScreenfullController
Interface ScreenfullController
interface
ScreenfullController
{
element
:
Element
|
null
;
error
:
ScreenfullError
|
null
;
isEnabled
:
boolean
;
isFallback
:
boolean
;
isFullscreen
:
boolean
;
raw
:
Readonly
<
RawFullscreenApi
>
|
null
;
status
:
ScreenfullStatus
;
clearError
()
:
void
;
destroy
()
:
Promise
<
void
>
;
exit
()
:
Promise
<
ScreenfullResult
>
;
off
(
event
:
"change"
,
listener
:
ScreenfullChangeListener
)
:
void
;
off
(
event
:
"error"
,
listener
:
ScreenfullErrorListener
)
:
void
;
on
(
event
:
"change"
,
listener
:
ScreenfullChangeListener
)
:
void
;
on
(
event
:
"error"
,
listener
:
ScreenfullErrorListener
)
:
void
;
request
(
element
?:
Element
|
null
,
options
?:
ScreenfullRequestOptions
,
)
:
Promise
<
ScreenfullResult
>
;
toggle
(
element
?:
Element
|
null
,
options
?:
ScreenfullRequestOptions
,
)
:
Promise
<
ScreenfullResult
>
;
}
Index
Properties
element
error
is
Enabled
is
Fallback
is
Fullscreen
raw
status
Methods
clear
Error
destroy
exit
off
on
request
toggle
Properties
Readonly
element
element
:
Element
|
null
Readonly
error
error
:
ScreenfullError
|
null
Readonly
is
Enabled
isEnabled
:
boolean
Readonly
is
Fallback
isFallback
:
boolean
Readonly
is
Fullscreen
isFullscreen
:
boolean
Readonly
raw
raw
:
Readonly
<
RawFullscreenApi
>
|
null
Readonly
status
status
:
ScreenfullStatus
Methods
clear
Error
clearError
()
:
void
Returns
void
destroy
destroy
()
:
Promise
<
void
>
Returns
Promise
<
void
>
exit
exit
()
:
Promise
<
ScreenfullResult
>
Returns
Promise
<
ScreenfullResult
>
off
off
(
event
:
"change"
,
listener
:
ScreenfullChangeListener
)
:
void
Parameters
event
:
"change"
listener
:
ScreenfullChangeListener
Returns
void
off
(
event
:
"error"
,
listener
:
ScreenfullErrorListener
)
:
void
Parameters
event
:
"error"
listener
:
ScreenfullErrorListener
Returns
void
on
on
(
event
:
"change"
,
listener
:
ScreenfullChangeListener
)
:
void
Parameters
event
:
"change"
listener
:
ScreenfullChangeListener
Returns
void
on
(
event
:
"error"
,
listener
:
ScreenfullErrorListener
)
:
void
Parameters
event
:
"error"
listener
:
ScreenfullErrorListener
Returns
void
request
request
(
element
?:
Element
|
null
,
options
?:
ScreenfullRequestOptions
,
)
:
Promise
<
ScreenfullResult
>
Parameters
Optional
element
:
Element
|
null
Optional
options
:
ScreenfullRequestOptions
Returns
Promise
<
ScreenfullResult
>
toggle
toggle
(
element
?:
Element
|
null
,
options
?:
ScreenfullRequestOptions
,
)
:
Promise
<
ScreenfullResult
>
Parameters
Optional
element
:
Element
|
null
Optional
options
:
ScreenfullRequestOptions
Returns
Promise
<
ScreenfullResult
>
Settings
Member Visibility
Inherited
External
Theme
System
Light
Dark
On This Page
Properties
element
error
is
Enabled
is
Fallback
is
Fullscreen
raw
status
Methods
clear
Error
destroy
exit
off
on
request
toggle
vue-screenfull
Loading...