Type Alias: HeadlessAppProps

HeadlessAppProps = object

Defined in: packages/next/src/components/HeadlessApp.tsx:18

The props supported by HeadlessApp.

Properties

children?

optional children: ReactNode

Defined in: packages/next/src/components/HeadlessApp.tsx:58

---

handleYoast?

optional handleYoast: boolean

Defined in: packages/next/src/components/HeadlessApp.tsx:56

If true, will automatically load yoast seo metadata into the head

Default

true

---

pageProps

pageProps: any

Defined in: packages/next/src/components/HeadlessApp.tsx:41

The page props from next.js. It should contain fallback, themeJson and other props.

Those props are added when using fetchHookData and addHookData

See

• fetchHookData
• addHookData

---

settings

settings: SettingsContextProps

Defined in: packages/next/src/components/HeadlessApp.tsx:24

Supported settings by the framework. Such as custom image component, custom link component etc.

See

SettingsContextProps

---

swrConfig

swrConfig: DataFetchingProviderProps["swrConfig"]

Defined in: packages/next/src/components/HeadlessApp.tsx:31

Pass any configuration to the SWR library. Globally.

These settings can be overridden at the hook level.

---

useYoastHtml?

optional useYoastHtml: boolean

Defined in: packages/next/src/components/HeadlessApp.tsx:49

If true, will make the Yoast component use the yoast_head raw html to populate meta tags instead of yoast_head_json.

yoast_head is the default and preferable option.