Teleforge API Reference - v0.1.0
Preparing search index...
core/src
RouteDefinition
Interface RouteDefinition
Describes an addressable Mini App route and its UI/runtime requirements.
interface
RouteDefinition
{
capabilities
?:
TeleforgeRouteCapability
;
component
?:
string
;
coordination
?:
RouteCoordinationMetadata
;
description
?:
string
;
guards
?:
string
[]
;
launchModes
?:
string
[]
;
meta
?:
{
description
?:
string
;
title
?:
string
}
;
path
:
string
;
title
?:
string
;
ui
?:
{
header
?:
{
hideBackButton
?:
boolean
;
title
?:
string
}
;
mainButton
?:
{
text
:
string
;
visible
?:
boolean
}
;
}
;
}
Index
Properties
capabilities?
component?
coordination?
description?
guards?
launch
Modes?
meta?
path
title?
ui?
Properties
Optional
capabilities
capabilities
?:
TeleforgeRouteCapability
Optional
component
component
?:
string
Optional
coordination
coordination
?:
RouteCoordinationMetadata
Optional
description
description
?:
string
Optional
guards
guards
?:
string
[]
Optional
launch
Modes
launchModes
?:
string
[]
Optional
meta
meta
?:
{
description
?:
string
;
title
?:
string
}
path
path
:
string
Optional
title
title
?:
string
Optional
ui
ui
?:
{
header
?:
{
hideBackButton
?:
boolean
;
title
?:
string
}
;
mainButton
?:
{
text
:
string
;
visible
?:
boolean
}
;
}
Settings
Member Visibility
Inherited
Theme
OS
Light
Dark
On This Page
Properties
capabilities
component
coordination
description
guards
launch
Modes
meta
path
title
ui
Teleforge API Reference - v0.1.0
Loading...
Describes an addressable Mini App route and its UI/runtime requirements.