react-helmet-async

v1.3.0

Thread-safe Helmet for React 16+ and friends

NPM

README

GitHub

Apache-2.0

Latest version published 4 months ago

    npm install react-helmet-async

We couldn't find any similar packages Browse all packages

Package Health Score

80 / 100

Security
No known security issues
Popularity
Influential project
Maintenance
Sustainable
Community
Sustainable

Keep your project healthy

Check your package.json

Ensure all the packages you're using are healthy and well-maintained

Snyk Vulnerability Scanner

Get health score & security insights directly in your IDE

Secure Your Project

Find & fix vulnerable dependencies and insecure code

Security

No known security issues

All security vulnerabilities belong to production dependencies of direct and indirect packages.

Security and license risk for significant versions

All Versions

Version				Vulnerabilities	License Risk
1.3.0	\|	04/2022	Popular	0 C 0 H 0 M 0 L	0 H 0 M 0 L
1.2.3	\|	02/2022		0 C 0 H 0 M 0 L	0 H 0 M 0 L
0.2.0	\|	10/2018		0 C 0 H 0 M 0 L	0 H 0 M 0 L
0.1.0	\|	05/2018		0 C 0 H 0 M 0 L	0 H 0 M 0 L
0.0.5	\|	01/2018		0 C 0 H 0 M 0 L	0 H 0 M 0 L

License

Apache-2.0

Security Policy

Is your project affected by vulnerabilities?

Scan your projects for vulnerabilities. Fix quickly with automated fixes. Get started with Snyk for free.

# Install the Snyk CLI and test your project 
 npm i snyk -g && snyk test react-helmet-async

Get started free

Popularity

Influential project

Weekly Downloads (2,343,957)

Dependents: 326
GitHub Stars: 1.54K
Forks: 130
Contributors: 30

Direct Usage Popularity

The npm package react-helmet-async receives a total of 2,343,957 downloads a week. As such, we scored react-helmet-async popularity level to be Influential project.

Based on project statistics from the GitHub repository for the npm package react-helmet-async, we found that it has been starred 1,545 times, and that 326 other projects in the ecosystem are dependent on it.

Downloads are calculated as moving averages for a period of the last 12 months, excluding weekends and known missing data points.

Community

Sustainable

Readme.md: Yes
Contributing.md: No
Code of Conduct: No
Contributors: 30
Funding: No

With more than 10 contributors for the react-helmet-async repository, this is possibly a sign for a growing and inviting community.

We found a way for you to contribute to the project! Looks like react-helmet-async is missing a Code of Conduct.

Embed Package Health Score Badge

Maintenance

Sustainable

Commit Frequency

Open Issues: 37
Open PR: 6
Last Release: 4 months ago
Last Commit: 4 months ago

Further analysis of the maintenance status of react-helmet-async based on released npm versions cadence, the repository activity, and other data points determined that its maintenance is Sustainable.

We found that react-helmet-async demonstrates a positive version release cadence with at least one new version released in the past 12 months.

As a healthy sign for on-going project maintenance, we found that the GitHub repository had at least 1 pull request or issue interacted with by the community.

Package

Node.js Compatibility: not defined

Age: 5 years
Dependencies: 5 Direct
Versions: 36
Install Size: 328 kB
Dist-tags: 3
# of Files: 20
Maintainers: 1
TS Typings: Yes

react-helmet-async has more than a single and default latest tag published for the npm package. This means, there may be other tags available for this package, such as next to indicate future releases, or stable to indicate stable releases.

Not sure how to use react-helmet-async?

To help you get started, we've collected the most common ways that react-helmet-async is being used within popular public projects.

tomatau / breko-hub / test / test-setup.js View on Github

import { isBrowser, ConfigService } from 'app/utils'
import appConfig from 'config/app.config'
import helpers from './test-helpers'

configure({ adapter: new ReactSixteenAdapter() })

chai.use(require('chai-shallow-deep-equal'))
chai.use(require('chai-as-promised'))
chai.use(require('chai-enzyme')())
chai.use(require('sinon-chai'))
chai.use(require('chai-generator'))
chai.use(require('chai-jest-snapshot'))

process.env.APP_CONFIG = JSON.stringify(appConfig)

Helmet.defaultProps.defer = false

setGlobals(isBrowser ? window : global)

function setGlobals(global) {
  ConfigService.setEnv(process.env.CONFIG_ENV)
  ConfigService.assignVars(process.env.APP_CONFIG)

  global.global = global

  global.expect = expect
  global.sinon = sinon

  global.snap = snap

  global.shallow = shallow
  global.mount = mount

View more ways to use react-helmet-async

react-helmet-async

Announcement post on Times Open blog

This package is a fork of React Helmet. <Helmet> usage is synonymous, but server and client now requires <HelmetProvider> to encapsulate state per request.

react-helmet relies on react-side-effect, which is not thread-safe. If you are doing anything asynchronous on the server, you need Helmet to encapsulate data on a per-request basis, this package does just that.

Usage

New is 1.0.0: No more default export! import { Helmet } from 'react-helmet-async'

The main way that this package differs from react-helmet is that it requires using a Provider to encapsulate Helmet state for your React tree. If you use libraries like Redux or Apollo, you are already familiar with this paradigm:

import React from 'react';
import ReactDOM from 'react-dom';
import { Helmet, HelmetProvider } from 'react-helmet-async';

const app = (
  <HelmetProvider>
    <App>
      <Helmet>
        <title>Hello World</title>
        <link rel="canonical" href="https://www.tacobell.com/" />
      </Helmet>
      <h1>Hello World</h1>
    </App>
  </HelmetProvider>
);

ReactDOM.hydrate(
  app,
  document.getElementById(‘app’)
);

On the server, we will no longer use static methods to extract state. react-side-effect exposed a .rewind() method, which Helmet used when calling Helmet.renderStatic(). Instead, we are going to pass a context prop to HelmetProvider, which will hold our state specific to each request.

import React from 'react';
import { renderToString } from 'react-dom/server';
import { Helmet, HelmetProvider } from 'react-helmet-async';

const helmetContext = {};

const app = (
  <HelmetProvider context={helmetContext}>
    <App>
      <Helmet>
        <title>Hello World</title>
        <link rel="canonical" href="https://www.tacobell.com/" />
      </Helmet>
      <h1>Hello World</h1>
    </App>
  </HelmetProvider>
);

const html = renderToString(app);

const { helmet } = helmetContext;

// helmet.title.toString() etc…

Streams

This package only works with streaming if your <head> data is output outside of renderToNodeStream(). This is possible if your data hydration method already parses your React tree. Example:

import through from 'through';
import { renderToNodeStream } from 'react-dom/server';
import { getDataFromTree } from 'react-apollo';
import { Helmet, HelmetProvider } from 'react-helmet-async';
import template from 'server/template';

const helmetContext = {};

const app = (
  <HelmetProvider context={helmetContext}>
    <App>
      <Helmet>
        <title>Hello World</title>
        <link rel="canonical" href="https://www.tacobell.com/" />
      </Helmet>
      <h1>Hello World</h1>
    </App>
  </HelmetProvider>
);

await getDataFromTree(app);

const [header, footer] = template({
  helmet: helmetContext.helmet,
});

res.status(200);
res.write(header);
renderToNodeStream(app)
  .pipe(
    through(
      function write(data) {
        this.queue(data);
      },
      function end() {
        this.queue(footer);
        this.queue(null);
      }
    )
  )
  .pipe(res);

Usage in Jest

While testing in using jest, if there is a need to emulate SSR, the following string is required to have the test behave the way they are expected to.

import { HelmetProvider } from 'react-helmet-async';

HelmetProvider.canUseDOM = false;

Prioritizing tags for SEO

It is understood that in some cases for SEO, certain tags should appear earlier in the HEAD. Using the prioritizeSeoTags flag on any <Helmet> component allows the server render of react-helmet-async to expose a method for prioritizing relevant SEO tags.

In the component:

<Helmet prioritizeSeoTags>
  <title>A fancy webpage</title>
  <link rel="notImportant" href="https://www.chipotle.com" />
  <meta name="whatever" value="notImportant" />
  <link rel="canonical" href="https://www.tacobell.com" />
  <meta property="og:title" content="A very important title"/>
</Helmet>

In your server template:

<html>
  <head>
    ${helmet.title.toString()}
    ${helmet.priority.toString()}
    ${helmet.meta.toString()}
    ${helmet.link.toString()}
    ${helmet.script.toString()}
  </head>
  ...
</html>

Will result in:

<html>
  <head>
    <title>A fancy webpage</title>
    <meta property="og:title" content="A very important title"/>
    <link rel="canonical" href="https://www.tacobell.com" />
    <meta name="whatever" value="notImportant" />
    <link rel="notImportant" href="https://www.chipotle.com" />
  </head>
  ...
</html>

A list of prioritized tags and attributes can be found in constants.js.

Usage without Context

You can optionally use <Helmet> outside a context by manually creating a stateful HelmetData instance, and passing that stateful object to each <Helmet> instance:

import React from 'react';
import { renderToString } from 'react-dom/server';
import { Helmet, HelmetProvider, HelmetData } from 'react-helmet-async';

const helmetData = new HelmetData({});

const app = (
    <App>
      <Helmet helmetData={helmetData}>
        <title>Hello World</title>
        <link rel="canonical" href="https://www.tacobell.com/" />
      </Helmet>
      <h1>Hello World</h1>
    </App>
);

const html = renderToString(app);

const { helmet } = helmetData.context;

License

react-helmet-async dependencies

@babel/runtime invariant prop-types react-fast-compare shallowequal

FAQs

What is react-helmet-async?

Thread-safe Helmet for React 16+ and friends. Visit Snyk Advisor to see a full health score report for react-helmet-async, including popularity, security, maintenance & community analysis.

Is react-helmet-async popular?

The npm package react-helmet-async receives a total of 2,343,957 weekly downloads. As such, react-helmet-async popularity was classified as an influential project. Visit the popularity section on Snyk Advisor to see the full health analysis.

Is react-helmet-async well maintained?

We found indications that react-helmet-async maintenance is sustainable demonstrating some project activity. We saw a total of 30 open source contributors collaborating on the project. See the full package health analysis to learn more about the package maintenance status.

Is react-helmet-async safe to use?

The npm package react-helmet-async was scanned for known vulnerabilities and missing license, and no issues were found. Thus the package was deemed as safe to use. See the full health analysis review.

Last updated on 11 August-2022, at 01:14 (UTC).

Build a secure application checklist

Select a recommended open source package

Minimize your risk by selecting secure & well maintained open source packages

DONE

Scan your app for vulnerabilities

Scan your application to find vulnerabilities in your: source code, open source dependencies, containers and configuration files

SCAN NOW

Fix identified vulnerabilities

Easily fix your code by leveraging automatically generated PRs

AUTO FIX

Monitor for new issues

New vulnerabilities are discovered every day. Get notified if your application is affected

MONITOR APP

Package Health Score

Keep your project healthy

Check your package.json

Snyk Vulnerability Scanner

Secure Your Project

Security and license risk for significant versions

Is your project affected by vulnerabilities?

Weekly Downloads (2,343,957)

Direct Usage Popularity

Embed Package Health Score Badge

Commit Frequency

Not sure how to use react-helmet-async?

react-helmet-async

Usage

Streams

Usage in Jest

Prioritizing tags for SEO

Usage without Context

License

react-helmet-async dependencies

FAQs

What is react-helmet-async?

Is react-helmet-async popular?

Is react-helmet-async well maintained?

Is react-helmet-async safe to use?

Build a secure application checklist

Select a recommended open source package

Scan your app for vulnerabilities

Source Code

Open Source

Container

Config

Fix identified vulnerabilities

Monitor for new issues