Skip to content

Latest commit

 

History

History
263 lines (230 loc) · 6.38 KB

README.md

File metadata and controls

263 lines (230 loc) · 6.38 KB
Raw

React SEO

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."
      robots={['index', 'follow']}
      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',
        }
      }}
      alternateLinks={[
        { hreflang: 'en-CA', href: 'http://example.com/en-CA' },
        { hreflang: 'fr-CA', href: 'http://example.com/fr-CA' },
      ]}
    />
  </div>
);

export default MyModule;

🎛️ API

The interface for react-seo is denoted below:

SEO.propTypes = {
  children: oneOfType([
    arrayOf(node),
    node,
  ]),
  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),
  robots: arrayOf(string),
  locale: string,
  meta: arrayOf(object),
  siteUrl: string,
  alternateLinks: arrayOf(shape({
    hreflang: string,
    href: string,
  }))
};

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

🏆 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.