Unverified Commit 04547e81 authored by Jiachi Liu's avatar Jiachi Liu Committed by GitHub

Add theme color media support for metadata (#46502)

x-ref: https://developer.mozilla.org/en-US/docs/Web/HTML/Element/meta/name/theme-color

Resolves NEXT-525



## Feature

- [x] Implements an existing feature request or RFC. Make sure the feature request has been accepted for implementation before opening a PR.
- [x] Related issues linked using `fixes #number`
- [x] [e2e](https://github.com/vercel/next.js/blob/canary/contributing/core/testing.md#writing-tests-for-nextjs) tests added
- [ ] Documentation added
- [ ] Telemetry added. In case of a feature if it's used or not.
- [ ] Errors have a helpful link attached, see [`contributing.md`](https://github.com/vercel/next.js/blob/canary/contributing.md)
parent 16d7ffdd
...@@ -26,7 +26,16 @@ export function BasicMetadata({ metadata }: { metadata: ResolvedMetadata }) { ...@@ -26,7 +26,16 @@ export function BasicMetadata({ metadata }: { metadata: ResolvedMetadata }) {
<Meta name="generator" content={metadata.generator} /> <Meta name="generator" content={metadata.generator} />
<Meta name="keywords" content={metadata.keywords?.join(',')} /> <Meta name="keywords" content={metadata.keywords?.join(',')} />
<Meta name="referrer" content={metadata.referrer} /> <Meta name="referrer" content={metadata.referrer} />
<Meta name="theme-color" content={metadata.themeColor} /> {metadata.themeColor
? metadata.themeColor.map((themeColor, index) => (
<Meta
key={index}
name="theme-color"
content={themeColor.color}
media={themeColor.media}
/>
))
: null}
<Meta name="color-scheme" content={metadata.colorScheme} /> <Meta name="color-scheme" content={metadata.colorScheme} />
<Meta name="viewport" content={metadata.viewport} /> <Meta name="viewport" content={metadata.viewport} />
<Meta name="creator" content={metadata.creator} /> <Meta name="creator" content={metadata.creator} />
......
...@@ -4,15 +4,18 @@ export function Meta({ ...@@ -4,15 +4,18 @@ export function Meta({
name, name,
property, property,
content, content,
media,
}: { }: {
name?: string name?: string
property?: string property?: string
media?: string
content: string | number | URL | null | undefined content: string | number | URL | null | undefined
}): React.ReactElement | null { }): React.ReactElement | null {
if (typeof content !== 'undefined' && content !== null && content !== '') { if (typeof content !== 'undefined' && content !== null && content !== '') {
return ( return (
<meta <meta
{...(name ? { name } : { property })} {...(name ? { name } : { property })}
{...(media ? { media } : undefined)}
content={typeof content === 'string' ? content : content.toString()} content={typeof content === 'string' ? content : content.toString()}
/> />
) )
......
export function resolveAsArrayOrUndefined< function resolveAsArrayOrUndefined<T extends unknown | readonly unknown[]>(
T extends unknown | readonly unknown[] value: T | T[] | undefined | null
>(value: T | T[] | undefined | null): undefined | T[] { ): undefined | T[] {
if (typeof value === 'undefined' || value === null) { if (typeof value === 'undefined' || value === null) {
return undefined return undefined
} }
...@@ -9,3 +9,5 @@ export function resolveAsArrayOrUndefined< ...@@ -9,3 +9,5 @@ export function resolveAsArrayOrUndefined<
} }
return [value] return [value]
} }
export { resolveAsArrayOrUndefined }
...@@ -54,49 +54,49 @@ describe('accumulateMetadata', () => { ...@@ -54,49 +54,49 @@ describe('accumulateMetadata', () => {
it('should convert string or URL images field to array, not only for basic og type', async () => { it('should convert string or URL images field to array, not only for basic og type', async () => {
const items: [Metadata[], Metadata][] = [ const items: [Metadata[], Metadata][] = [
[ [
[{ openGraph: { type: 'article', images: 'https://test.com' } }], [{ openGraph: { type: 'article', images: 'https://test1.com' } }],
{ openGraph: { images: ['https://test.com'] } }, { openGraph: { images: [{ url: 'https://test1.com' }] } },
], ],
[ [
[{ openGraph: { type: 'book', images: 'https://test.com' } }], [{ openGraph: { type: 'book', images: 'https://test2.com' } }],
{ openGraph: { images: ['https://test.com'] } }, { openGraph: { images: [{ url: 'https://test2.com' }] } },
], ],
[ [
[ [
{ {
openGraph: { openGraph: {
type: 'music.song', type: 'music.song',
images: new URL('https://test.com'), images: new URL('https://test3.com'),
}, },
}, },
], ],
{ openGraph: { images: [new URL('https://test.com')] } }, { openGraph: { images: [new URL('https://test3.com')] } },
], ],
[ [
[ [
{ {
openGraph: { openGraph: {
type: 'music.playlist', type: 'music.playlist',
images: { url: 'https://test.com' }, images: { url: 'https://test4.com' },
}, },
}, },
], ],
{ openGraph: { images: [{ url: 'https://test.com' }] } }, { openGraph: { images: [{ url: 'https://test4.com' }] } },
], ],
[ [
[ [
{ {
openGraph: { openGraph: {
type: 'music.radio_station', type: 'music.radio_station',
images: 'https://test.com', images: 'https://test5.com',
}, },
}, },
], ],
{ openGraph: { images: ['https://test.com'] } }, { openGraph: { images: [{ url: 'https://test5.com' }] } },
], ],
[ [
[{ openGraph: { type: 'video.movie', images: 'https://test.com' } }], [{ openGraph: { type: 'video.movie', images: 'https://test6.com' } }],
{ openGraph: { images: ['https://test.com'] } }, { openGraph: { images: [{ url: 'https://test6.com' }] } },
], ],
] ]
...@@ -109,4 +109,64 @@ describe('accumulateMetadata', () => { ...@@ -109,4 +109,64 @@ describe('accumulateMetadata', () => {
}) })
}) })
}) })
describe('themeColor', () => {
it('should support string theme color', async () => {
const metadataItems: MetadataItems = [
[{ themeColor: '#000' }, null],
[{ themeColor: '#fff' }, null],
]
const metadata = await accumulateMetadata(metadataItems)
console.log('xxmetadata', metadata.themeColor)
expect(metadata).toMatchObject({
themeColor: [{ color: '#fff' }],
})
})
it('should support theme color descriptors', async () => {
const metadataItems1: MetadataItems = [
[
{
themeColor: {
media: '(prefers-color-scheme: light)',
color: '#fff',
},
},
null,
],
[
{
themeColor: {
media: '(prefers-color-scheme: dark)',
color: 'cyan',
},
},
null,
],
]
const metadata1 = await accumulateMetadata(metadataItems1)
expect(metadata1).toMatchObject({
themeColor: [{ media: '(prefers-color-scheme: dark)', color: 'cyan' }],
})
const metadataItems2: MetadataItems = [
[
{
themeColor: [
{ media: '(prefers-color-scheme: light)', color: '#fff' },
{ media: '(prefers-color-scheme: dark)', color: 'cyan' },
],
},
null,
],
]
const metadata2 = await accumulateMetadata(metadataItems2)
expect(metadata2).toMatchObject({
themeColor: [
{ media: '(prefers-color-scheme: light)', color: '#fff' },
{ media: '(prefers-color-scheme: dark)', color: 'cyan' },
],
})
})
})
}) })
...@@ -20,6 +20,7 @@ import { ...@@ -20,6 +20,7 @@ import {
resolveAppleWebApp, resolveAppleWebApp,
resolveAppLinks, resolveAppLinks,
resolveRobots, resolveRobots,
resolveThemeColor,
resolveVerification, resolveVerification,
resolveViewport, resolveViewport,
} from './resolvers/resolve-basics' } from './resolvers/resolve-basics'
...@@ -135,6 +136,10 @@ function merge( ...@@ -135,6 +136,10 @@ function merge(
target.robots = resolveRobots(source.robots) target.robots = resolveRobots(source.robots)
break break
} }
case 'themeColor': {
target.themeColor = resolveThemeColor(source.themeColor)
break
}
case 'archives': case 'archives':
case 'assets': case 'assets':
case 'bookmarks': case 'bookmarks':
...@@ -149,7 +154,6 @@ function merge( ...@@ -149,7 +154,6 @@ function merge(
case 'applicationName': case 'applicationName':
case 'description': case 'description':
case 'generator': case 'generator':
case 'themeColor':
case 'creator': case 'creator':
case 'publisher': case 'publisher':
case 'category': case 'category':
......
...@@ -18,6 +18,23 @@ const viewPortKeys = { ...@@ -18,6 +18,23 @@ const viewPortKeys = {
viewportFit: 'viewport-fit', viewportFit: 'viewport-fit',
} as const } as const
export const resolveThemeColor: FieldResolver<'themeColor'> = (themeColor) => {
if (!themeColor) return null
const themeColorDescriptors: ResolvedMetadata['themeColor'] = []
resolveAsArrayOrUndefined(themeColor)?.forEach((descriptor) => {
if (typeof descriptor === 'string')
themeColorDescriptors.push({ color: descriptor })
else if (typeof descriptor === 'object')
themeColorDescriptors.push({
color: descriptor.color,
media: descriptor.media,
})
})
return themeColorDescriptors
}
export const resolveViewport: FieldResolver<'viewport'> = (viewport) => { export const resolveViewport: FieldResolver<'viewport'> = (viewport) => {
let resolved: ResolvedMetadata['viewport'] = null let resolved: ResolvedMetadata['viewport'] = null
...@@ -133,14 +150,16 @@ export const resolveAppleWebApp: FieldResolver<'appleWebApp'> = (appWebApp) => { ...@@ -133,14 +150,16 @@ export const resolveAppleWebApp: FieldResolver<'appleWebApp'> = (appWebApp) => {
} }
} }
const startupImages = resolveAsArrayOrUndefined(appWebApp.startupImage)?.map( const startupImages = appWebApp.startupImage
(item) => (typeof item === 'string' ? { url: item } : item) ? resolveAsArrayOrUndefined(appWebApp.startupImage)?.map((item) =>
) typeof item === 'string' ? { url: item } : item
)
: null
return { return {
capable: 'capable' in appWebApp ? !!appWebApp.capable : true, capable: 'capable' in appWebApp ? !!appWebApp.capable : true,
title: appWebApp.title || null, title: appWebApp.title || null,
startupImage: startupImages || null, startupImage: startupImages,
statusBarStyle: appWebApp.statusBarStyle || 'default', statusBarStyle: appWebApp.statusBarStyle || 'default',
} }
} }
......
...@@ -26,6 +26,7 @@ import type { ...@@ -26,6 +26,7 @@ import type {
ResolvedRobots, ResolvedRobots,
TemplateString, TemplateString,
Verification, Verification,
ThemeColorDescriptor,
} from './metadata-types' } from './metadata-types'
import type { OpenGraph, ResolvedOpenGraph } from './opengraph-types' import type { OpenGraph, ResolvedOpenGraph } from './opengraph-types'
import type { ResolvedTwitterMetadata, Twitter } from './twitter-types' import type { ResolvedTwitterMetadata, Twitter } from './twitter-types'
...@@ -131,9 +132,19 @@ interface Metadata extends DeprecatedMetadataFields { ...@@ -131,9 +132,19 @@ interface Metadata extends DeprecatedMetadataFields {
* ```tsx * ```tsx
* "#000000" * "#000000"
* <meta name="theme-color" content="#000000" /> * <meta name="theme-color" content="#000000" />
*
* { media: "(prefers-color-scheme: dark)", color: "#000000" }
* <meta name="theme-color" media="(prefers-color-scheme: dark)" content="#000000" />
*
* [
* { media: "(prefers-color-scheme: dark)", color: "#000000" },
* { media: "(prefers-color-scheme: light)", color: "#ffffff" }
* ]
* <meta name="theme-color" media="(prefers-color-scheme: dark)" content="#000000" />
* <meta name="theme-color" media="(prefers-color-scheme: light)" content="#ffffff" />
* ``` * ```
*/ */
themeColor?: null | string themeColor?: null | string | ThemeColorDescriptor | ThemeColorDescriptor[]
/** /**
* The color scheme for the document. * The color scheme for the document.
...@@ -444,7 +455,7 @@ interface ResolvedMetadata extends DeprecatedMetadataFields { ...@@ -444,7 +455,7 @@ interface ResolvedMetadata extends DeprecatedMetadataFields {
// if you provide an array it will be flattened into a single tag with comma separation // if you provide an array it will be flattened into a single tag with comma separation
keywords: null | Array<string> keywords: null | Array<string>
referrer: null | ReferrerEnum referrer: null | ReferrerEnum
themeColor: null | string themeColor: null | ThemeColorDescriptor[]
colorScheme: null | ColorSchemeEnum colorScheme: null | ColorSchemeEnum
viewport: null | string viewport: null | string
creator: null | string creator: null | string
......
...@@ -150,3 +150,8 @@ export type ResolvedIcons = { ...@@ -150,3 +150,8 @@ export type ResolvedIcons = {
shortcut?: IconDescriptor[] shortcut?: IconDescriptor[]
other?: IconDescriptor[] other?: IconDescriptor[]
} }
export type ThemeColorDescriptor = {
color: string
media?: string
}
...@@ -21,7 +21,7 @@ export const metadata: Metadata = { ...@@ -21,7 +21,7 @@ export const metadata: Metadata = {
referrer: 'origin-when-cross-origin', referrer: 'origin-when-cross-origin',
keywords: ['next.js', 'react', 'javascript'], keywords: ['next.js', 'react', 'javascript'],
authors: [{ name: 'huozhi' }, { name: 'tree', url: 'https://tree.com' }], authors: [{ name: 'huozhi' }, { name: 'tree', url: 'https://tree.com' }],
themeColor: 'cyan', themeColor: { color: 'cyan', media: '(prefers-color-scheme: dark)' },
colorScheme: 'dark', colorScheme: 'dark',
manifest: 'https://github.com/manifest.json', manifest: 'https://github.com/manifest.json',
viewport: 'width=device-width, initial-scale=1, shrink-to-fit=no', viewport: 'width=device-width, initial-scale=1, shrink-to-fit=no',
......
...@@ -126,7 +126,17 @@ createNextDescribe( ...@@ -126,7 +126,17 @@ createNextDescribe(
) )
await checkMetaNameContentPair(browser, 'author', ['huozhi', 'tree']) await checkMetaNameContentPair(browser, 'author', ['huozhi', 'tree'])
await checkLink(browser, 'author', 'https://tree.com') await checkLink(browser, 'author', 'https://tree.com')
await checkMetaNameContentPair(browser, 'theme-color', 'cyan')
await checkMeta(browser, 'theme-color', 'cyan', 'name')
await checkMeta(
browser,
'theme-color',
'(prefers-color-scheme: dark)',
'name',
'meta',
'media'
)
await checkMetaNameContentPair(browser, 'color-scheme', 'dark') await checkMetaNameContentPair(browser, 'color-scheme', 'dark')
await checkMetaNameContentPair( await checkMetaNameContentPair(
browser, 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