0.9.0 • Published 7 years ago

html-webpack-react-root-plugin v0.9.0

Weekly downloads
54
License
MIT
Repository
-
Last release
7 years ago

React Root Plugin for HTML Webpack Plugin

This is a plugin that extends the functionality of the HTML Webpack Plugin by adding an element to the generated HTML file that React can use to render the app.

Installation

Install the plugin with npm:

$ npm install html-webpack-react-root-plugin --save-dev

Basic Use

This adds an element (a div with "root" as the id by default) to the HTML file generated by the HTML Webpack Plugin:

const HtmlWebpackPlugin = require('html-webpack-plugin');
const ReactRootPlugin = require('html-webpack-root-plugin');
const webpackConfig = {
  entry: 'index.js',
  output: {
    path: 'build',
    filename: 'bundle.js'
  },
  plugins: [new HtmlWebpackPlugin(), new ReactRootPlugin()]
};

Should add this to your build directory.

<!DOCTYPE html>
<html>
  <head>
    <meta charset="UTF-8">
    <title>Webpack App</title>
  </head>
  <body>
    <div id="root"></div>
    <script src="bundle.js"></script>
  </body>
</html>

So you can do this:

import React from 'react';
import { render } from 'react-dom';

const Hello = () => (
  <h1>Hello!</h1>
);

render(
  <Hello />,
  document.getElementById('root')
);

Without adding a template!

Syntax

new ReactRootPlugin()

Creates a <div> with an id of "root."

new ReactRootPlugin(object)

Takes a configuration object with the following values:

  • tagName: the type of element created. Defaults to 'div'.
  • tagId: the ID given to the created tag. Defaults to 'root'.
new ReactRootPlugin(string)

If a string is passed it creates a <div> with the passed string as the ID.

If anything other than a string or an object is passed it will use the default values and issue a warning in the Webpack build report.

Examples

This adds an element (a div with "root" as the id by default) to the HTML file generated by the HTML Webpack Plugin:

Add <div id="app"></div> to the created file.

const webpackConfig = {
  entry: 'index.js',
  output: {
    path: 'build',
    filename: 'bundle.js'
  },
  plugins: [
    new HtmlWebpackPlugin(),
    new ReactRootPlugin('app')
  ]
};

Add <main id="application-root"></main> to the created file.

const webpackConfig = {
  entry: 'index.js',
  output: {
    path: 'build',
    filename: 'bundle.js'
  },
  plugins: [
    new HtmlWebpackPlugin(),
    new ReactRootPlugin({ tagName: 'main', tagId: 'application-root' })
  ]
};