centurion-ui
    Preparing search index...

    Interface IndexRouteDescription

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

    0.13.0

    interface IndexRouteDescription {
        action?: "api";
        component?: RouteComponentDescription;
        handle?: RouteHandleDescription;
        hydrate?: "loader";
        id?: string;
        index: boolean;
        loader?: RoutePageLoaderDescription;
        revalidate?: boolean;
    }

    Hierarchy (View Summary)

    Index
    action?: "api"

    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"
    • "ticket"

      Use Ticket.

    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.

    index: boolean

    Is this route an index route? This value must always be set to true

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

    Type Declaration

    revalidate?: boolean

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