如视 Five SDK
Preparing search index...
react
FiveAppProps
Interface FiveAppProps
interface
FiveAppProps
{
autoCanvas
?:
boolean
;
children
?:
ReactNode
;
fallback
?:
ReactNode
;
fiveInitArgs
?:
FiveInitArgs
;
fullscreen
?:
boolean
;
load
?:
(
five
:
Five
,
)
=>
Promise
<
[
inputWork
:
|
string
|
string
[]
|
LooseWork
|
Work
|
Work
[]
|
LooseWork
[]
|
LooseWorkWithExtrinsics
[]
|
Promise
<
LooseWork
|
Work
|
Work
[]
|
LooseWork
[]
|
LooseWorkWithExtrinsics
[]
,
>
,
state
?:
"initial"
|
"inherit"
|
Partial
<
State
>
,
options
?:
number
|
FiveLoadOptions
,
userAction
:
boolean
,
]
,
>
;
plugins
?:
(
|
(
(
five
:
Five
)
=>
void
)
|
[
Plugin
:
(
(
five
:
Five
)
=>
any
)
|
(
(
five
:
Five
,
parameters
:
any
)
=>
any
)
,
instanceName
:
string
|
null
,
]
|
[
Plugin
:
(
(
five
:
Five
)
=>
any
)
|
(
(
five
:
Five
,
parameters
:
any
)
=>
any
)
,
instanceName
:
string
|
null
,
parameters
:
any
,
]
|
[
Plugin
:
(
five
:
Five
)
=>
any
,
instanceName
:
string
|
null
]
)
[]
;
renderChildren
?:
boolean
;
}
Index
Properties
auto
Canvas?
children?
fallback?
five
Init
Args?
fullscreen?
load?
plugins?
render
Children?
Properties
Optional
auto
Canvas
autoCanvas
?:
boolean
是否自动挂载 FiveAutoCanvas,默认 true
Optional
children
children
?:
ReactNode
Optional
fallback
fallback
?:
ReactNode
加载中显示的 fallback,类似 Suspense 的 fallback
Optional
five
Init
Args
fiveInitArgs
?:
FiveInitArgs
Optional
fullscreen
fullscreen
?:
boolean
Optional
load
load
?:
(
five
:
Five
,
)
=>
Promise
<
[
inputWork
:
|
string
|
string
[]
|
LooseWork
|
Work
|
Work
[]
|
LooseWork
[]
|
LooseWorkWithExtrinsics
[]
|
Promise
<
LooseWork
|
Work
|
Work
[]
|
LooseWork
[]
|
LooseWorkWithExtrinsics
[]
,
>
,
state
?:
"initial"
|
"inherit"
|
Partial
<
State
>
,
options
?:
number
|
FiveLoadOptions
,
userAction
:
boolean
,
]
,
>
Optional
plugins
plugins
?:
(
|
(
(
five
:
Five
)
=>
void
)
|
[
Plugin
:
(
(
five
:
Five
)
=>
any
)
|
(
(
five
:
Five
,
parameters
:
any
)
=>
any
)
,
instanceName
:
string
|
null
,
]
|
[
Plugin
:
(
(
five
:
Five
)
=>
any
)
|
(
(
five
:
Five
,
parameters
:
any
)
=>
any
)
,
instanceName
:
string
|
null
,
parameters
:
any
,
]
|
[
Plugin
:
(
five
:
Five
)
=>
any
,
instanceName
:
string
|
null
]
)
[]
Optional
render
Children
renderChildren
?:
boolean
Settings
Member Visibility
Inherited
Theme
OS
Light
Dark
On This Page
Properties
auto
Canvas
children
fallback
five
Init
Args
fullscreen
load
plugins
render
Children
如视 Five SDK
Loading...
是否自动挂载 FiveAutoCanvas,默认 true