bhylu.com

Advertisements

AngularJS Route Resolves

A route resolve supplies a prerequisite before the route controller is created. Use it for a deliberate screen contract and define what a refusal or failed prerequisite should do.

How it works

The desk detail resolve provides a small trusted local record through $q. The controller receives the resolved value as an injected dependency. An HTTP-based resolve would still need validation and a failure policy. Avoid waiting on an indefinitely open stream or starting unrelated background work in a blocking navigation step.

Run the code

AngularJS 1.8.3 is a legacy framework whose official support ended in January 2022. These examples teach maintenance, not a recommendation for a new application. They need a separate local browser page; Bhylu has no AngularJS playground.

In an empty folder save the HTML below as route-resolves.html and the server as lab-server.mjs. Make a vendor folder and save the four pinned libraries there, retaining their MIT notices. With Node 22 or later run node lab-server.mjs route-resolves.html, then open http://127.0.0.1:8136/. Stop that lab before running a different lesson. The server supplies fixed read-only HTTP fixtures; no data is saved and it does not connect to SQL. No PHP, Apache or MySQL configuration changes are needed.

Example

route-resolves.html

<!doctype html>
<html lang="en" ng-app="repairLab" ng-strict-di>
  <head>
    <meta charset="utf-8" />
    <meta name="viewport" content="width=device-width,initial-scale=1" />
    <title>AngularJS Route Resolves</title>
    <style>
      :root {
        font:
          18px/1.55 system-ui,
          sans-serif;
        color: #0f3464;
        background: #fff;
        color-scheme: light;
      }
      * {
        box-sizing: border-box;
      }
      body {
        margin: 0;
      }
      main {
        max-width: 50rem;
        margin: auto;
        padding: 1.2rem;
      }
      h1 {
        font-size: 1.65rem;
      }
      label {
        display: block;
        margin: 0.6rem 0;
      }
      input,
      select,
      textarea,
      button {
        font: inherit;
        max-width: 100%;
        padding: 0.35rem;
        margin: 0.2rem;
      }
      button {
        border: 1px solid #034fa0;
        border-radius: 0.25rem;
        background: #034fa0;
        color: white;
      }
      button:disabled {
        opacity: 0.55;
      }
      output,
      [role="status"] {
        display: block;
        min-height: 1.5rem;
      }
      table {
        border-collapse: collapse;
        width: 100%;
      }
      td,
      th {
        padding: 0.4rem;
        border: 1px solid #a5bbd4;
        text-align: left;
      }
      pre {
        white-space: pre-wrap;
        overflow-wrap: anywhere;
      }
      :focus-visible {
        outline: 3px solid #0078d4;
        outline-offset: 3px;
      }
      [ng-cloak] {
        display: none !important;
      }
      .marked {
        font-weight: 700;
      }
      .error {
        color: #a02424;
      }
      :root[data-theme="dark"] {
        color: #d6e7fb;
        background: #061d30;
        color-scheme: dark;
      }
      :root[data-theme="dark"] .error {
        color: #ffb4b4;
      }
    </style>
  </head>
  <body>
    <main ng-controller="DeskController as vm" ng-cloak>
      <h1>Community repair desk</h1>
      <p>AngularJS 1.8.3 · Legacy maintenance lab · Local demonstration</p>
      <div ng-view></div>
    </main>
    <script src="/vendor/angular.min.js"></script>
    <script src="/vendor/angular-route.min.js"></script>
    <script>
      (function () {
        "use strict";
        var app = angular.module("repairLab", ["ngRoute"]);
        app.config([
          "$routeProvider",
          function (routes) {
            routes
              .when("/", {
                template: "<p data-result>{{ route.record.note }}</p>",
                controller: "ResolvedController",
                controllerAs: "route",
                resolve: {
                  record: [
                    "$q",
                    function ($q) {
                      return $q.when({ note: "Inspect hinge" });
                    },
                  ],
                },
              })
              .otherwise({ redirectTo: "/" });
          },
        ]);
        app.controller("ResolvedController", [
          "record",
          function (record) {
            this.record = record;
          },
        ]);
        app.controller("DeskController", [function () {}]);
      })();
    </script>
  </body>
</html>
Focus on the bindings and controller

This excerpt leaves out the document shell, styles and library files. Use the complete download to run it.


<div ng-view></div>
<script>
  (function () {
    "use strict";
    var app = angular.module("repairLab", ["ngRoute"]);
    app.config([
      "$routeProvider",
      function (routes) {
        routes
          .when("/", {
            template: "<p data-result>{{ route.record.note }}</p>",
            controller: "ResolvedController",
            controllerAs: "route",
            resolve: {
              record: [
                "$q",
                function ($q) {
                  return $q.when({ note: "Inspect hinge" });
                },
              ],
            },
          })
          .otherwise({ redirectTo: "/" });
      },
    ]);
    app.controller("ResolvedController", [
      "record",
      function (record) {
        this.record = record;
      },
    ]);
    app.controller("DeskController", [function () {}]);
  })();
</script>

Expected result

Inspect hinge

The view is created with the resolved record and displays its note. The test exercises the real route transition rather than injecting the record into a different fake renderer. In maintained applications, listen for route-change errors where the UI can offer a useful alternative instead of leaving an unexplained blank view.

Advertisements