npm package discovery and stats viewer.

Discover Tips

  • General search

    [free text search, go nuts!]

  • Package details

    pkg:[package-name]

  • User packages

    @[username]

Sponsor

Optimize Toolset

I’ve always been into building performant and accessible sites, but lately I’ve been taking it extremely seriously. So much so that I’ve been building a tool to help me optimize and monitor the sites that I build to make sure that I’m making an attempt to offer the best experience to those who visit them. If you’re into performant, accessible and SEO friendly sites, you might like it too! You can check it out at Optimize Toolset.

About

Hi, 👋, I’m Ryan Hefner  and I built this site for me, and you! The goal of this site was to provide an easy way for me to check the stats on my npm packages, both for prioritizing issues and updates, and to give me a little kick in the pants to keep up on stuff.

As I was building it, I realized that I was actually using the tool to build the tool, and figured I might as well put this out there and hopefully others will find it to be a fast and useful way to search and browse npm packages as I have.

If you’re interested in other things I’m working on, follow me on Twitter or check out the open source projects I’ve been publishing on GitHub.

I am also working on a Twitter bot for this site to tweet the most popular, newest, random packages from npm. Please follow that account now and it will start sending out packages soon–ish.

Open Software & Tools

This site wouldn’t be possible without the immense generosity and tireless efforts from the people who make contributions to the world and share their work via open source initiatives. Thank you 🙏

© 2024 – Pkg Stats / Ryan Hefner

@americanexpress/react-seo

v1.4.2

Published

Simple SEO tag manager for React

Downloads

282

Readme

npm version Build Status

Simple SEO tag manager for React

👩‍💻 Hiring 👨‍💻

Want to get paid for your contributions to react-seo?

Send your resume to [email protected]

📖 Table of Contents

🤹‍ Usage

npm install @americanexpress/react-seo

Let's start with a minimal example of basic usage:

import React from 'react';
import SEO from '@americanexpress/react-seo';

const MyModule = () => (
  <div>
    <SEO
      title="Lorem Ipsum"
      description="Lorem ipsum sat delor."
      keywords={['foo', 'bar']}
      siteUrl="http://example.com"
      image={{
        src: 'http://example.com/foo.jpg'
      }}
    />
  </div>
);

export default MyModule;

This will result in the following tags being added to the head element:

<head>
  <title>Lorem Ipsum</title>
  <link rel="canonical" href="http://example.com">
  <meta property="og:url" content="http://example.com">
  <meta property="og:title" content="Lorem Ipsum">
  <meta property="og:description" content="Lorem ispum sat delor.">
  <meta property="og:image" content="http://example.com/foo.jpg">
  <meta name="twitter:card" content="summary">
  <meta name="twitter:title" content="Lorem Ipsum">
  <meta name="twitter:description" content="Lorem ispum sat delor.">
  <meta name="twitter:image" content="http://example.com/foo.jpg">
  <meta name="description" content="Lorem ispum sat delor.">
  <meta name="keywords" content="foo, bar">
</head>

Notice in the example above that the Open Graph and Twitter Card metadata is constructed from the title, description, and image props. To override these values or add additional tags not provided by default, you may use the openGraph and twitterCard props.

import React from 'react';
import SEO from '@americanexpress/react-seo';

const MyModule = () => (
  <div>
    <SEO
      title="Lorem Ipsum"
      description="Lorem ipsum sat delor."
      keywords={['foo', 'bar']}
      siteUrl="http://example.com"
      openGraph={{
        title: 'Facebook Lorem Ipsum',
        description: 'Facebook Lorem ipsum sat delor.',
        image: {
          src: 'http://example.com/facebook-foo.jpg',
          alt: 'Lorem ipsum',
        }
      }}
      twitterCard={{
        title: 'Twitter Lorem Ipsum',
        description: 'Twitter Lorem ipsum sat delor.',
        image: {
          src: 'http://example.com/twitter-foo.jpg',
          alt: 'Lorem ipsum',
        }
      }}
    />
  </div>
);

export default MyModule;

🎛️ API

The interface for react-seo is denoted below:

SEO.propTypes = {
  title: string,
  description: string,
  canonical: string,
  image: shape({
    src: string,
    secureUrl: string,
    type: string,
    width: number,
    height: number,
    alt: string,
  }),
  video: shape({
    src: string,
    secureUrl: string,
    type: string,
    width: number,
    height: number,
    alt: string,
  }),
  openGraph: shape({
    type: string,
    url: string,
    title: string,
    description: string,
    determiner: string,
    locale: string,
    localeAlternate: string,
    siteName: string,
    image: shape({
      src: string,
      secureUrl: string,
      type: string,
      width: number,
      height: number,
      alt: string,
    }),
    video: shape({
      src: string,
      secureUrl: string,
      type: string,
      width: number,
      height: number,
      alt: string,
    }),
    audio: shape({
      src: string,
      secureUrl: string,
      type: string,
    }),
  }),
  twitterCard: shape({
    card: string,
    title: string,
    description: string,
    image: shape({
      src: string,
      alt: string,
    }),
    site: string,
    siteId: string,
    creator: string,
    creatorId: string,
    app: shape({
      country: string,
      iphone: shape({
        id: string,
        url: string,
        name: string,
      }),
      ipad: shape({
        id: string,
        url: string,
        name: string,
      }),
      googlePlay: shape({
        id: string,
        url: string,
        name: string,
      }),
    }),
    player: shape({
      src: string,
      width: number,
      height: number,
    }),
  }),
  keywords: arrayOf(string),
  locale: string,
  meta: arrayOf(object),
  siteUrl: string,
};

SEO.defaultProps = {
  article: false,
  author: '',
  description: '',
  image: null,
  keywords: [],
  locale: 'en-US',
  meta: [],
  pathname: '',
  siteUrl: '',
  title: '',
  canonical: '',
};

🏆 Contributing

We welcome Your interest in the American Express Open Source Community on Github. Any Contributor to any Open Source Project managed by the American Express Open Source Community must accept and sign an Agreement indicating agreement to the terms below. Except for the rights granted in this Agreement to American Express and to recipients of software distributed by American Express, You reserve all right, title, and interest, if any, in and to Your Contributions. Please fill out the Agreement.

Please feel free to open pull requests and see CONTRIBUTING.md for commit formatting details.

🗝️ License

Any contributions made under this project will be governed by the Apache License 2.0.

🗣️ Code of Conduct

This project adheres to the American Express Community Guidelines. By participating, you are expected to honor these guidelines.