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

react-dom-html-cli

v1.3.0

Published

react-dom-html cli utility to generate html files

Downloads

10

Vulnerabilities

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

Links

Git

Maintainers

adam-26adam-26

Keywords

reactreact-domhtmlreact-dom-htmlreact-dom-html-clihtml templates

Readme

react-dom-html-cli

Generate .html files from react-dom-html templates

npm npm CircleCI branch Maintainability Test Coverage Conventional Commits

Introduction

Generate .html files for serving client application bundles, sending emails or any other task that requires static Html pages to be generated.

react-dom-html eliminates the need for any html boilerplate, it uses a sensible default structure that you can completely customize for your needs without needing to use strings.

react-dom-html-cli generates .html files using react-dom-html templates.

Install

// npm
npm install --save-dev react-dom-html-cli

// yarn
yarn add react-dom-html-cli -D

The easiest way to run the executable is add a script to package.json:

{
    "scripts": {
        "generateHtml":
            "react-dom-html generateHtml templates/inputTemplate.js output/generated.html"
    }
}

Run the script to generate html:

# npm
npm run generateHtml

# yarn
yarn run generateHtml

Usage

  1. Define a html template

IMPORTANT: The template must be the default export from the file.

// htmlTemplate.js
import React from "react";
// You can use react components with the template

// The `<app />` element is REQUIRED, it represents the application container
// That is where your application will be rendered

export default {
    includeDocType: true,
    html: (
        <html>
            <head>
                <meta charSet="utf-8" />
                <title>My Application</title>
            </head>
            <body>
                <app>
                    <div>Loading...</div>
                </app>
                <script src="/public/scripts/appBundle.js" />
            </body>
        </html>
    ),
    appContainerTagName: "span"
};

You need to have .babelrc configured for React (or JSX) before running the cli template generator See demo/.babelrc for an example.

  1. Run the cli executable
react-dom-html generateHtml htmlTemplate.js generated.html
  1. Your html file is now generated!

Template API

The template accepts all options from react-dom-html, you can read more about template options there.

An additional option is supported:

  • includeDocType: set to true to include the HTML 5 doc type, or a string for a custom doc type

Also, the <app /> element is permitted to have children when using the cli.

type templateOptions = {
    includeDocType?: boolean | string,
    html: ?Element<"html">,
    appContainerTagName: ?string
};

Minimal template example

The following template is the minimum elements required to correctly render:

  • The <app /> element is required, and must be a child of <body>
// htmlTemplate.js
import React from "react";

export default {
    includeDocType: true,
    html: (
        <html>
            <body>
                <app />
            </body>
        </html>
    )
};

Contribute

For questions or issues, please open an issue, and you're welcome to submit a PR for bug fixes and feature requests.

This package exists as a yarn workspace, you will need to fork and then clone the parent workspace. Follow the instructions in the workspace README file for installing the workspace dependencies.

Before submitting a PR, ensure you run npm test to verify that your code adheres to the configured lint rules and passes all tests. Be sure to include tests for any code changes or additions.

License

MIT