React Helmet

A document head manager for React

React
nfl/react-helmetreact-helmet

README


React Helmet

npm Version codecov.io Build Status Dependency Status PRs Welcome

This reusable React component will manage all of your changes to the document head.

Helmet _takes_ plain HTML tags and _outputs_ plain HTML tags. It's dead simple, and React beginner friendly.

6.1.0 Major Changes



Example

  1. ``` js
  2. import React from "react";
  3. import {Helmet} from "react-helmet";

  5. class Application extends React.Component {
  6.   render () {
  7.     return (
  8.         <div className="application">
  9.             <Helmet>
  10.                 <meta charSet="utf-8" />
  11.                 <title>My Title</title>
  12.                 <link rel="canonical" href="http://mysite.com/example" />
  13.             </Helmet>
  14.             ...
  15.         </div>
  16.     );
  17.   }
  18. };
  19. ```

Nested or latter components will override duplicate changes:

  1. ``` js
  2. <Parent>
  3.     <Helmet>
  4.         <title>My Title</title>
  5.         <meta name="description" content="Helmet application" />
  6.     </Helmet>
  7. <Child>
  8.         <Helmet>
  9.             <title>Nested Title</title>
  10.             <meta name="description" content="Nested component" />
  11.         </Helmet>
  12.     </Child>
  13. </Parent>
  14. ```

outputs:

  1. ``` html
  2. <head>
  3.     <title>Nested Title</title>
  4.     <meta name="description" content="Nested component">
  5. </head>
  6. ```

See below for a full reference guide.

Features

- Supports all valid head tags: title, base, meta, link, script, noscript, and style tags.
- Supports attributes for body, html and title tags.
- Supports server-side rendering.
- Nested components override duplicate head changes.
- Duplicate head changes are preserved when specified in the same component (support for tags like "apple-touch-icon").
- Callback for tracking DOM changes.

Compatibility


Helmet 5 is fully backward-compatible with previous Helmet releases, so you can upgrade at any time without fear of breaking changes. We encourage you to update your code to our more semantic API, but please feel free to do so at your own pace.

Installation


Yarn:
  1. ``` sh
  2. yarn add react-helmet
  3. ```

npm:
  1. ``` sh
  2. npm install --save react-helmet
  3. ```

Server Usage

To use on the server, call Helmet.renderStatic() after ReactDOMServer.renderToString or ReactDOMServer.renderToStaticMarkup to get the head data for use in your prerender.

Because this component keeps track of mounted instances, you have to make sure to call renderStatic on server, or you'll get a memory leak.

  1. ``` js
  2. ReactDOMServer.renderToString(<Handler />);
  3. const helmet = Helmet.renderStatic();
  4. ```

This helmet instance contains the following properties:
- base
- bodyAttributes
- htmlAttributes
- link
- meta
- noscript
- script
- style
- title

Each property contains toComponent() and toString() methods. Use whichever is appropriate for your environment. For attributes, use the JSX spread operator on the object returned by toComponent(). E.g:

As string output

  1. ``` js
  2. const html = `
  3.     doctype html>
  4.     <html ${helmet.htmlAttributes.toString()}>
  5.         <head>
  6.             ${helmet.title.toString()}
  7.             ${helmet.meta.toString()}
  8.             ${helmet.link.toString()}
  9.         </head>
  10.         <body ${helmet.bodyAttributes.toString()}>
  11.             <div id="content">
  12.                 // React stuff here
  13.             </div>
  14.         </body>
  15.     </html>
  16. `;
  17. ```

As React components

  1. ``` js
  2. function HTML () {
  3.     const htmlAttrs = helmet.htmlAttributes.toComponent();
  4.     const bodyAttrs = helmet.bodyAttributes.toComponent();

  6.     return (
  7.         <html {...htmlAttrs}>
  8.             <head>
  9.                 {helmet.title.toComponent()}
  10.                 {helmet.meta.toComponent()}
  11.                 {helmet.link.toComponent()}
  12.             </head>
  13.             <body {...bodyAttrs}>
  14.                 <div id="content">
  15.                     // React stuff here
  16.                 </div>
  17.             </body>
  18.         </html>
  19.     );
  20. }
  21. ```

Note: Use the same instance

If you are using a prebuilt compilation of your app with webpack in the server be sure to include this in the webpack file so that the same instance of react-helmet is used.
  1. ```
  2. externals: ["react-helmet"],
  3. ```
Or to import the react-helmet instance from the app on the server.

Reference Guide


  1. ``` js
  2. <Helmet
  3.     {/* (optional) set to false to disable string encoding (server-only) */}
  4.     encodeSpecialCharacters={true}

  6.     {/*
  7.         (optional) Useful when you want titles to inherit from a template:

  9.         <Helmet
  10.             titleTemplate="%s | MyAwesomeWebsite.com"
  11.         >
  12.             <title>Nested Title</title>
  13.         </Helmet>

  15.         outputs:

  17.         <head>
  18.             <title>Nested Title | MyAwesomeWebsite.com</title>
  19.         </head>
  20.     */}
  21.     titleTemplate="MySite.com - %s"

  23.     {/*
  24.         (optional) used as a fallback when a template exists but a title is not defined

  26.         <Helmet
  27.             defaultTitle="My Site"
  28.             titleTemplate="My Site - %s"
  29.         />

  31.         outputs:

  33.         <head>
  34.             <title>My Site</title>
  35.         </head>
  36.     */}
  37.     defaultTitle="My Default Title"
  38.     
  39.     {/* (optional) set to false to not use requestAnimationFrame and instead update the DOM as soon as possible.
  40.         Useful if you want to update the title when the tab is out of focus
  41.     */}
  42.     defer={false}

  44.     {/* (optional) callback that tracks DOM changes */}
  45.     onChangeClientState={(newState, addedTags, removedTags) => console.log(newState, addedTags, removedTags)}
  46. >
  47.     {/* html attributes */}
  48.     <html lang="en" amp />

  50.     {/* body attributes */}
  51.     <body className="root" />

  53.     {/* title attributes and value */}
  54.     <title itemProp="name" lang="en">My Plain Title or {`dynamic`} title</title>

  56.     {/* base element */}
  57.     <base target="_blank" href="http://mysite.com/" />

  59.     {/* multiple meta elements */}
  60.     <meta name="description" content="Helmet application" />
  61.     <meta property="og:type" content="article" />

  63.     {/* multiple link elements */}
  64.     <link rel="canonical" href="http://mysite.com/example" />
  65.     <link rel="apple-touch-icon" href="http://mysite.com/img/apple-touch-icon-57x57.png" />
  66.     <link rel="apple-touch-icon" sizes="72x72" href="http://mysite.com/img/apple-touch-icon-72x72.png" />
  67.     {locales.map((locale) => {
  68.         <link rel="alternate" href="http://example.com/{locale}" hrefLang={locale} key={locale}/>
  69.     })}

  71.     {/* multiple script elements */}
  72.     <script src="http://include.com/pathtojs.js" type="text/javascript" />

  74.     {/* inline script elements */}
  75.     <script type="application/ld+json">{`
  76.         {
  77.             "@context": "http://schema.org"
  78.         }
  79.     `}</script>

  81.     {/* noscript elements */}
  82.     <noscript>{`
  83.         <link rel="stylesheet" type="text/css" href="foo.css" />
  84.     `}</noscript>

  86.     {/* inline style elements */}
  87.     <style type="text/css">{`
  88.         body {
  89.             background-color: blue;
  90.         }

  92.         p {
  93.             font-size: 12px;
  94.         }
  95.     `}</style>
  96. </Helmet>
  97. ```

Contributing to this project

Please take a moment to review the guidelines for contributing.

Pull requests
Development Process

License


MIT