React Routeways - API Reference • Docs

---

React Routeways - API Reference / RouteProps

Interface: RouteProps

Extends

• Omit<OriginalRouteProps, "path">

Properties

Component?

optional Component: null | ComponentType<object>

Inherited from

Omit.Component

Defined in

node_modules/react-router/dist/lib/components.d.ts:71

---

ErrorBoundary?

optional ErrorBoundary: null | ComponentType<object>

Inherited from

Omit.ErrorBoundary

Defined in

node_modules/react-router/dist/lib/components.d.ts:73

---

HydrateFallback?

optional HydrateFallback: null | ComponentType<object>

Inherited from

Omit.HydrateFallback

Defined in

node_modules/react-router/dist/lib/components.d.ts:72

---

action?

optional action: boolean | ActionFunction<any>

Inherited from

Omit.action

Defined in

node_modules/react-router/dist/lib/components.d.ts:62

---

caseSensitive?

optional caseSensitive: boolean

Inherited from

Omit.caseSensitive

Defined in

node_modules/react-router/dist/lib/components.d.ts:57

---

catchAll?

optional catchAll: boolean

Enables the “catchall” splat for the route. This means that a /* string will be appended to the end othe the path when the template is generated from the Routeway route.

Default

false

Defined in

src/lib/components/Route.component.tsx:15

---

children?

optional children: ReactNode | ReactElement<RouteProps, string | JSXElementConstructor<any>> | ReactElement<RouteProps, string | JSXElementConstructor<any>>[]

Optional nested react-routeways Route component(s). It also supports React Fragment components(s) as react-router-dom’s Route does.

Overrides

Omit.children

Defined in

src/lib/components/Route.component.tsx:20

---

element?

optional element: ReactNode

Inherited from

Omit.element

Defined in

node_modules/react-router/dist/lib/components.d.ts:68

---

errorElement?

optional errorElement: ReactNode

Inherited from

Omit.errorElement

Defined in

node_modules/react-router/dist/lib/components.d.ts:70

---

handle?

optional handle: any

Inherited from

Omit.handle

Defined in

node_modules/react-router/dist/lib/components.d.ts:65

---

hasErrorBoundary?

optional hasErrorBoundary: boolean

Inherited from

Omit.hasErrorBoundary

Defined in

node_modules/react-router/dist/lib/components.d.ts:63

---

hydrateFallbackElement?

optional hydrateFallbackElement: ReactNode

Inherited from

Omit.hydrateFallbackElement

Defined in

node_modules/react-router/dist/lib/components.d.ts:69

---

id?

optional id: string

Inherited from

Omit.id

Defined in

node_modules/react-router/dist/lib/components.d.ts:59

---

index?

optional index: boolean

Inherited from

Omit.index

Defined in

node_modules/react-router/dist/lib/components.d.ts:66

---

lazy?

optional lazy: LazyRouteFunction<NonIndexRouteObject> | LazyRouteFunction<IndexRouteObject>

Inherited from

Omit.lazy

Defined in

node_modules/react-router/dist/lib/components.d.ts:60

---

loader?

optional loader: boolean | LoaderFunction<any>

Inherited from

Omit.loader

Defined in

node_modules/react-router/dist/lib/components.d.ts:61

---

route?

optional route: Routeway | "*"

The Routeway route to take the template to set to the path prop of react-router-dom’s Route component.

The splat * character is also a supported value. To append a splat * to a route you can set the catchAll prop to true.

Defined in

src/lib/components/Route.component.tsx:31

---

shouldRevalidate?

optional shouldRevalidate: ShouldRevalidateFunction

Inherited from

Omit.shouldRevalidate

Defined in

node_modules/react-router/dist/lib/components.d.ts:64