Merge pull request #12 from americanexpress/feature/canonical

feat(canonical): add custom canonical url
americanexpress · May 5, 2020 · 8503653 · 8503653
2 parents e93f16f + e232103
commit 8503653
Show file tree

Hide file tree

Showing 4 changed files with 15 additions and 2 deletions.
diff --git a/README.md b/README.md
@@ -65,6 +65,7 @@ SEO.propTypes = {
   pathname: PropTypes.string,
   siteUrl: PropTypes.string,
   title: PropTypes.string,
+  canonical: PropTypes.string,
 };
 
 SEO.defaultProps = {
@@ -78,6 +79,7 @@ SEO.defaultProps = {
   pathname: '',
   siteUrl: '',
   title: '',
+  canonical: '',
 };
 ```
 

diff --git a/__tests__/__snapshots__/index.spec.jsx.snap b/__tests__/__snapshots__/index.spec.jsx.snap
@@ -241,7 +241,14 @@ exports[`SEO should render the snapshot correctly 1`] = `
       "lang": "en-US",
     }
   }
-  link={Array []}
+  link={
+    Array [
+      Object {
+        "href": "https://example.com/foo/bar",
+        "rel": "canonical",
+      },
+    ]
+  }
   meta={
     Array [
       Object {

diff --git a/__tests__/index.spec.jsx b/__tests__/index.spec.jsx
@@ -27,6 +27,7 @@ describe('SEO', () => {
         keywords={['foo', 'bar']}
         siteUrl="https://example.com"
         title="Lorem Ipsum"
+        canonical="https://example.com/foo/bar"
       />
     );
     expect(component).toMatchSnapshot();

diff --git a/src/index.jsx b/src/index.jsx
@@ -28,10 +28,11 @@ const SEO = ({
   pathname,
   siteUrl,
   title,
+  canonical: canonicalTag,
 }) => {
   const image = metaImage && metaImage.src ? `${siteUrl}${metaImage.src}` : null;
 
-  const canonical = pathname ? `${siteUrl}${pathname}` : null;
+  const canonical = canonicalTag || (pathname ? `${siteUrl}${pathname}` : null);
 
   const link = canonical ? [{ rel: 'canonical', href: canonical }] : [];
 
@@ -126,6 +127,7 @@ SEO.propTypes = {
   pathname: PropTypes.string,
   siteUrl: PropTypes.string,
   title: PropTypes.string,
+  canonical: PropTypes.string,
 };
 
 SEO.defaultProps = {
@@ -140,6 +142,7 @@ SEO.defaultProps = {
   pathname: '',
   siteUrl: '',
   title: '',
+  canonical: '',
 };
 
 export default SEO;