Published: Modified: V1.9
hapi

Setting up a view in hapi js

So when starting out with hapi js one of the first things that comes up is how to go about setting up a client system, serve static assets, and provide a view. A view can be set up by just hosting static assets, but what about server side, on demand rending with templates? In this post I will be going over how to get started with a view in hapi js.

1 - hapi view and what to know before hand.

To set up a view more dependencies need to be installed into a project beyond just hapi itself. Of course the layout engine of choice needs to be installed, but also an additional plug in as well at least in hapi 17.x.

2 - Setting up a view in hapi 17.x

In this section I am using hapi 17.9.0 which differs significantly from older versions of hapi, in older, and possibly newer major releases of hapi the code example here might break.

So I set up a project folder for this example and I am using the following dependences and version of hapi.

1
2
3
4
5
6
$ mkdir view-pug
$ cd view-pug
$ npm init
$ npm install @hapi/hapi@17.9.0 --save
$ npm install @hapi/vision@5.2.2 --save
$ npm install pug@2.0.4 --save

I then have a main index.js file that looks like this:

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
let Hapi = require('@hapi/hapi');
let init = async() => {
    let server = Hapi.server({
            port: 3000,
            host: 'localhost'
        });
    await server.register(require('@hapi/vision'));
    // set up pug as a view engine
    server.views({
        engines: {
            pug: require('pug')
        },
        relativeTo: __dirname,
        path: 'views'
    });
    // use pug
    server.route({
        method: 'GET',
        path: '/',
        handler: (request, h) => {
            return h.view('index.pug');
        }
    });
    await server.start();
    console.log('Server running on %s', server.info.uri);
};
init();

And a index.pug file in the views folder.

1
2
3
4
5
6
7
doctype html
html(lang="en")
  head
    title This is Pug
  body
    h1 Hello World Pug Style
    p So Pug can be used as a way to make templates for Hapi js projects

2.1 - Using locals

So then there is also a desire to use local variables for the template in most cases. For that just pass an object that contains the locals that are to be used in the template when calling the view method in the response toolkit.

1
2
3
4
5
6
7
8
// use pug
server.route({
    method: 'GET',
    path: '/',
    handler: (request, h) => {
        return h.view('index.pug', {mess:'foobar'});
    }
});

So the the local variable can be used in the template.

1
2
3
4
5
6
7
8
doctype html
html(lang="en")
  head
    title Using locals
  body
    h1 
      | So this is all 
      span= mess