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

inline-html-template-plugin

v1.0.0

Published

A Webpack plugin for inlining fully rendered HTML as a template string.

Downloads

6

Readme

inline-html-template-plugin

Build Status npm version

Installation

To install, simply run:

npm install --save inline-html-template-plugin

The Problem

Sometimes, you need to inject javascript into an HTML file. Webpack handles this beautifully using HtmlWebpackPlugin. HtmlWebpackPlugin can also do a number of other dynamic things to generate an HTML file that's complete and ready for production.

In some cases, particularly with Web Components, you might need to inject HTML into your javascript. In the case of Web Components, your CSS will need to be inlined, and you'll want the CSS to be dynamically generated based on all the CSS imported throughout your app.

The Solution

The InlineHTMLTemplatePlugin allows you to inline your finalized HTML as a template into any Javascript file. In Web Components, this means that you can use the completed HTML as a template, and your entire Web Component will be packaged into a single javascript file.

Usage

A case for Web Components, as described above, might look like the following:

webpack.config.js

const HtmlWebpackPlugin = require('html-webpack-plugin');
const MiniCssExtractPlugin = require('mini-css-extract-plugin');
const HTMLInlineCSSWebpackPlugin = require('html-inline-css-webpack-plugin')
  .default;
const InlineHTMLTemplatePlugin = require('inline-html-template-plugin').default;

module.exports = {
  mode: 'development',
  entry: {
    component: __dirname + '/src/component.js'
  },
  module: {
    rules: [
      {
        test: /\.js$/,
        exclude: /(node_modules)/,
        use: {
          loader: 'babel-loader',
          options: {
            presets: ['@babel/preset-env'],
            plugins: [
              '@babel/plugin-proposal-object-rest-spread',
              '@babel/plugin-transform-runtime',
              '@babel/plugin-proposal-class-properties'
            ]
          }
        }
      },
      {
        test: /\.css$/i,
        use: [
          {
            loader: MiniCssExtractPlugin.loader,
            options: {
              sourceMap: false
            }
          },
          {
            loader: 'css-loader',
            options: {
              modules: true
            }
          }
        ]
      }
    ]
  },
  plugins: [
    new HtmlWebpackPlugin({
      template: 'src/component-template.html',
      filename: 'component-template.html',
      inject: false
    }),
    new MiniCssExtractPlugin(),
    new HTMLInlineCSSWebpackPlugin({
      replace: {
        target: '<!-- inline css -->',
        removeTarget: true
      }
    }),
    new InlineHTMLTemplatePlugin()
  ]
};

The key portion is this:

plugins: [
  // load the template; give it a filename
  new HtmlWebpackPlugin({
    template: 'src/component-template.html',
    filename: 'component-template.html',
    // to avoid a circular reference, do not inject javascript
    inject: false
  }),
  // extract the css into a file
  new MiniCssExtractPlugin(),
  // inline that CSS into your HTML
  new HTMLInlineCSSWebpackPlugin({
    replace: {
      target: '<!-- inline css -->',
      removeTarget: true
    }
  }),
  // inject the finalized HTML as a string into your javascript
  new InlineHTMLTemplatePlugin()
];

component-template.html

Your html might look like this:

<div id="app-container">
  <!-- inline css -->
  <div id="mount"></div>
</div>

component.js

Your component javascript might look something like this, where myApp is a javascript solution for initializing an application on a DOM node.

import myApp from './myApp';
const loadedTemplate = '/* InlineHTML: component-template.html */';

class WebpackComponent extends HTMLElement {
  connectedCallback() {
    this.attachShadow({ open: true });
    this.shadowRoot.innerHTML = loadedTemplate;
    myApp.initialize(this.shadowRoot.querySelector('#mount'));
  }
}
customElements.define('webpack-component', WebpackComponent);

In this javascript, the InlineHtmlTemplatePlugin looks for "/* InlineHTML: component-template.html */", parses the filename from this string, and replaces the string with your finalized HTML Template.

Contributing

This package uses semantic-release. Changes will be compiled into a changelog and the package versioned, tagged and published automatically. Please ensure your commit messages adhere to the following structure:

<type>: <subject>
<BLANK LINE>
<body>

Only the header is mandatory. The supported types are based off of the ESLint Convention.