New Case Study:See how Anthropic automated 95% of dependency reviews with Socket.Learn More →

nest-jsx-template-engine

Package Overview

Dependencies

Advanced tools

Install Socket

Detect and block malicious and high-risk dependencies

Install

nest-jsx-template-engine

JSX-based + typescript template engine for NestJS applications

0.1.0

Source

npm

Version published: 5 years ago

Weekly downloads: 8

Maintainers: 1

Weekly downloads

Created: 5 years ago

Source

nestjs-jsx-template-engine

This is a template engine for Nestjs applications that allows you to use JSX-based templates with strongly-typed params for server-side rendered HTML.

You don't need any extra templating engine like nunjucks or handlebars, and you get type-safety out of the box.

There's no additional compiler, since TypeScript compiles JSX natively.

Installation

Install the package:

npm install nest-jsx-template-engine

Update your tsconfig.json file to include jsx and jsxFactory options:

{
  "compilerOptions": {
    "jsx": "react",
    "jsxFactory": "h"
  }
}

Install the middleware in your Nest app.module:

// app.module.ts
import { Module, NestModule, MiddlewareConsumer } from '@nestjs/common';
import { RenderMiddleware } from 'nest-jsx-template-engine';
import { SomeModule } from './some/some.module';

@Module({
  imports: [SomeModule],
})
export class AppModule implements NestModule {
  configure(consumer: MiddlewareConsumer) {
    consumer
      .apply(RenderMiddleware)
      .forRoutes('*');
  }
}

Suggest installing it globally for all routes, but see Nest's documentation for other options on installing the middleware.

Rendering

// app.controller.ts
import { Controller, Get } from '@nestjs/common';
import { AppService } from './app.service';
import { Render } from 'nest-jsx-template-engine';
import { App } from './app.view';
import { AppViewTransferObject } from './app.vto';

@Controller()
export class AppController {
  constructor(private readonly appService: AppService) {}

  @Get()
  @Render(App) // pass the App view directly to the Render decorator
  getHello(): AppViewTransferObject {
    return this.appService.getHello();
  }
}

Define your template with JSX:

// app.view.tsx
import { h }  from 'nest-jsx-template-engine'
import { AppViewTransferObject } from './app.vto'

export function App(props: AppViewTransferObject): string {
  return <html>
    <body>
      <h1 class="foo">{props.name}</h1>
    </body>
  </html>
}

You can define a view-transfer interface for the props passed into your template. This way, you can strongly-type the values passed from your controller into your view.

// app.vto.ts
export interface AppViewTransferObject {
  name: string
}

See a working demo in the Github repo.

A Note on React-Flavored JSX

This package does not support React flavored JSX (e.g., className, htmlFor, etc). It expects basic HTML properties.

Keywords

FAQs

What is nest-jsx-template-engine?

Is nest-jsx-template-engine popular?

Is nest-jsx-template-engine well maintained?

Package last updated on 23 Jul 2020

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