Skip to content

Commit

Permalink
feat: update some comments, add player and app as valid twitter card …
Browse files Browse the repository at this point in the history
…types
  • Loading branch information
TeemuKoivisto committed Sep 19, 2023
1 parent 46b43d0 commit c2e5740
Show file tree
Hide file tree
Showing 3 changed files with 21 additions and 16 deletions.
5 changes: 5 additions & 0 deletions .changeset/itchy-moons-teach.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
---
'react-seo-meta-tags': patch
---

feat: update some comments, add player and app as valid twitter card types
16 changes: 8 additions & 8 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -226,24 +226,24 @@ export interface TwitterProps {
*/
title?: string
/**
* Description of content (maximum 200 characters). Fallback: og:description.
* Description of content (max 200 characters). Fallback: og:description.
*/
description?: string | null
/**
* Twitter card image, optimal ratio 1.91:1. Recommended: 1200x628. PNG, JPEG, or GIF. Fallback: og:image.
* Twitter card image, optimal ratio 1.91:1. Recommended: 1200x628. PNG, JPEG, or GIF. Max 5 MB. Fallback: og:image.
*/
image?: string | null
/**
* Alt for the image. Fallback: og:image:alt.
* Alt for the image. Max 420 characters. Fallback: og:image:alt.
*/
imageAlt?: string | null
/**
* So since I saw that the large image looked dumb if you are using your faceshot as the image, I added the smaller 'summary'
* type as an option. It should be in 1:1 scale. Also there exists 'player' and 'app' types but since I'm not using those,
* I'm not going to spend my precious time figuring out how they work for now.
* So since I saw that the large image looked dumb if you are using your faceshot as the image, I started using the smaller
* 'summary' type. It should be in 1:1 scale. Also there exists 'player' and 'app' types that I haven't researched how
* they work.
* @default 'summary_large_image'
*/
cardType?: 'summary_large_image' | 'summary' | null
cardType?: 'summary_large_image' | 'summary' | 'player' | 'app' | null
/**
* @username of content creator.
*/
Expand All @@ -267,7 +267,7 @@ export interface BlogPostProps {
*/
title: string
/**
* Should be a short description about the topic, <=200 words. Mainly for SEO purposes.
* Should be a short description about the topic, max 200 words. Mainly for SEO purposes.
*/
description?: string | null
/**
Expand Down
16 changes: 8 additions & 8 deletions packages/react-seo-meta-tags/src/types.ts
Original file line number Diff line number Diff line change
Expand Up @@ -106,24 +106,24 @@ export interface TwitterProps {
*/
title?: string
/**
* Description of content (maximum 200 characters). Fallback: og:description.
* Description of content (max 200 characters). Fallback: og:description.
*/
description?: string | null
/**
* Twitter card image, optimal ratio 1.91:1. Recommended: 1200x628. PNG, JPEG, or GIF. Fallback: og:image.
* Twitter card image, optimal ratio 1.91:1. Recommended: 1200x628. PNG, JPEG, or GIF. Max 5 MB. Fallback: og:image.
*/
image?: string | null
/**
* Alt for the image. Fallback: og:image:alt.
* Alt for the image. Max 420 characters. Fallback: og:image:alt.
*/
imageAlt?: string | null
/**
* So since I saw that the large image looked dumb if you are using your faceshot as the image, I added the smaller 'summary'
* type as an option. It should be in 1:1 scale. Also there exists 'player' and 'app' types but since I'm not using those,
* I'm not going to spend my precious time figuring out how they work for now.
* So since I saw that the large image looked dumb if you are using your faceshot as the image, I started using the smaller
* 'summary' type. It should be in 1:1 scale. Also there exists 'player' and 'app' types that I haven't researched how
* they work.
* @default 'summary_large_image'
*/
cardType?: 'summary_large_image' | 'summary' | null
cardType?: 'summary_large_image' | 'summary' | 'player' | 'app' | null
/**
* @username of content creator.
*/
Expand All @@ -148,7 +148,7 @@ export interface BlogPostProps {
*/
title: string
/**
* Should be a short description about the topic, <=200 words. Mainly for SEO purposes.
* Should be a short description about the topic, max 200 words. Mainly for SEO purposes.
*/
description?: string | null
/**
Expand Down

0 comments on commit c2e5740

Please sign in to comment.