centurion-ui
    Preparing search index...

    Interface NonIndexRouteDescription

    This Description describes non-index routes that are used by routesFromObject to build the RouteObjects for the UI.

    routesFromObject

    0.13.0

    interface NonIndexRouteDescription {
        action?: "api";
        children?: RouteDescription[];
        component?: RouteComponentDescription;
        handle?: RouteHandleDescription;
        hydrate?: "loader";
        id?: string;
        loader?: RoutePageLoaderDescription;
        path?: string;
        revalidate?: boolean;
    }

    Hierarchy (View Summary)

    Index
    action? children? component? handle? hydrate? id? loader? path? revalidate?
    action?: "api"
    children?: RouteDescription[]

    Child routes for this route.

    component?: RouteComponentDescription

    Component to use for this route.

    Type Declaration

    • "backend"

      This backend, regardless of what value you set here will be used automatically if RouteHandleDescription.backend_url is supplied a value. This is done to ensure that context is correctly set.

      Use BackendLayout

    • "detail"

      This layout should have its route path set to :pk. Value :pk is a placeholder that is dynamic. PK for the unfamiliar stands for "Primary Key" which is a unique ID used by databases. Its recommended usage here is two-fold: denotes a single item and if you need to use path /add (used for new object creation, see DetailLayout) you can.

      Use DetailLayout.

    • "history"

      Use History.

    • "redirect"

      Use Redirect.

    • "list"

      Use List.

    • "markdown"

      Use Markdown.

    • "settings"

      Use Settings

    • "ticket"

      Use Ticket.

    handle?: RouteHandleDescription

    Arbitrary data for this route.

    Type Declaration

    Available keys for use within a routes handle.

    • Optionalbackend_url?: string

      URL base for the backend.

    • Optionalmetadata?: apiRootMetadata

      Cached apiRootMetadata from the backend at RouteHandleDescription.backend_url. This key must not be populated by the end-user when declaring routes. The key is automatically populated by dynamicRouter

    • Optionalurl_post?: string

      This key is only used by Redirect layout.

      URL to perform a HTTP/POST against.

    • Optionalurl_redirect?: string

      This key is only used by Redirect layout.

      URL to redirect to.

    hydrate?: "loader"

    Component to use for hydration.

    id?: string

    id to use for this route.

    loader?: RoutePageLoaderDescription

    Loader to use for this route. Only specify a loader if there is data that must be fetched.

    Type Declaration

    path?: string

    The value that you use here is dependent upon how you are building your routes. If you are nesting routes, then the value here will be a single part of the url.

    i.e. full-url=/some/path/here for the parent route, this value would be set to some.

    This value can also be setup to be dynamic. To do this prefix the name of the dynamic path you wish to use for this route with a colin ":".

    i.e. full-url=/some/path/here if you wanted the parent route to be dynamic with a name of "section", this value would be set to :section.

    revalidate?: boolean

    Should the loader data be re-validated on a navigation event.

    Settings
    Member Visibility

    On This Page
    Properties