Skip to main content

Type Alias: OpenApiAppProps

OpenApiAppProps = Omit<OpenApiViewProps, "location" | "onNavigate"> & object

Defined in: resources/OpenApiApp.tsx:19

Type Declaration​

defaultLocation?​

optional defaultLocation?: OpenApiLocation

The first screen when uncontrolled. Defaults to the first resource's list.

location?​

optional location?: OpenApiLocation

The current screen, when the app's router owns it (controlled). Omit to let the component keep it.

onNavigate?​

optional onNavigate?: (location) => void

Called with the next location when the user navigates.

Parameters​

ParameterType
locationOpenApiLocation

Returns​

void