npmpackage.info

Gathering detailed insights and metrics for react-helmet

react-helmet

A document head manager for React

6.1.0

17,394

MIT

JavaScript

5.90 kB

457,418,123 2.3

Installations

npm install react-helmet

Score

91.2

Supply Chain

98.7

Quality

81.4

Maintenance

100

Vulnerability

100

License

Pull Requests

Open

60

Total

315

Closed

89

Merged

166

Issues

Open

162

Total

388

Closed

226

Releases

v6.1.0

6.1.0

Published on 08 Jun 2020

v6.0.0

6.0.0

Published on 30 Apr 2020

v5.0.0

5.0.0

Published on 21 Mar 2017

View all 3 releases

Developer

nfl

Developer Guide

BETA

Module System

CommonJS

Min. Node Version

Typescript Support

No

Node Version

12.11.1

NPM Version

6.14.4 Statistics

17,394 Stars

349 Commits

660 Forks

109 Watching

42 Branches

67 Contributors

Updated on 27 Nov 2024

Bundle Size

16.68 kB

Minified

5.90 kB

Minified + Gzipped

Bundlephobia

Languages

JavaScript (100%)

Total Downloads

Cumulative downloads

Total Downloads

457,418,123

Last day

-7.6%

329,766

Compared to previous day

Last week

0.1%

1,861,960

Compared to previous week

Last month

2.1%

8,011,922

Compared to previous month

Last year

-4.1%

92,120,005

Compared to previous year

Daily Downloads

Weekly Downloads

Monthly Downloads

Yearly Downloads

Dependencies

object-assign prop-types react-fast-compare react-side-effect

Peer Dependencies

react

Dev Dependencies

Versions

React Helmet

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

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

Nested or latter components will override duplicate changes:

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

outputs:

1<head>
2    <title>Nested Title</title>
3    <meta name="description" content="Nested component">
4</head>

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:

1yarn add react-helmet

npm:

1npm install --save react-helmet

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.

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

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

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

As React components

1function HTML () {
2    const htmlAttrs = helmet.htmlAttributes.toComponent();
3    const bodyAttrs = helmet.bodyAttributes.toComponent();
4
5    return (
6        <html {...htmlAttrs}>
7            <head>
8                {helmet.title.toComponent()}
9                {helmet.meta.toComponent()}
10                {helmet.link.toComponent()}
11            </head>
12            <body {...bodyAttrs}>
13                <div id="content">
14                    // React stuff here
15                </div>
16            </body>
17        </html>
18    );
19}

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.

externals: ["react-helmet"],

Or to import the react-helmet instance from the app on the server.

Reference Guide

1<Helmet
2    {/* (optional) set to false to disable string encoding (server-only) */}
3    encodeSpecialCharacters={true}
4
5    {/*
6        (optional) Useful when you want titles to inherit from a template:
7
8        <Helmet
9            titleTemplate="%s | MyAwesomeWebsite.com"
10        >
11            <title>Nested Title</title>
12        </Helmet>
13
14        outputs:
15
16        <head>
17            <title>Nested Title | MyAwesomeWebsite.com</title>
18        </head>
19    */}
20    titleTemplate="MySite.com - %s"
21
22    {/*
23        (optional) used as a fallback when a template exists but a title is not defined
24
25        <Helmet
26            defaultTitle="My Site"
27            titleTemplate="My Site - %s"
28        />
29
30        outputs:
31
32        <head>
33            <title>My Site</title>
34        </head>
35    */}
36    defaultTitle="My Default Title"
37    
38    {/* (optional) set to false to not use requestAnimationFrame and instead update the DOM as soon as possible.
39        Useful if you want to update the title when the tab is out of focus 
40    */}
41    defer={false}
42
43    {/* (optional) callback that tracks DOM changes */}
44    onChangeClientState={(newState, addedTags, removedTags) => console.log(newState, addedTags, removedTags)}
45>
46    {/* html attributes */}
47    <html lang="en" amp />
48
49    {/* body attributes */}
50    <body className="root" />
51
52    {/* title attributes and value */}
53    <title itemProp="name" lang="en">My Plain Title or {`dynamic`} title</title>
54
55    {/* base element */}
56    <base target="_blank" href="http://mysite.com/" />
57
58    {/* multiple meta elements */}
59    <meta name="description" content="Helmet application" />
60    <meta property="og:type" content="article" />
61
62    {/* multiple link elements */}
63    <link rel="canonical" href="http://mysite.com/example" />
64    <link rel="apple-touch-icon" href="http://mysite.com/img/apple-touch-icon-57x57.png" />
65    <link rel="apple-touch-icon" sizes="72x72" href="http://mysite.com/img/apple-touch-icon-72x72.png" />
66    {locales.map((locale) => {
67        <link rel="alternate" href="http://example.com/{locale}" hrefLang={locale} key={locale}/>
68    })}
69
70    {/* multiple script elements */}
71    <script src="http://include.com/pathtojs.js" type="text/javascript" />
72
73    {/* inline script elements */}
74    <script type="application/ld+json">{`
75        {
76            "@context": "http://schema.org"
77        }
78    `}</script>
79
80    {/* noscript elements */}
81    <noscript>{`
82        <link rel="stylesheet" type="text/css" href="foo.css" />
83    `}</noscript>
84
85    {/* inline style elements */}
86    <style type="text/css">{`
87        body {
88            background-color: blue;
89        }
90
91        p {
92            font-size: 12px;
93        }
94    `}</style>
95</Helmet>

Contributing to this project

Please take a moment to review the guidelines for contributing.

License

MIT

No vulnerabilities found.

10

Binary-Artifacts

Determines if the project has generated executable (binary) artifacts in the source repository.

10

License

Determines if the project has defined a license.

4

Code-Review

Determines if the project requires human code review before pull requests (aka merge requests) are merged.

0

Maintained

Determines if the project is "actively maintained".

0

Security-Policy

Determines if the project has published a security policy.

0

Fuzzing

Determines if the project uses fuzzing.

0

CII-Best-Practices

Determines if the project has an OpenSSF (formerly CII) Best Practices Badge.

0

Branch-Protection

Determines if the default and release branches are protected with GitHub's branch protection settings.

0

SAST

Determines if the project uses static code analysis.

0

Vulnerabilities

Determines if the project has open, known unfixed vulnerabilities.

Reason

100 existing vulnerabilities detected

Details

Warn: Project is vulnerable to: GHSA-67hx-6x53-jw92
Warn: Project is vulnerable to: GHSA-6chw-6frg-f759
Warn: Project is vulnerable to: GHSA-v88g-cgmw-v5xw
Warn: Project is vulnerable to: GHSA-93q8-gq69-wqmw
Warn: Project is vulnerable to: GHSA-fwr7-v2mv-hh25
Warn: Project is vulnerable to: GHSA-qwcr-r2fm-qrc7
Warn: Project is vulnerable to: GHSA-cwfw-4gq5-mrqx
Warn: Project is vulnerable to: GHSA-g95f-p29q-9xw4
Warn: Project is vulnerable to: GHSA-grv7-fg5c-xmjg
Warn: Project is vulnerable to: GHSA-xp63-6vf5-xf3v
Warn: Project is vulnerable to: GHSA-pxg6-pf52-xh8x
Warn: Project is vulnerable to: GHSA-9vvw-cc9w-f27h
Warn: Project is vulnerable to: GHSA-gxpj-cx7g-858c
Warn: Project is vulnerable to: GHSA-w573-4hg7-7wgq
Warn: Project is vulnerable to: GHSA-h6ch-v84p-w6p9
Warn: Project is vulnerable to: GHSA-ff7x-qrg7-qggm
Warn: Project is vulnerable to: GHSA-j4f2-536g-r55m
Warn: Project is vulnerable to: GHSA-r7qp-cfhv-p84w
Warn: Project is vulnerable to: GHSA-4gmj-3p3h-gm8h
Warn: Project is vulnerable to: GHSA-2j2x-2gpw-g8fm
Warn: Project is vulnerable to: GHSA-74fj-2j2h-c42q
Warn: Project is vulnerable to: GHSA-pw2r-vq6v-hr8c
Warn: Project is vulnerable to: GHSA-jchw-25xp-jwwc
Warn: Project is vulnerable to: GHSA-cxjh-pqwp-8mfp
Warn: Project is vulnerable to: GHSA-ww39-953v-wcq6
Warn: Project is vulnerable to: GHSA-q42p-pg8m-cqh6
Warn: Project is vulnerable to: GHSA-w457-6q6x-cgp9
Warn: Project is vulnerable to: GHSA-62gr-4qp9-h98f
Warn: Project is vulnerable to: GHSA-f52g-6jhx-586p
Warn: Project is vulnerable to: GHSA-2cf5-4w76-r9qv
Warn: Project is vulnerable to: GHSA-3cqr-58rm-57f8
Warn: Project is vulnerable to: GHSA-g9r4-xpmj-mj65
Warn: Project is vulnerable to: GHSA-q2c6-c6pm-g3gh
Warn: Project is vulnerable to: GHSA-765h-qjxv-5f44
Warn: Project is vulnerable to: GHSA-f2jv-r9rf-7988
Warn: Project is vulnerable to: GHSA-43f8-2h32-f4cj
Warn: Project is vulnerable to: GHSA-6x33-pw7p-hmpq
Warn: Project is vulnerable to: GHSA-qqgx-2p2h-9c37
Warn: Project is vulnerable to: GHSA-2pr6-76vf-7546
Warn: Project is vulnerable to: GHSA-8j8c-7jfh-h6hx
Warn: Project is vulnerable to: GHSA-9c47-m6qq-7p4h
Warn: Project is vulnerable to: GHSA-282f-qqgm-c34q
Warn: Project is vulnerable to: GHSA-7x7c-qm48-pq9c
Warn: Project is vulnerable to: GHSA-rc3x-jf5g-xvc5
Warn: Project is vulnerable to: GHSA-6c8f-qphg-qjgp
Warn: Project is vulnerable to: GHSA-jf85-cpcp-j695
Warn: Project is vulnerable to: GHSA-fvqr-27wr-82fm
Warn: Project is vulnerable to: GHSA-4xc9-xhrj-v574
Warn: Project is vulnerable to: GHSA-x5rq-j2xg-h7qm
Warn: Project is vulnerable to: GHSA-29mw-wpgm-hmr9
Warn: Project is vulnerable to: GHSA-35jh-r3h4-6jhm
Warn: Project is vulnerable to: GHSA-p6mc-m468-83gw
Warn: Project is vulnerable to: GHSA-82v2-mx6x-wq7q
Warn: Project is vulnerable to: GHSA-952p-6rrq-rcjv
Warn: Project is vulnerable to: GHSA-f8q6-p94x-37v3
Warn: Project is vulnerable to: GHSA-vh95-rmgr-6w4m / GHSA-xvch-5gv4-984h
Warn: Project is vulnerable to: GHSA-fhjf-83wg-r2j9
Warn: Project is vulnerable to: GHSA-w9mr-4mfr-499f
Warn: Project is vulnerable to: GHSA-w7rc-rwvf-8q5r
Warn: Project is vulnerable to: GHSA-r683-j2x4-v87g
Warn: Project is vulnerable to: GHSA-q75g-2496-mxpp
Warn: Project is vulnerable to: GHSA-hj48-42vr-x3v9
Warn: Project is vulnerable to: GHSA-9wv6-86v2-598j
Warn: Project is vulnerable to: GHSA-hrpp-h998-j3pp
Warn: Project is vulnerable to: GHSA-gcx4-mw62-g8wm
Warn: Project is vulnerable to: GHSA-c2qf-rxjj-qqgw
Warn: Project is vulnerable to: GHSA-4g88-fppr-53pp
Warn: Project is vulnerable to: GHSA-4jqc-8m5r-9rpr
Warn: Project is vulnerable to: GHSA-4rq4-32rv-6wp6
Warn: Project is vulnerable to: GHSA-64g7-mvw6-v9qj
Warn: Project is vulnerable to: GHSA-fxwf-4rqh-v8g3
Warn: Project is vulnerable to: GHSA-25hc-qcg6-38wj
Warn: Project is vulnerable to: GHSA-xfhh-g9f5-x4m4
Warn: Project is vulnerable to: GHSA-qm95-pgcg-qqfq
Warn: Project is vulnerable to: GHSA-cqmj-92xf-r6r9
Warn: Project is vulnerable to: GHSA-3jfq-g458-7qm9
Warn: Project is vulnerable to: GHSA-r628-mhmh-qjhw
Warn: Project is vulnerable to: GHSA-9r2w-394v-53qc
Warn: Project is vulnerable to: GHSA-5955-9wpr-37jh
Warn: Project is vulnerable to: GHSA-qq89-hq3f-393p
Warn: Project is vulnerable to: GHSA-f5x3-32g6-xq36
Warn: Project is vulnerable to: GHSA-7p7h-4mm5-852v
Warn: Project is vulnerable to: GHSA-38fc-wpqx-33j7
Warn: Project is vulnerable to: GHSA-mgfv-m47x-4wqp
Warn: Project is vulnerable to: GHSA-j8xg-fqg3-53r7
Warn: Project is vulnerable to: GHSA-5v72-xg48-5rpm
Warn: Project is vulnerable to: GHSA-72mh-269x-7mh5
Warn: Project is vulnerable to: GHSA-h4j5-c7cj-74xg
Warn: Project is vulnerable to: GHSA-c4w7-xm78-47vh
Warn: Project is vulnerable to: GHSA-c6rq-rjc2-86v2
Warn: Project is vulnerable to: GHSA-hr2v-3952-633q
Warn: Project is vulnerable to: GHSA-8r6j-v8pm-fqw3
Warn: Project is vulnerable to: MAL-2023-462
Warn: Project is vulnerable to: GHSA-44pw-h2cw-w3vq
Warn: Project is vulnerable to: GHSA-jp4x-w63m-7wgm
Warn: Project is vulnerable to: GHSA-c429-5p7v-vgjp
Warn: Project is vulnerable to: GHSA-896r-f27r-55mw
Warn: Project is vulnerable to: GHSA-6g33-f262-xjp4
Warn: Project is vulnerable to: GHSA-p8p7-x288-28g6
Warn: Project is vulnerable to: GHSA-72xf-g2v4-qvf3

Score

2.3

/10

Last Scanned on 2024-11-18

The Open Source Security Foundation is a cross-industry collaboration to improve the security of open source software (OSS). The Scorecard provides security health metrics for open source projects.

Learn More