You're Invited:Meet the Socket Team at BlackHat and DEF CON in Las Vegas, Aug 7-8.RSVP →

@shopify/react-html

Package Overview

Dependencies

Advanced tools

Install Socket

Detect and block malicious and high-risk dependencies

Install

@shopify/react-html

A component to render your react app with no static HTML.

2.0.10
Source
npm

Version published: 6 years ago

Weekly downloads: 27K; increased by5.38%

Maintainers: 9

Created: 6 years ago

Weekly downloads

Readme

Source

`@shopify/react-html`

A component to render your react app with no static HTML.

Installation

$ yarn add @shopify/react-html

Usage

The <HTML> component serves as a top level wrapper for a react application, allowing you to avoid needing any kind of server side template, in favour of purely using reactDom.renderToString.

import * as React from 'react';
import { renderToString } from 'react-dom/server';

import HTML, {DOCTYPE} from '@shopify/react-html';
import MyApp from '../app';

export default (ctx, next) => {
  // we have to prepend DOCTYPE to serve valid HTML
  ctx.body = DOCTYPE + renderToString(
    <HTML>
      <MyApp />
    </HTML>
  );

  await next();
}

Due to limitations in react's implementation of HTML, you still need to prepend the <!DOCTYPE html> directive. To assist with this the module also exports a DOCTYPE constant.

The component will automatically propagate any usage of the react-helmet module in your app's content to manipulate the title or other top level HTML or HEAD attributes.

Interface

export interface Props {
  children?: React.ReactNode;
  styles?: Asset[];
  scripts?: Asset[];
  blockingScripts?: Asset[];
  headData?: {[id: string]: any};
  data?: {[id: string]: any};
}

interface Asset {
  path: string;
  integrity?: string;
}

interface Browser {
  userAgent: string;
  supported: boolean;
}

Basic props

Most simple applications will only need these basic properties.

children The children to be rendered inside the #app div.

styles Descriptors for any style tags you want to include in the HEAD of the document.

scripts Descriptors for any script tags you want to include in your document. All scripts passed to this property will be deferred by appending them to the end of the document. We encourage this as a default, although you may use blockingScripts for any scripts that must be included in the HEAD of the document.

blockingScripts Descriptors for any script tags you want to include in the HEAD of the document. These will block HTML parsing until they are evaluated, so use them carefully.

Serializers

These props are useful for more complex applications that want to synchronize redux, apollo, translation, or any other data across the network boundary. These props are stringified into the DOM using (@shopify/react-serialize)[https://github.com/Shopify/quilt/blob/master/packages/react-serialize/README.md].

headData Any serializable data that needs to be available from the DOM when the synchronousScripts are run.

data Any serializable data that needs to be available from the DOM when the deferredScripts are run.

Asset Components

This module also exports the asset components the <HTML /> component uses internally for it's script and style props.

import {Style, Script} from '@shopify/react-html';

Style

The <Style /> component lets you render <link> tags in your document dynamically as part of your react app.

<Style
  href="./some-style.css"
  integrity="some-integrity-hash"
  crossOrigin="anonymous"
/>

Script

The <Script /> component lets you render <script> tags in your document dynamically as part of your react app.

<Script
  src="./some-script.js"
  integrity="some-integrity-hash"
  crossOrigin="anonymous"
/>

FAQs

What is @shopify/react-html?

Is @shopify/react-html popular?

Is @shopify/react-html well maintained?

Package last updated on 30 May 2018

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