npm package discovery and stats viewer.

Discover Tips

  • General search

    [free text search, go nuts!]

  • Package details

    pkg:[package-name]

  • User packages

    @[username]

Sponsor

Optimize Toolset

I’ve always been into building performant and accessible sites, but lately I’ve been taking it extremely seriously. So much so that I’ve been building a tool to help me optimize and monitor the sites that I build to make sure that I’m making an attempt to offer the best experience to those who visit them. If you’re into performant, accessible and SEO friendly sites, you might like it too! You can check it out at Optimize Toolset.

About

Hi, 👋, I’m Ryan Hefner  and I built this site for me, and you! The goal of this site was to provide an easy way for me to check the stats on my npm packages, both for prioritizing issues and updates, and to give me a little kick in the pants to keep up on stuff.

As I was building it, I realized that I was actually using the tool to build the tool, and figured I might as well put this out there and hopefully others will find it to be a fast and useful way to search and browse npm packages as I have.

If you’re interested in other things I’m working on, follow me on Twitter or check out the open source projects I’ve been publishing on GitHub.

I am also working on a Twitter bot for this site to tweet the most popular, newest, random packages from npm. Please follow that account now and it will start sending out packages soon–ish.

Open Software & Tools

This site wouldn’t be possible without the immense generosity and tireless efforts from the people who make contributions to the world and share their work via open source initiatives. Thank you 🙏

© 2024 – Pkg Stats / Ryan Hefner

@bjacobel/vhtml-loader

v2.3.0

Published

webpack loader for https://github.com/developit/vhtml

Downloads

31

Vulnerabilities

Powered byPowered by Snyk
  • 0High
  • 0Medium
  • 0Low

Links

Git

Maintainers

bjacobelbjacobel

Keywords

Readme

vhtml-loader

Webpack loader that uses vhtml to render JSX into HTML without a VDOM.

Motivation

Do you like html-webpack-plugin but hate using EJS? This loader is for you. Now you can write your templates in the same way you write the rest of your React app: JSX.

Usage

  1. Install: yarn add --dev @bjacobel/vhtml-loader

  2. Install peer deps. If you're using a standard-ish React setup you probably already have them, but if not:

    yarn add --dev \
  @babel-core \
  webpack

  3. If you want to use it with html-webpack-plugin, install that too. (You can use vhtml-loader without it!)

  4. Add a rule in your webpack configuration for vhtml-loader, marking .html.jsx files (or any other extension you'd like) as transformable:

    module: {
  rules: [
    // other rules,
    {
      test: /\.html\.jsx$/,
      use: {
        loader: '@bjacobel/vhtml-loader',
        options: {
          // described below
        }
      },
    },
  ],
},

    The available options are:

    options: {
  doctype: true, // True by default. Set false if you will add <!DOCTYPE html> some other way.
}

  5. If you're using this loader with html-webpack-plugin to provide a template, configure that plugin:

    plugins: [
  // other plugins,
  new HtmlWebpackPlugin({
    template: './src/templates/index.html.jsx',
  }),
];

  6. Instead of steps 4 and 5, if you're only planning on using this loader to transform one file for an html-webpack-plugin template, do this:

    plugins: [
  // other plugins,
  new HtmlWebpackPlugin({
    template: '!!@bjacobel/vhtml-loader!./src/templates/index.html.jsx',
  }),
];

Limitations

  • If using ESM, your templates must have a default export.
  • If using CommonJS, your templates must be assigned to module.exports.
  • Don't try to do imports inside your templates. Currently the loader strips them all until I can figure out how to support them.
  • The set of syntax you can use inside your templates is limited to whatever works in the Node version you're using.
  • If you plan on dynamically writing script tags, or doing anything else that requires not escaping HTML special characters (ie, quotes), you must use dangerouslySetInnerHTML. See escaping.html.jsx for an example.