Concepts

Components

Any views that your app has are placed in components. Primate natively supports serving HTML files from this directory, and its official framework modules extend this support to other formats.

Serving views

To serve views, start by creating an HTML component in components.

components/hello.html

<p>Hello, world!</p>

Serve it using the view handler, passing in the name of the HTML file you just created.

routes/hello.js

import { view } from "primate";

export default {
  get() {
    return view("hello.html");
  },
};

The view handler will use the pages/app.html to render a full HTML page, replacing %body% with the component's contents. If pages/app.html doesn't exist, Primate will use its default fallback file.

pages/app.html

<!doctype html>
<html>
  <head>
    <title>Primate app</title>
    <meta charset="utf-8" />
    %head%
  </head>
  <body>%body%</body>
</html>

The combination of the route's output and the page will result in the following HTML page served to a client requesting GET /hello.

response body at GET /hello

<html>
  <head>
    <title>Primate app</title>
    <meta charset="utf-8" />
  </head>
  <body>
    <p>Hello, world!</p>
  </body>
</html>

Partials

It is sometimes necessary to serve a bare component without the app.html page, especially if you're replacing some parts of the page. To this end, you can use the partial option of the view handler.

routes/partial-hello.js

import { view } from "primate";

export default {
  get() {
    return view("hello.html", {}, { partial: true });
  },
};

Using the same hello.html component specified as above, a client requesting GET /partial-hello will see the following response.

response body at GET /partial-hello

<p>Hello, world!</p>

Guards

Layouts