Huge News!Announcing our $40M Series B led by Abstract Ventures.Learn More
Socket
Sign inDemoInstall
Socket

@shopify/react-html

Package Overview
Dependencies
Maintainers
9
Versions
191
Alerts
File Explorer

Advanced tools

Socket logo

Install Socket

Detect and block malicious and high-risk dependencies

Install

@shopify/react-html

## Installation

  • 1.0.2
  • Source
  • npm
  • Socket score

Version published
Weekly downloads
0
Maintainers
9
Weekly downloads
 
Created
Source

@shopify/react-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 from '@shopify/react-html';
import MyApp from '../app';

export default (ctx, next) => {
  ctx.body = renderToString(
    <HTML>
      <MyApp />
    </HTML>
  );

  await next();
}

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[];
  synchronousScripts?: Asset[];
  deferedScripts?: 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.

synchronousScripts Descriptors for any script tags you want to include in the HEAD of the document.

deferredScripts Descriptors for any deferred script tags you want to include at the end of the document.

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.

FAQs

Package last updated on 02 May 2018

Did you know?

Socket

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

Related posts

SocketSocket SOC 2 Logo

Product

  • Package Alerts
  • Integrations
  • Docs
  • Pricing
  • FAQ
  • Roadmap
  • Changelog

Packages

npm

Stay in touch

Get open source security insights delivered straight into your inbox.


  • Terms
  • Privacy
  • Security

Made with ⚡️ by Socket Inc