Commit 144aec75 authored by Maikel's avatar Maikel Committed by Janka Uryga

feat: facebook metadata (#65713)

Add support for the `fb:app_id` & `fb:admins` meta tag in the
generateMetaData function

---------
Co-authored-by: 's avatarSam Ko <sam@vercel.com>
Co-authored-by: 's avatarJiachi Liu <inbox@huozhi.im>
parent 26ddcdf2
......@@ -921,6 +921,51 @@ export const metadata = {
<meta name="category" content="technology" />
```
### `facebook`
You can connect a Facebook app or Facebook account to you webpage for certain Facebook Social Plugins [Facebook Documentation](https://developers.facebook.com/docs/plugins/comments/#moderation-setup-instructions)
> **Good to know**: You can specify either appId or admins, but not both.
```jsx filename="layout.js | page.js"
export const metadata = {
facebook: {
appId: '12345678',
},
}
```
```html filename="<head> output" hideLineNumbers
<meta property="fb:app_id" content="12345678" />
```
```jsx filename="layout.js | page.js"
export const metadata = {
facebook: {
admins: '12345678',
},
}
```
```html filename="<head> output" hideLineNumbers
<meta property="fb:admins" content="12345678" />
```
If you want to generate multiple fb:admins meta tags you can use array value.
```jsx filename="layout.js | page.js"
export const metadata = {
facebook: {
admins: ['12345678', '87654321'],
},
}
```
```html filename="<head> output" hideLineNumbers
<meta property="fb:admins" content="12345678" />
<meta property="fb:admins" content="87654321" />
```
### `other`
All metadata options should be covered using the built-in support. However, there may be custom metadata tags specific to your site, or brand new metadata tags just released. You can use the `other` option to render any custom metadata tag.
......
......@@ -47,6 +47,7 @@ export function createDefaultMetadata(): ResolvedMetadata {
appleWebApp: null,
formatDetection: null,
itunes: null,
facebook: null,
abstract: null,
appLinks: null,
archives: null,
......
......@@ -114,6 +114,23 @@ export function ItunesMeta({ itunes }: { itunes: ResolvedMetadata['itunes'] }) {
return <meta name="apple-itunes-app" content={content} />
}
export function FacebookMeta({
facebook,
}: {
facebook: ResolvedMetadata['facebook']
}) {
if (!facebook) return null
const { appId, admins } = facebook
return MetaFilter([
appId ? <meta property="fb:app_id" content={appId} /> : null,
...(admins
? admins.map((admin) => <meta property="fb:admins" content={admin} />)
: []),
])
}
const formatDetectionKeys = [
'telephone',
'date',
......
......@@ -13,6 +13,7 @@ import {
BasicMeta,
ViewportMeta,
VerificationMeta,
FacebookMeta,
} from './generate/basic'
import { AlternatesMetadata } from './generate/alternate'
import {
......@@ -130,6 +131,7 @@ export function createMetadataComponents({
BasicMeta({ metadata }),
AlternatesMetadata({ alternates: metadata.alternates }),
ItunesMeta({ itunes: metadata.itunes }),
FacebookMeta({ facebook: metadata.facebook }),
FormatDetectionMeta({ formatDetection: metadata.formatDetection }),
VerificationMeta({ verification: metadata.verification }),
AppleWebAppMeta({ appleWebApp: metadata.appleWebApp }),
......
......@@ -42,6 +42,7 @@ import {
resolveThemeColor,
resolveVerification,
resolveItunes,
resolveFacebook,
} from './resolvers/resolve-basics'
import { resolveIcons } from './resolvers/resolve-icons'
import { getTracer } from '../../server/lib/trace/tracer'
......@@ -200,6 +201,10 @@ function mergeMetadata({
)
break
}
case 'facebook':
target.facebook = resolveFacebook(source.facebook)
break
case 'verification':
target.verification = resolveVerification(source.verification)
break
......
......@@ -251,3 +251,11 @@ export const resolveItunes: FieldResolverExtraArgs<
: undefined,
}
}
export const resolveFacebook: FieldResolver<'facebook'> = (facebook) => {
if (!facebook) return null
return {
appId: facebook.appId,
admins: resolveAsArrayOrUndefined(facebook.admins),
}
}
......@@ -88,6 +88,20 @@ export type ResolvedAppleWebApp = {
statusBarStyle?: 'default' | 'black' | 'black-translucent'
}
export type Facebook = FacebookAppId | FacebookAdmins
export type FacebookAppId = {
appId: string
admins?: never
}
export type FacebookAdmins = {
appId?: never
admins: string | string[]
}
export type ResolvedFacebook = {
appId?: string
admins?: string[]
}
// Format Detection
// This is a poorly specified metadata export type that is supposed to
// control whether the device attempts to conver text that matches
......
......@@ -6,10 +6,12 @@ import type {
import type {
AppleWebApp,
AppLinks,
Facebook,
FormatDetection,
ItunesApp,
ResolvedAppleWebApp,
ResolvedAppLinks,
ResolvedFacebook,
ViewportLayout,
} from './extra-types'
import type {
......@@ -320,6 +322,25 @@ interface Metadata extends DeprecatedMetadataFields {
*/
twitter?: null | Twitter
/**
* The Facebook metadata for the document.
* You can specify either appId or admins, but not both.
* @example
* ```tsx
* { appId: "12345678" }
*
* <meta property="fb:app_id" content="12345678" />
* ```
*
* @example
* ```tsx
* { admins: ["12345678"] }
*
* <meta property="fb:admins" content="12345678" />
* ```
*/
facebook?: null | Facebook
/**
* The common verification tokens for the document.
* @example
......@@ -508,6 +529,8 @@ interface ResolvedMetadata extends DeprecatedMetadataFields {
twitter: null | ResolvedTwitterMetadata
facebook: null | ResolvedFacebook
// common verification tokens
verification: null | ResolvedVerification
......
export default function page() {
return 'facebook'
}
export async function generateMetadata() {
const metadata = {
facebook: {
appId: '12345678',
admins: ['120', '122', '124'],
},
}
return metadata
}
......@@ -299,6 +299,16 @@ describe('app dir - metadata', () => {
)
})
it('should support facebook related tags', async () => {
const browser = await next.browser('/facebook')
const matchMultiDom = createMultiDomMatcher(browser)
await matchMultiDom('meta', 'property', 'content', {
'fb:app_id': '12345678',
'fb:admins': ['120', '122', '124'],
})
})
it('should support alternate tags', async () => {
const browser = await next.browser('/alternates')
const matchDom = createDomMatcher(browser)
......
Markdown is supported
0% or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment