html-express-js

An Express template engine to render HTML views using native JavaScript

3.1.0
latest
Source
npm

Version published: 8 months ago

Maintainers: 1

Created: 2 years ago

Source

build npm node

html-express-js

Features

Serves HTML documents using template literals
Supports includes in HTML documents
Allows shared global state throughout templates

Installation

npm install html-express-js

Basic Usage

The following is a high level example of how the package can be used as an Express template engine. See example directory for all details of a working implementation.

Set up your Express app to use this engine:

import htmlExpress, { renderView } from 'html-express-js';

const app = express();
const __dirname = resolve();

const viewsDir = `${__dirname}/public`;

const { engine, staticIndexHandler } = htmlExpress({
  viewsDir, // root views directory to serve all index.js files
  includesDir: `${viewsDir}/includes`, // OPTIONAL: where all includes reside
  notFoundView: '404/index', // OPTIONAL: relative to viewsDir above
});

// set up engine
app.engine('js', engine);

// use engine
app.set('view engine', 'js');

// set directory where all index.js pages are served
app.set('views', viewsDir);

// render HTML in public/homepage.js with data
app.get('/', function (req, res, next) {
  renderView('homepage', req, res, {
    title: 'Awesome Homepage',
    name: 'Bob',
  });
});

// OPTIONALLY: route all GET requests to directories
// to their associated static index.js views in the public directory
// and, if not found, route to the 404/index.js view
app.use(staticIndexHandler());

Then you can create the associated files:

// public/includes/head.js
import { html } from 'html-express-js';

export const view = () => html`
  <meta charset="utf-8" />
  <meta http-equiv="X-UA-Compatible" content="IE=edge" />
  <meta
    name="viewport"
    content="width=device-width, initial-scale=1, maximum-scale=1.0, user-scalable=0"
  />
`;

// public/homepage.js
import { html } from 'html-express-js';

export const view = (data, state) => html`
  <!doctype html>
  <html lang="en">
    <head>
      ${state.includes.head}
      <title>${data.title}</title>
    </head>

    <body>
      <h1>This is the homepage for ${data.name}</h1>
    </body>
  </html>
`;

Advanced usage

Injecting and using state based on a request

The following shows an example of showing a logged out state based on the cookie on a request.

import htmlExpress, { renderView } from 'html-express-js';

const app = express();
const __dirname = resolve();

const viewsDir = `${__dirname}/public`;

const { engine, staticIndexHandler } = htmlExpress({
  viewsDir,
  /**
   * Inject global state into all views based on cookie
   */
  buildRequestState: (req) => {
    if (req.cookies['authed']) {
      return {
        loggedIn: true,
      };
    }
  },
});

app.engine('js', engine);
app.set('view engine', 'js');
app.set('views', viewsDir);

app.get('/', function (req, res, next) {
  renderView('homepage', req, res);
});

// public/homepage.js
import { html } from 'html-express-js';

export const view = (data, state) => {
  const { loggedIn } = state;

  return html`
    <!doctype html>
    <html lang="en">
      <head>
        <title>${data.title}</title>
      </head>

      <body>
        ${loggedIn ? `<a href="/logout">Logout</a>` : 'Not logged in'}
      </body>
    </html>
  `;
};

Development

Run site in examples directory

npm start

Run tests

npm test

Keywords

FAQs

What is html-express-js?

Is html-express-js well maintained?

Package last updated on 27 Mar 2024

Did you know?

Socket for GitHub automatically highlights issues in each pull request and monitors the health of all your open source dependencies. Discover the contents of your packages and block harmful activity before you install or update your dependencies.

Install