Unverified Commit a301eb6a authored by Jiachi Liu's avatar Jiachi Liu Committed by GitHub

Viewport exports (#57302)

## Story Time

Metadata API introduced two exports `metadata` and `generateMetadata` to the pages and layouts under app router, as partial prerendering work is going on and people are desiring to render the metadata asynchronizly, this change will be the preparation for moving to the dynamic & asynchronized land. In short, if we can render the metadata asynchronizedly, it will benefit the performance of the initial page loading and client page transiation a lot. Any slow data fetching can be handled while the essential page "shell" is rendered. 

For meta tags, there're few ones will visually affect your web page, such as `<meta name="viewport">`, `<meta name="theme color">` and `<meta name="color-scheme">`, rendering them lately after the page frame is ready might bring flickering to the page such as revreting whole page's theme color or shaking due to viewport updates. Those meta are not majorly the "metadata" for SEO, but more for user experience when opening the page. If we're rendering everything as async meta tags, it won't be ideal due to the flickering on your web pages.

## Solution Preparation 

We'll want to render the meta tags separately to make sure the visual ones are rendered as blocking along with web page, and then the ones for SEO or bots can be flushed later by later, like a suspense boundary keeps emitting them into the head of html. 

We optionally picked up 3 meta tag "viewport", "theme-color" and "color-scheme" to be render first into the web page with html "shell", to guarantee the layout viewport and basic styling are rendered first.

This PR introduced two module export in the page and layout files: `viewport` and `generateViewport`, in order to separate the visual meta tags from the SEO metadata.

### API

```ts
// page.js | layout.js
export const viewport = {
  // viewport meta tag
  width: 'device-width',
  initialScale: 1,
  maximumScale: 1,
  interactiveWidget: 'resizes-visual',
  // visual meta tags
  colorScheme: 'dark',
  themeColor: { color: 'cyan', media: '(prefers-color-scheme: dark)' },
}
```

There's also a dynamic API like what we did for metadata API

```ts
// page.js | layout.js
export function generateViewport() {
   return { ... }
}
```

## Notice 

This PR won't get SEO metadata rendered asyncronizedly, instead it's a preparation for the later work in partial prerendering and async metadata. We'll encourage the Next.js community moving to the new metadata viewport API if you're customzing those 3 meta tags. Usually you don't have to change viewport itself, so mostly like only theme-color and color-scheme could relate to it.
parent 18fe1eb4
...@@ -49,7 +49,7 @@ import * as entry from '${relativePath}.js' ...@@ -49,7 +49,7 @@ import * as entry from '${relativePath}.js'
${ ${
options.type === 'route' options.type === 'route'
? `import type { NextRequest } from 'next/server.js'` ? `import type { NextRequest } from 'next/server.js'`
: `import type { ResolvingMetadata } from 'next/dist/lib/metadata/types/metadata-interface.js'` : `import type { ResolvingMetadata, ResolvingViewport } from 'next/dist/lib/metadata/types/metadata-interface.js'`
} }
type TEntry = typeof import('${relativePath}.js') type TEntry = typeof import('${relativePath}.js')
...@@ -76,6 +76,8 @@ checkFields<Diff<{ ...@@ -76,6 +76,8 @@ checkFields<Diff<{
: ` : `
metadata?: any metadata?: any
generateMetadata?: Function generateMetadata?: Function
viewport?: any
generateViewport?: Function
` `
} }
}, TEntry, ''>>() }, TEntry, ''>>()
...@@ -141,6 +143,14 @@ if ('generateMetadata' in entry) { ...@@ -141,6 +143,14 @@ if ('generateMetadata' in entry) {
}, FirstArg<MaybeField<TEntry, 'generateMetadata'>>, 'generateMetadata'>>() }, FirstArg<MaybeField<TEntry, 'generateMetadata'>>, 'generateMetadata'>>()
checkFields<Diff<ResolvingMetadata, SecondArg<MaybeField<TEntry, 'generateMetadata'>>, 'generateMetadata'>>() checkFields<Diff<ResolvingMetadata, SecondArg<MaybeField<TEntry, 'generateMetadata'>>, 'generateMetadata'>>()
} }
// Check the arguments and return type of the generateViewport function
if ('generateViewport' in entry) {
checkFields<Diff<${
options.type === 'page' ? 'PageProps' : 'LayoutProps'
}, FirstArg<MaybeField<TEntry, 'generateViewport'>>, 'generateViewport'>>()
checkFields<Diff<ResolvingViewport, SecondArg<MaybeField<TEntry, 'generateViewport'>>, 'generateViewport'>>()
}
` `
} }
// Check the arguments and return type of the generateStaticParams function // Check the arguments and return type of the generateStaticParams function
......
import type { Viewport } from './types/extra-types' import type { ViewportLayout } from './types/extra-types'
import type { Icons } from './types/metadata-types' import type { Icons } from './types/metadata-types'
export const ViewPortKeys: { [k in keyof Viewport]: string } = { export const ViewportMetaKeys: { [k in keyof ViewportLayout]: string } = {
width: 'width', width: 'width',
height: 'height', height: 'height',
initialScale: 'initial-scale', initialScale: 'initial-scale',
......
import type { ResolvedMetadata } from './types/metadata-interface' import type {
ResolvedMetadata,
ResolvedViewport,
} from './types/metadata-interface'
export function createDefaultViewport(): ResolvedViewport {
return {
// name=viewport
width: 'device-width',
initialScale: 1,
// visual metadata
themeColor: null,
colorScheme: null,
}
}
export function createDefaultMetadata(): ResolvedMetadata { export function createDefaultMetadata(): ResolvedMetadata {
return { return {
viewport: 'width=device-width, initial-scale=1', // Deprecated ones
metadataBase: null, viewport: null,
themeColor: null,
colorScheme: null,
metadataBase: null,
// Other values are all null // Other values are all null
title: null, title: null,
description: null, description: null,
...@@ -13,8 +30,6 @@ export function createDefaultMetadata(): ResolvedMetadata { ...@@ -13,8 +30,6 @@ export function createDefaultMetadata(): ResolvedMetadata {
generator: null, generator: null,
keywords: null, keywords: null,
referrer: null, referrer: null,
themeColor: null,
colorScheme: null,
creator: null, creator: null,
publisher: null, publisher: null,
robots: null, robots: null,
......
import type { ResolvedMetadata } from '../types/metadata-interface' import type {
ResolvedMetadata,
ResolvedViewport,
Viewport,
} from '../types/metadata-interface'
import type { ViewportLayout } from '../types/extra-types'
import React from 'react' import React from 'react'
import { Meta, MetaFilter, MultiMeta } from './meta' import { Meta, MetaFilter, MultiMeta } from './meta'
import { ViewportMetaKeys } from '../constants'
export function BasicMetadata({ metadata }: { metadata: ResolvedMetadata }) { // convert viewport object to string for viewport meta tag
function resolveViewportLayout(viewport: Viewport) {
let resolved: string | null = null
if (viewport && typeof viewport === 'object') {
resolved = ''
for (const viewportKey_ in ViewportMetaKeys) {
const viewportKey = viewportKey_ as keyof ViewportLayout
if (viewportKey in viewport) {
let value = viewport[viewportKey]
if (typeof value === 'boolean') value = value ? 'yes' : 'no'
if (resolved) resolved += ', '
resolved += `${ViewportMetaKeys[viewportKey]}=${value}`
}
}
}
return resolved
}
export function ViewportMeta({ viewport }: { viewport: ResolvedViewport }) {
return MetaFilter([
Meta({ name: 'viewport', content: resolveViewportLayout(viewport) }),
...(viewport.themeColor
? viewport.themeColor.map((themeColor) =>
Meta({
name: 'theme-color',
content: themeColor.color,
media: themeColor.media,
})
)
: []),
Meta({ name: 'color-scheme', content: viewport.colorScheme }),
])
}
export function BasicMeta({ metadata }: { metadata: ResolvedMetadata }) {
return MetaFilter([ return MetaFilter([
<meta charSet="utf-8" />, <meta charSet="utf-8" />,
metadata.title !== null && metadata.title.absolute ? ( metadata.title !== null && metadata.title.absolute ? (
...@@ -25,17 +66,6 @@ export function BasicMetadata({ metadata }: { metadata: ResolvedMetadata }) { ...@@ -25,17 +66,6 @@ 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 }),
...(metadata.themeColor
? metadata.themeColor.map((themeColor) =>
Meta({
name: 'theme-color',
content: themeColor.color,
media: themeColor.media,
})
)
: []),
Meta({ name: 'color-scheme', content: metadata.colorScheme }),
Meta({ name: 'viewport', content: metadata.viewport }),
Meta({ name: 'creator', content: metadata.creator }), Meta({ name: 'creator', content: metadata.creator }),
Meta({ name: 'publisher', content: metadata.publisher }), Meta({ name: 'publisher', content: metadata.publisher }),
Meta({ name: 'robots', content: metadata.robots?.basic }), Meta({ name: 'robots', content: metadata.robots?.basic }),
......
...@@ -6,7 +6,8 @@ import { ...@@ -6,7 +6,8 @@ import {
AppleWebAppMeta, AppleWebAppMeta,
FormatDetectionMeta, FormatDetectionMeta,
ItunesMeta, ItunesMeta,
BasicMetadata, BasicMeta,
ViewportMeta,
VerificationMeta, VerificationMeta,
} from './generate/basic' } from './generate/basic'
import { AlternatesMetadata } from './generate/alternate' import { AlternatesMetadata } from './generate/alternate'
...@@ -18,8 +19,14 @@ import { ...@@ -18,8 +19,14 @@ import {
import { IconsMetadata } from './generate/icons' import { IconsMetadata } from './generate/icons'
import { resolveMetadata } from './resolve-metadata' import { resolveMetadata } from './resolve-metadata'
import { MetaFilter } from './generate/meta' import { MetaFilter } from './generate/meta'
import type { ResolvedMetadata } from './types/metadata-interface' import type {
import { createDefaultMetadata } from './default-metadata' ResolvedMetadata,
ResolvedViewport,
} from './types/metadata-interface'
import {
createDefaultMetadata,
createDefaultViewport,
} from './default-metadata'
import { isNotFoundError } from '../../client/components/not-found' import { isNotFoundError } from '../../client/components/not-found'
// Use a promise to share the status of the metadata resolving, // Use a promise to share the status of the metadata resolving,
...@@ -55,22 +62,26 @@ export function createMetadataComponents({ ...@@ -55,22 +62,26 @@ export function createMetadataComponents({
async function MetadataTree() { async function MetadataTree() {
const defaultMetadata = createDefaultMetadata() const defaultMetadata = createDefaultMetadata()
const defaultViewport = createDefaultViewport()
let metadata: ResolvedMetadata | undefined = defaultMetadata let metadata: ResolvedMetadata | undefined = defaultMetadata
let viewport: ResolvedViewport | undefined = defaultViewport
let error: any let error: any
const errorMetadataItem: [null, null] = [null, null] const errorMetadataItem: [null, null, null] = [null, null, null]
const errorConvention = errorType === 'redirect' ? undefined : errorType const errorConvention = errorType === 'redirect' ? undefined : errorType
const [resolvedMetadata, resolvedError] = await resolveMetadata({ const [resolvedError, resolvedMetadata, resolvedViewport] =
tree, await resolveMetadata({
parentParams: {}, tree,
metadataItems: [], parentParams: {},
errorMetadataItem, metadataItems: [],
searchParams, errorMetadataItem,
getDynamicParamFromSegment, searchParams,
errorConvention, getDynamicParamFromSegment,
metadataContext, errorConvention,
}) metadataContext,
})
if (!resolvedError) { if (!resolvedError) {
viewport = resolvedViewport
metadata = resolvedMetadata metadata = resolvedMetadata
resolve(undefined) resolve(undefined)
} else { } else {
...@@ -79,8 +90,8 @@ export function createMetadataComponents({ ...@@ -79,8 +90,8 @@ export function createMetadataComponents({
// They'll be saved for flight data, when hydrates, it will replaces the SSR'd metadata with this. // They'll be saved for flight data, when hydrates, it will replaces the SSR'd metadata with this.
// for not-found error: resolve not-found metadata // for not-found error: resolve not-found metadata
if (!errorType && isNotFoundError(resolvedError)) { if (!errorType && isNotFoundError(resolvedError)) {
const [notFoundMetadata, notFoundMetadataError] = await resolveMetadata( const [notFoundMetadataError, notFoundMetadata, notFoundViewport] =
{ await resolveMetadata({
tree, tree,
parentParams: {}, parentParams: {},
metadataItems: [], metadataItems: [],
...@@ -89,8 +100,8 @@ export function createMetadataComponents({ ...@@ -89,8 +100,8 @@ export function createMetadataComponents({
getDynamicParamFromSegment, getDynamicParamFromSegment,
errorConvention: 'not-found', errorConvention: 'not-found',
metadataContext, metadataContext,
} })
) viewport = notFoundViewport
metadata = notFoundMetadata metadata = notFoundMetadata
error = notFoundMetadataError || error error = notFoundMetadataError || error
} }
...@@ -98,7 +109,8 @@ export function createMetadataComponents({ ...@@ -98,7 +109,8 @@ export function createMetadataComponents({
} }
const elements = MetaFilter([ const elements = MetaFilter([
BasicMetadata({ metadata }), ViewportMeta({ viewport: viewport }),
BasicMeta({ metadata }),
AlternatesMetadata({ alternates: metadata.alternates }), AlternatesMetadata({ alternates: metadata.alternates }),
ItunesMeta({ itunes: metadata.itunes }), ItunesMeta({ itunes: metadata.itunes }),
FormatDetectionMeta({ formatDetection: metadata.formatDetection }), FormatDetectionMeta({ formatDetection: metadata.formatDetection }),
......
import { accumulateMetadata as originAccumulateMetadata } from './resolve-metadata' import {
import type { MetadataItems } from './resolve-metadata' accumulateViewport as originAccumulateViewport,
import type { Metadata } from './types/metadata-interface' accumulateMetadata as originAccumulateMetadata,
} from './resolve-metadata'
import type { MetadataItems as FullMetadataItems } from './resolve-metadata'
import type { Metadata, Viewport } from './types/metadata-interface'
type FullMetadataItem = FullMetadataItems[number]
type MetadataItems = [FullMetadataItem[0], FullMetadataItem[1]][]
function accumulateMetadata(metadataItems: MetadataItems) { function accumulateMetadata(metadataItems: MetadataItems) {
return originAccumulateMetadata(metadataItems, { const fullMetadataItems: FullMetadataItems = metadataItems.map((item) => [
item[0],
item[1],
null,
])
return originAccumulateMetadata(fullMetadataItems, {
pathname: '/test', pathname: '/test',
}) })
} }
function accumulateViewport(viewportExports: Viewport[]) {
// skip the first two arguments (metadata and static metadata)
return originAccumulateViewport(
viewportExports.map((item) => [null, null, item])
)
}
function mapUrlsToStrings(obj: any) { function mapUrlsToStrings(obj: any) {
if (typeof obj === 'object') { if (typeof obj === 'object') {
for (const key in obj) { for (const key in obj) {
...@@ -445,105 +463,6 @@ describe('accumulateMetadata', () => { ...@@ -445,105 +463,6 @@ 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)
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' },
],
})
})
})
describe('viewport', () => {
it('should support string viewport', async () => {
const metadataItems: MetadataItems = [
[
{ viewport: 'width=device-width, initial-scale=1, shrink-to-fit=no' },
null,
],
]
const metadata = await accumulateMetadata(metadataItems)
expect(metadata).toMatchObject({
viewport: 'width=device-width, initial-scale=1, shrink-to-fit=no',
})
})
it('should support viewport descriptors', async () => {
const metadataItems: MetadataItems = [
[
{
viewport: {
width: 'device-width',
height: 'device-height',
initialScale: 1,
minimumScale: 1,
maximumScale: 1,
viewportFit: 'cover',
userScalable: false,
interactiveWidget: 'overlays-content',
},
},
null,
],
]
const metadata = await accumulateMetadata(metadataItems)
expect(metadata).toMatchObject({
viewport:
'width=device-width, height=device-height, initial-scale=1, minimum-scale=1, maximum-scale=1, viewport-fit=cover, user-scalable=no, interactive-widget=overlays-content',
})
})
})
describe('alternate', () => { describe('alternate', () => {
it('should support string alternate', async () => { it('should support string alternate', async () => {
const metadataItems: MetadataItems = [ const metadataItems: MetadataItems = [
...@@ -632,3 +551,83 @@ describe('accumulateMetadata', () => { ...@@ -632,3 +551,83 @@ describe('accumulateMetadata', () => {
}) })
}) })
}) })
describe('accumulateViewport', () => {
describe('viewport', () => {
it('should support viewport descriptors', async () => {
const viewport = await accumulateViewport([
{
width: 'device-width',
height: 'device-height',
initialScale: 1,
minimumScale: 1,
maximumScale: 1,
viewportFit: 'cover',
userScalable: false,
interactiveWidget: 'overlays-content',
},
])
expect(viewport).toMatchObject({
width: 'device-width',
height: 'device-height',
initialScale: 1,
minimumScale: 1,
maximumScale: 1,
viewportFit: 'cover',
userScalable: false,
interactiveWidget: 'overlays-content',
})
})
})
describe('themeColor', () => {
it('should support string theme color', async () => {
const metadataItems: Viewport[] = [
{ themeColor: '#000' },
{ themeColor: '#fff' },
]
const viewport = await accumulateViewport(metadataItems)
expect(viewport).toMatchObject({
themeColor: [{ color: '#fff' }],
})
})
it('should support theme color descriptors', async () => {
const viewportInput1: Viewport[] = [
{
themeColor: {
media: '(prefers-color-scheme: light)',
color: '#fff',
},
},
{
themeColor: {
media: '(prefers-color-scheme: dark)',
color: 'cyan',
},
},
]
const viewport1 = await accumulateViewport(viewportInput1)
expect(viewport1).toMatchObject({
themeColor: [{ media: '(prefers-color-scheme: dark)', color: 'cyan' }],
})
const viewportInput2: Viewport[] = [
{
themeColor: [
{ media: '(prefers-color-scheme: light)', color: '#fff' },
{ media: '(prefers-color-scheme: dark)', color: 'cyan' },
],
},
]
const viewport2 = await accumulateViewport(viewportInput2)
expect(viewport2).toMatchObject({
themeColor: [
{ media: '(prefers-color-scheme: light)', color: '#fff' },
{ media: '(prefers-color-scheme: dark)', color: 'cyan' },
],
})
})
})
})
...@@ -9,10 +9,8 @@ import type { ...@@ -9,10 +9,8 @@ import type {
FieldResolverExtraArgs, FieldResolverExtraArgs,
MetadataContext, MetadataContext,
} from '../types/resolvers' } from '../types/resolvers'
import type { Viewport } from '../types/extra-types'
import { resolveAsArrayOrUndefined } from '../generate/utils' import { resolveAsArrayOrUndefined } from '../generate/utils'
import { resolveAbsoluteUrlWithPathname } from './resolve-url' import { resolveAbsoluteUrlWithPathname } from './resolve-url'
import { ViewPortKeys } from '../constants'
function resolveAlternateUrl( function resolveAlternateUrl(
url: string | URL, url: string | URL,
...@@ -44,26 +42,6 @@ export const resolveThemeColor: FieldResolver<'themeColor'> = (themeColor) => { ...@@ -44,26 +42,6 @@ export const resolveThemeColor: FieldResolver<'themeColor'> = (themeColor) => {
return themeColorDescriptors return themeColorDescriptors
} }
export const resolveViewport: FieldResolver<'viewport'> = (viewport) => {
let resolved: ResolvedMetadata['viewport'] = null
if (typeof viewport === 'string') {
resolved = viewport
} else if (viewport) {
resolved = ''
for (const viewportKey_ in ViewPortKeys) {
const viewportKey = viewportKey_ as keyof Viewport
if (viewportKey in viewport) {
let value = viewport[viewportKey]
if (typeof value === 'boolean') value = value ? 'yes' : 'no'
if (resolved) resolved += ', '
resolved += `${ViewPortKeys[viewportKey]}=${value}`
}
}
}
return resolved
}
function resolveUrlValuesOfObject( function resolveUrlValuesOfObject(
obj: obj:
| Record< | Record<
......
...@@ -53,7 +53,7 @@ export type ItunesApp = { ...@@ -53,7 +53,7 @@ export type ItunesApp = {
// Viewport meta structure // Viewport meta structure
// https://developer.mozilla.org/docs/Web/HTML/Viewport_meta_tag // https://developer.mozilla.org/docs/Web/HTML/Viewport_meta_tag
// intentionally leaving out user-scalable, use a string if you want that behavior // intentionally leaving out user-scalable, use a string if you want that behavior
export type Viewport = { export type ViewportLayout = {
width?: string | number width?: string | number
height?: string | number height?: string | number
initialScale?: number initialScale?: number
......
...@@ -9,7 +9,7 @@ import type { ...@@ -9,7 +9,7 @@ import type {
ItunesApp, ItunesApp,
ResolvedAppleWebApp, ResolvedAppleWebApp,
ResolvedAppLinks, ResolvedAppLinks,
Viewport, ViewportLayout,
} from './extra-types' } from './extra-types'
import type { import type {
DeprecatedMetadataFields, DeprecatedMetadataFields,
...@@ -130,6 +130,8 @@ interface Metadata extends DeprecatedMetadataFields { ...@@ -130,6 +130,8 @@ interface Metadata extends DeprecatedMetadataFields {
/** /**
* The theme color for the document. * The theme color for the document.
* @example * @example
* @deprecated
*
* ```tsx * ```tsx
* "#000000" * "#000000"
* <meta name="theme-color" content="#000000" /> * <meta name="theme-color" content="#000000" />
...@@ -150,6 +152,8 @@ interface Metadata extends DeprecatedMetadataFields { ...@@ -150,6 +152,8 @@ interface Metadata extends DeprecatedMetadataFields {
/** /**
* The color scheme for the document. * The color scheme for the document.
* @example * @example
* @deprecated
*
* ```tsx * ```tsx
* "dark" * "dark"
* <meta name="color-scheme" content="dark" /> * <meta name="color-scheme" content="dark" />
...@@ -160,15 +164,15 @@ interface Metadata extends DeprecatedMetadataFields { ...@@ -160,15 +164,15 @@ interface Metadata extends DeprecatedMetadataFields {
/** /**
* The viewport setting for the document. * The viewport setting for the document.
* @example * @example
* @deprecated
*
* ```tsx * ```tsx
* "width=device-width, initial-scale=1"
* <meta name="viewport" content="width=device-width, initial-scale=1" />
* *
* { width: "device-width", initialScale: 1 } * { width: "device-width", initialScale: 1 }
* <meta name="viewport" content="width=device-width, initial-scale=1" /> * <meta name="viewport" content="width=device-width, initial-scale=1" />
* ``` * ```
*/ */
viewport?: null | string | Viewport viewport?: null | string | ViewportLayout
/** /**
* The creator of the document. * The creator of the document.
...@@ -472,8 +476,17 @@ interface ResolvedMetadata extends DeprecatedMetadataFields { ...@@ -472,8 +476,17 @@ 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
/**
* @deprecated
*/
themeColor: null | ThemeColorDescriptor[] themeColor: null | ThemeColorDescriptor[]
/**
* @deprecated
*/
colorScheme: null | ColorSchemeEnum colorScheme: null | ColorSchemeEnum
/**
* @deprecated
*/
viewport: null | string viewport: null | string
creator: null | string creator: null | string
publisher: null | string publisher: null | string
...@@ -577,4 +590,53 @@ declare namespace MetadataRoute { ...@@ -577,4 +590,53 @@ declare namespace MetadataRoute {
export type Manifest = ManifestFile export type Manifest = ManifestFile
} }
export type { Metadata, ResolvedMetadata, ResolvingMetadata, MetadataRoute } interface Viewport extends ViewportLayout {
/**
* The theme color for the document.
* @example
*
* ```tsx
* "#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 | ThemeColorDescriptor | ThemeColorDescriptor[]
/**
* The color scheme for the document.
* @example
*
* ```tsx
* "dark"
* <meta name="color-scheme" content="dark" />
* ```
*/
colorScheme?: null | ColorSchemeEnum
}
type ResolvingViewport = Promise<Viewport>
interface ResolvedViewport extends ViewportLayout {
themeColor: null | ThemeColorDescriptor[]
colorScheme: null | ColorSchemeEnum
}
export type {
Metadata,
ResolvedMetadata,
ResolvingMetadata,
MetadataRoute,
Viewport,
ResolvingViewport,
ResolvedViewport,
}
import type { Metadata, ResolvedMetadata } from './metadata-interface' import type { Metadata, ResolvedMetadata } from './metadata-interface'
export type FieldResolver<Key extends keyof Metadata> = ( export type FieldResolver<
T: Metadata[Key] Key extends keyof Data & keyof ResolvedData,
) => ResolvedMetadata[Key] Data = Metadata,
ResolvedData = ResolvedMetadata
> = (T: Data[Key]) => ResolvedData[Key]
export type FieldResolverExtraArgs< export type FieldResolverExtraArgs<
Key extends keyof Metadata, Key extends keyof Data & keyof ResolvedData,
ExtraArgs extends unknown[] = any[] ExtraArgs extends unknown[] = any[],
> = (T: Metadata[Key], ...args: ExtraArgs) => ResolvedMetadata[Key] Data = Metadata,
ResolvedData = ResolvedMetadata
> = (T: Data[Key], ...args: ExtraArgs) => ResolvedData[Key]
export type MetadataContext = { export type MetadataContext = {
pathname: string pathname: string
......
...@@ -99,6 +99,7 @@ enum AppRouteRouteHandlersSpan { ...@@ -99,6 +99,7 @@ enum AppRouteRouteHandlersSpan {
enum ResolveMetadataSpan { enum ResolveMetadataSpan {
generateMetadata = 'ResolveMetadata.generateMetadata', generateMetadata = 'ResolveMetadata.generateMetadata',
generateViewport = 'ResolveMetadata.generateViewport',
} }
type SpanTypes = type SpanTypes =
...@@ -125,6 +126,7 @@ export const NextVanillaSpanAllowlist = [ ...@@ -125,6 +126,7 @@ export const NextVanillaSpanAllowlist = [
NodeSpan.runHandler, NodeSpan.runHandler,
AppRouteRouteHandlersSpan.runHandler, AppRouteRouteHandlersSpan.runHandler,
ResolveMetadataSpan.generateMetadata, ResolveMetadataSpan.generateMetadata,
ResolveMetadataSpan.generateViewport,
] ]
export { export {
......
...@@ -37,7 +37,11 @@ export type { ...@@ -37,7 +37,11 @@ export type {
Metadata, Metadata,
MetadataRoute, MetadataRoute,
ResolvedMetadata, ResolvedMetadata,
ResolvingMetadata, // @ts-ignore This path is generated at build time and conflicts otherwise ResolvingMetadata,
Viewport,
ResolvingViewport,
ResolvedViewport,
// @ts-ignore This path is generated at build time and conflicts otherwise
} from '../dist/lib/metadata/types/metadata-interface' } from '../dist/lib/metadata/types/metadata-interface'
/** /**
......
...@@ -5,5 +5,5 @@ export default function Page() { ...@@ -5,5 +5,5 @@ export default function Page() {
export const metadata = { export const metadata = {
title: 'My title', title: 'My title',
description: 'My description', description: 'My description',
themeColor: '#eee', applicationName: 'suspense-app',
} }
...@@ -10,7 +10,9 @@ createNextDescribe( ...@@ -10,7 +10,9 @@ createNextDescribe(
it('should render metadata in head even root layout is wrapped with Suspense', async () => { it('should render metadata in head even root layout is wrapped with Suspense', async () => {
const $ = await next.render$('/') const $ = await next.render$('/')
expect($('head title').text()).toBe('My title') expect($('head title').text()).toBe('My title')
expect($('head meta[name="theme-color"]').attr('content')).toBe('#eee') expect($('head meta[name="application-name"]').attr('content')).toBe(
'suspense-app'
)
expect($('body meta').length).toBe(0) expect($('body meta').length).toBe(0)
}) })
......
export function GET() { export function GET() {
return new Response('{ "name": "metadata-app", }', { return new Response('{ "name": "metadata-app" }', {
headers: { headers: {
'Content-Type': 'application/xml; charset=utf-8', 'Content-Type': 'application/json; charset=utf-8',
}, },
}) })
} }
...@@ -25,17 +25,7 @@ export const metadata: Metadata = { ...@@ -25,17 +25,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: { color: 'cyan', media: '(prefers-color-scheme: dark)' },
colorScheme: 'dark',
manifest: '/api/manifest', manifest: '/api/manifest',
viewport: {
width: 'device-width',
initialScale: 1,
maximumScale: 1,
interactiveWidget: 'resizes-visual',
},
creator: 'shu',
publisher: 'vercel',
robots: 'index, follow', robots: 'index, follow',
alternates: {}, alternates: {},
formatDetection: { formatDetection: {
......
import React from 'react'
import type { Metadata } from 'next' import type { Metadata } from 'next'
import Link from 'next/link' import Link from 'next/link'
import Client from './client' import Client from './client'
...@@ -23,15 +24,7 @@ export const metadata: Metadata = { ...@@ -23,15 +24,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: { color: 'cyan', media: '(prefers-color-scheme: dark)' },
colorScheme: 'dark',
manifest: '/api/manifest', manifest: '/api/manifest',
viewport: {
width: 'device-width',
initialScale: 1,
maximumScale: 1,
interactiveWidget: 'resizes-visual',
},
creator: 'shu', creator: 'shu',
publisher: 'vercel', publisher: 'vercel',
robots: 'index, follow', robots: 'index, follow',
...@@ -42,3 +35,14 @@ export const metadata: Metadata = { ...@@ -42,3 +35,14 @@ export const metadata: Metadata = {
telephone: false, telephone: false,
}, },
} }
export const viewport = {
// viewport meta tag
width: 'device-width',
initialScale: 1,
maximumScale: 1,
interactiveWidget: 'resizes-visual',
// visual meta tags
colorScheme: 'dark',
themeColor: { color: 'cyan', media: '(prefers-color-scheme: dark)' },
}
export default function Page() {
return 'page'
}
export function generateViewport() {
return {
themeColor: '#000',
}
}
...@@ -236,7 +236,6 @@ createNextDescribe( ...@@ -236,7 +236,6 @@ createNextDescribe(
it('should support other basic tags (edge)', async () => { it('should support other basic tags (edge)', async () => {
const browser = await next.browser('/basic-edge') const browser = await next.browser('/basic-edge')
const matchDom = createDomMatcher(browser)
const matchMultiDom = createMultiDomMatcher(browser) const matchMultiDom = createMultiDomMatcher(browser)
await matchMultiDom('meta', 'name', 'content', { await matchMultiDom('meta', 'name', 'content', {
...@@ -245,11 +244,6 @@ createNextDescribe( ...@@ -245,11 +244,6 @@ createNextDescribe(
referrer: 'origin-when-cross-origin', referrer: 'origin-when-cross-origin',
keywords: 'next.js,react,javascript', keywords: 'next.js,react,javascript',
author: ['huozhi', 'tree'], author: ['huozhi', 'tree'],
'color-scheme': 'dark',
viewport:
'width=device-width, initial-scale=1, maximum-scale=1, interactive-widget=resizes-visual',
creator: 'shu',
publisher: 'vercel',
robots: 'index, follow', robots: 'index, follow',
'format-detection': 'telephone=no, address=no, email=no', 'format-detection': 'telephone=no, address=no, email=no',
}) })
...@@ -261,11 +255,6 @@ createNextDescribe( ...@@ -261,11 +255,6 @@ createNextDescribe(
preload: '/api/preload', preload: '/api/preload',
'dns-prefetch': '/dns-prefetch-url', 'dns-prefetch': '/dns-prefetch-url',
}) })
await matchDom('meta', 'name="theme-color"', {
media: '(prefers-color-scheme: dark)',
content: 'cyan',
})
}) })
it('should support apple related tags `itunes` and `appWebApp`', async () => { it('should support apple related tags `itunes` and `appWebApp`', async () => {
...@@ -943,6 +932,16 @@ createNextDescribe( ...@@ -943,6 +932,16 @@ createNextDescribe(
}) })
} }
describe('viewport', () => {
it('should support dynamic viewport export', async () => {
const browser = await next.browser('/viewport')
const matchMultiDom = createMultiDomMatcher(browser)
await matchMultiDom('meta', 'name', 'content', {
'theme-color': '#000',
})
})
})
describe('react cache', () => { describe('react cache', () => {
it('should have same title and page value on initial load', async () => { it('should have same title and page value on initial load', async () => {
const browser = await next.browser('/cache-deduping') const browser = await next.browser('/cache-deduping')
......
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